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.

Sign up for GitHub

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

Jump to bottom

[EPIC] Improvement to docs #6600

Open
1 of 2 tasks
tengqm opened this issue Mar 4, 2025 · 0 comments
Open
1 of 2 tasks

[EPIC] Improvement to docs #6600

tengqm opened this issue Mar 4, 2025 · 0 comments
Assignees
@tengqm
Labels
epic Key feature

Comments

@tengqm
Copy link
Contributor

tengqm commented Mar 4, 2025 •
edited
Loading

Describe the proposal

The current docs for Gravitino has a lot of repeated and redundant materials. Navigating through the docs is not a pleasant experience, especially for new users. We need to restructure the docs for clarity, conciseness and readability.

Task list

The list of tasks will be dynamically changed on demand.

  • Improve the glossary documentation
  • Restructure the getting started tutorial
@tengqm tengqm added the epic Key feature label Mar 4, 2025
@tengqm tengqm mentioned this issue Mar 4, 2025
Merged
jerryshao added a commit that referenced this issue Mar 6, 2025
@tengqm @jerryshao
[#6600] Docs: restructure the getting started docs (#6596)
548ec8d 
Related: #6600 

This PR restructures the getting-started tutorial. Changes include:

- push the getting started tutorial into a separate directory;
- remove duplicated instructions on install and configuration;
- rework the flow of information for clarity and conciseness.

Co-authored-by: Jerry Shao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tengqm tengqm

Labels
epic Key feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tengqm