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

[docs.sodafoundation.io] - LEFT PANEL MENU Improvement #67

Open
22 of 23 tasks
skdwriting opened this issue Jun 15, 2020 · 3 comments
Open
22 of 23 tasks

[docs.sodafoundation.io] - LEFT PANEL MENU Improvement #67

skdwriting opened this issue Jun 15, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@skdwriting
Copy link
Collaborator

skdwriting commented Jun 15, 2020

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)

  • Getting Started (Remove)

  • 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
  • Projects (New) ---> Introduction to each code project along with project features

  • SODA Foundation project Features --> Remove

  • SODA Architecture --> Move before projects

  • SODA API Specifications (New) : Add all the key API specification docs here.

  • API Spec and Guides --> Rename to Docs & Guides

    • - 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)
    • - Installer Guides (Give all methods supported)
      • Using Ansible
    • - Integration Guides
      • With Kubernetes CSI
    • - 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
    • - Developer Guides (update intro)
      • File Share
      • Orchestration and Automation
      • Object Lifecycle Management
  • Releases and Roadmaps

  • - SODA Foundation Release Roadmap (Remove the subsections and give one doc with sections for releases?)

    • Elba
    • Daito
    • Capri
    • Bali
    • Aruba
    • Zealand
  • - Component Projects (Remove)

    • Northbound Plugin Project
  • - Governance (Give an intro and link to website; remove sub sections and duplicate info)

    • Technical Steering Commitee
    • End User Advisory Committee
  • - Community (Remove these subsections; add about overall community information about SODA Foundation)

    • Join and Contribute
    • How to Contribute
    • Contribute to the SODA Foundation Blog
  • - How to Join? (New) - Move before Community

  • - How to Contribute (New) Move before community

  • - Links & Contacts (New) -- give github, twitter etc channels and links; contact information also added

  • - MORE ( this section and subsections to be removed)

  • - 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

@skdwriting skdwriting added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 15, 2020
@skdwriting skdwriting added this to the Jun2020 milestone Jun 15, 2020
@skdwriting skdwriting self-assigned this Jun 19, 2020
@skdwriting
Copy link
Collaborator Author

#70 #71 #72 Created to track the L1/L2 Doc content updates for Integration, user guides and developer guides.

@skdwriting
Copy link
Collaborator Author

#73 added for release section improvement

@skdwriting
Copy link
Collaborator Author

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant