-
Notifications
You must be signed in to change notification settings - Fork 220
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
Updated Structure of Docs #309
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid making folder name changes. for example delfin
to Delfin
. We use lower case letters for folder names.
Avoid using spaces in the folder names. for example Support Matrix
. Use lower case letters and hyphen -
to have multi-word folder names.
Please avoid using folder names such as User Guide
. Use user-guide
instead.
The API Spec for each folder can be added under each project, release wise.
For ex:
- Strato
- User guides
- API Spec
- Navarino (v1.8.0)
- Madagascar (v1.7.0)
- Delfin
- User guides
- API Spec
- Navarino (v1.8.0)
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
I did the major structural changes, we can merge these changes and then can work on the Content part and also the Realeses folder/content can be added and modified then only. |
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- NBP should be under SODA Framework Projects
- SODA CDM should go under SODA Framework projects
- The sub sections order in each project can be consistent. If you keep Developer Guide as the first one, then keep it as the first item in all the projects.
- support matrix under Strato can be changed to Support Matrix
- The separate Support Matrix in the level 1 menu available currently can be removed after moving the NBP to SODA Framework projects
@wasup-yash
Thanks a lot for a good work in revamping the documentation for the release.
@wasup-yash added some comments, please fix, thanks |
Signed-off-by: wasup-yash <trooper0018080@gmail.com>
Signed-off-by: yash sharma <trooper0018080@gmail.com>
Signed-off-by: yash sharma <trooper0018080@gmail.com>
updating branch
What type of PR is this?
/kind documentation
What this PR does / why we need it:
We need this PR because the previous 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 So I restructure the whole Documentation which helps the New Users to easily Navigate through the documentation and find the Respective Projects in their category.
I followed the same categorization as SODA CDM (initial stage categorization) and organize the documentation as per the following categorization
SODA Framework Projects
Strato
Delfin
Terra
Dashboard
SODA CDM
SODA Lake (not added currently)
Which issue(s) this PR fixes:
Fixes #308
Test Report Added?:
/kind TESTED
Test Report:
Tested Locally
Special notes for your reviewer: I have Left some Modules/folders Blank as in For Soda Lake/Como and Framework Project/terra so the new changes can be applied to the respective folders as per the regulations.