documentation
documentation copied to clipboard
[docs.sodafoundation.io] - LEFT PANEL MENU Improvement
Issue/Feature Description: Review and improvement of the Left Side Main Menu Items for docs.sodafoundation.io
ALL DETAILS HERE:
-
[ ] Introduction (New) -- Give intro about SODA Foundation (also can link to website)
-
[x] Getting Started (Remove)
-
[x] Try SODA Foundation (Rename to Getting Started)
- Quick Start Guide ---> Update to setup from binaries from release. Point to the release or binary method.
- Installation Guide --> Detailed installation Configuration and Development
-
[x] Projects (New) ---> Introduction to each code project along with project features
-
[x] SODA Foundation project Features --> Remove
-
[x] SODA Architecture --> Move before projects
-
[x] SODA API Specifications (New) : Add all the key API specification docs here.
-
[x] API Spec and Guides --> Rename to Docs & Guides
- [x] - API Spec (Remove this section)
- Elba Release (v0.20.1)
- Daito Release (v0.10.1)
- Capri Release (v0.6.1)
- Aruba Release (v0.2.0)
- Bali Release (v0.4.0)
- Zealand Release (v0.1.0)
- [x] - Installer Guides (Give all methods supported)
- Using Ansible
- [x] - Integration Guides
- With Kubernetes CSI
- [x] - User Guides (give intro to respective project and then user guide)
- File Share feature User Guide
- Orchestration User Guide
- Telemetry with LVM User Guide
- Object Lifecycle Management
- [x] - Developer Guides (update intro)
- File Share
- Orchestration and Automation
- Object Lifecycle Management
- [x] - API Spec (Remove this section)
-
[x] Releases and Roadmaps
-
[x] - SODA Foundation Release Roadmap (Remove the subsections and give one doc with sections for releases?)
- Elba
- Daito
- Capri
- Bali
- Aruba
- Zealand
-
[x] - Component Projects (Remove)
- Northbound Plugin Project
-
[x] - Governance (Give an intro and link to website; remove sub sections and duplicate info)
- Technical Steering Commitee
- End User Advisory Committee
-
[x] - Community (Remove these subsections; add about overall community information about SODA Foundation)
- Join and Contribute
- How to Contribute
- Contribute to the SODA Foundation Blog
-
[x] - How to Join? (New) - Move before Community
-
[x] - How to Contribute (New) Move before community
-
[x] - Links & Contacts (New) -- give github, twitter etc channels and links; contact information also added
-
[x] - MORE ( this section and subsections to be removed)
-
[x] - Download, star, fork etc --- can be removed?
Why this issue to fixed / feature is needed(give scenarios or use cases): Documentaiton improvement
How to reproduce, in case of a bug: NA
Other Notes / Environment Information: (Please give the env information, log link or any useful information for this issue) NA
#70 #71 #72 Created to track the L1/L2 Doc content updates for Integration, user guides and developer guides.
#73 added for release section improvement
@kumarashit @joseph-v I have completed the panel and the first level update for complete documentation. Please do a review.
Some remaining level 1 or level 2 issues, I have raised separately and will fix soon.