Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the SODA Documentation by reorganising the overall document structure #308

Open
anvithks opened this issue Jun 13, 2023 · 1 comment · May be fixed by #309 or RustCohle007/Project#1
Open
Assignees
Labels
enhancement New feature or request

Comments

@anvithks
Copy link
Member

anvithks commented Jun 13, 2023

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.

image

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.

image

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.

@anvithks anvithks added the enhancement New feature or request label Jun 13, 2023
@wasup-yash
Copy link

I would like to work on this issue.

@wasup-yash wasup-yash linked a pull request Jun 25, 2023 that will close this issue
@deyonpeter deyonpeter linked a pull request May 27, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants