Build documentation process by documenting DMS
Description
Click to expand
Who
- assignee: @0xPravar
- support: @kabir.kbr
- related: @janaina.senna @sam.lake
What
- As discussed in the during Documentation Process technical discussion (recording: https://us02web.zoom.us/rec/share/9_IF0Qh8DDsYKinQ7vh7h0kRDuearNPzwjYLbskrXuH_18kP7aW6DAwEH0MMZwV4.OsdXJCI3iasWHYHi), we need to specify documentation process better so that developers could update documentation together with writing code;
- It appears that the way to move the documentation project now is to prepare the documentation system and the documentation examples on one of the exsting / living repositories and AFTER that properly communicate and include update of documentation to issue acceptance criteria;
How
- Given uncertainties or documentation requirements, we concentrate on technical documentation only;
- We start with device-management-service component and repository; Since it is the biggest and most important component of the platform, by documenting it, and producing procesedures on the way, we most probably will cover all cases;
- The goal is to build processes with connects specifications with data model with testing and community documentation;
Why
- Technical documentation is considered specification of the platform and is an core integral part of the platform itself;
- It is a core aspect of what we are doing, considering our goal to reach the level when community developers would shape the development of the platform;
When
- Related issue: test-suite#60 (closed)
- Related issue: nunet/open-api/platform-data-model#6 (closed)
- Related issue: #23 (comment 1555488965)
Acceptance Criteria
Click to expand
Work Breakdown Structure (WBS)
Task | Description | Duration | Status | Start Date | End Date | Comment |
---|---|---|---|---|---|---|
A | Update the Gherkin file developed under test-suite#60 (closed) to match current state of code on develop branch | 4 Hrs | Done | 01-Dec | 01-Dec | |
B | Update the mermaid files for platform data model developed under nunet/open-api/platform-data-model#6 (closed) to match current state of code on develop branch | 4 Hrs | Done | 04-Dec | 05-Dec | |
C | Populate README-DEV file for compute provider onboarding | 1 Day | Done | 30-Nov | 06-Dec | Reference repo |
Edited by Pravar Joshi