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

[Doc] Enhance the document's structure #132

Closed
sun7927 opened this issue Aug 8, 2022 · 1 comment · Fixed by #149 or #172
Closed

[Doc] Enhance the document's structure #132

sun7927 opened this issue Aug 8, 2022 · 1 comment · Fixed by #149 or #172
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@sun7927
Copy link
Member

sun7927 commented Aug 8, 2022

Suggested the new structure of document as below:

  1. What's the HwameiStor
  2. Quick Start
    2.1 Installations
    2.2 Start a Stateful Application
    2.2.1 Basic Operations
    2.2.2 Advanced Operations
    2.3 Advanced Features
    2.3.1 Node Expansion
    2.3.2 Disk Expansion
    2.3.3 Upgrade
    2.4 Uninstall
  3. Architecture of HwameiStor
    3.1 Overview
    3.2 Components
    3.3 Resources
    3.4 APIs
  4. Development Designs (Optional)
  5. Applications
    5.1 TiDB
    5.2 MinIO
    ...
  6. Terminologies
  7. Community
  8. FAQs
@sun7927 sun7927 added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 8, 2022
@alexzhc
Copy link
Collaborator

alexzhc commented Aug 8, 2022

working on a doc pr.

@alexzhc alexzhc linked a pull request Aug 10, 2022 that will close this issue
@alexzhc alexzhc linked a pull request Aug 11, 2022 that will close this issue
sun7927 pushed a commit to sun7927/operator-hwameistor that referenced this issue Aug 11, 2022
@alexzhc alexzhc linked a pull request Aug 12, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
3 participants