documentation
documentation copied to clipboard
sodafoundation
Update the SODA Documentation by reorganising the overall document structure
Issue/Feature Description: The current SODA Documentation was created when the SODA Foundation consisted only one GitHub organization and few projects. The documentation was organized as per document category and not project wise.
With the addition of SODA CDM and SODA Lake GitHUb organizations and additional projects this structure makes it difficult for the user to find documentation for one project. The user will have to check multiple categories to find the necessary docs related to one project.
The SODA CDM documentation has been added with this in mind. The structure is such that users will be able to find all related documentation under the project name itself.
We follow the same categorization as SODA CDM and organize the documentation as per the following categorization
- SODA Framework Projects
- Strato
- Delfin
- Terra
- Dashboard
- SODA CDM
- Kahu
- SODA Lake
- Como
Each of the projects will have sections for:
- User Guides
- Developer Guides
- Deployment / Installation Guides
- API Spec
- Requirement Specifications / Design Guides
- Support Matrix, Architecture
We add common documentation outside of the projects list.
Why this issue to fixed / feature is needed(give scenarios or use cases): This will make navigating the documentation easier for the users. This will also allow users to find relevant information easily.
How to reproduce, in case of a bug:
Other Notes / Environment Information: (Please give the env information, log link or any useful information for this issue) The SODA Multicloud project has been renamed to Strato. The SODA API, Dock and Controller projects together are renamed to SODA Terra.
