-
Notifications
You must be signed in to change notification settings - Fork 415
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
[#6600] Docs: restructure the getting started docs #6596
Conversation
/assign @jerryshao |
41f3a44
to
af91394
Compare
Thanks @tengqm for the work, I will review this PR soon. |
@tengqm We use Github issue to track the works, so before submitting a PR, we should create a corresponding issue to describe what we should do, follow our PR title and description template to link to that issue, can you please do that? |
Good to know. Revised PR description, pointing to a newly filed EPIC issue. |
af91394
to
19390e6
Compare
docs/index.md
Outdated
|
||
* [Getting started locally](./getting-started.md#getting-started-locally): a quick guide to starting | ||
* [Getting started locally](./getting-started/#local): a quick guide to starting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please keep the .md
suffix, so the link can be worked in Github preview.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, will check it.
|
||
There are several options for getting started with Apache Gravitino. | ||
|
||
<!--Docker option--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it work for the markdown syntax?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. It works. It is the official way of adding comments to Markdown.
19390e6
to
ab36692
Compare
ab36692
to
221125f
Compare
Related: #6600
This PR restructures the getting-started tutorial. Changes include: