sodafoundation / documentation

Documentation for SODA Foundation and SODA Core projects. Covers code for doc site generation.
https://docs.sodafoundation.io/
MIT License
46 stars 220 forks source link

Updated Structure of Docs #309

Open wasup-yash opened 1 year ago

wasup-yash commented 1 year ago

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

SODA CDM

SODA Lake (not added currently)

Which issue(s) this PR fixes:

Fixes #308

Test Report Added?: /kind TESTED

Test Report:

Tested Locally tested

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.

wasup-yash commented 1 year ago

@anvithks

wasup-yash commented 1 year ago

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.

skdwriting commented 1 year ago

@wasup-yash added some comments, please fix, thanks