documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Updated Structure of Docs

Open wasup-yash opened this issue 1 year ago • 3 comments

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

  • Kahu

SODA Lake (not added currently)

  • Como

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 avatar Jun 25 '23 14:06 wasup-yash

@anvithks

wasup-yash avatar Jun 25 '23 14:06 wasup-yash

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.

wasup-yash avatar Jun 30 '23 05:06 wasup-yash

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

skdwriting avatar Jul 11 '23 16:07 skdwriting