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

[#6600] Docs: restructure the getting started docs #6596

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

tengqm
Copy link
Contributor

@tengqm tengqm commented Mar 4, 2025

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.

@tengqm
Copy link
Contributor Author

tengqm commented Mar 4, 2025

/assign @jerryshao

@tengqm tengqm force-pushed the doc-getting-started branch from 41f3a44 to af91394 Compare March 4, 2025 09:16
@jerryshao
Copy link
Contributor

Thanks @tengqm for the work, I will review this PR soon.

@jerryshao
Copy link
Contributor

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

@tengqm tengqm changed the title Restructure the getting started docs [#6600] Restructure the getting started docs Mar 4, 2025
@tengqm tengqm changed the title [#6600] Restructure the getting started docs [#6600] Docs: restructure the getting started docs Mar 4, 2025
@tengqm
Copy link
Contributor Author

tengqm commented Mar 4, 2025

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

@tengqm tengqm force-pushed the doc-getting-started branch from af91394 to 19390e6 Compare March 4, 2025 23:34
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
Copy link
Contributor

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.

Copy link
Contributor Author

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-->
Copy link
Contributor

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?

Copy link
Contributor Author

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.

@tengqm tengqm force-pushed the doc-getting-started branch from 19390e6 to ab36692 Compare March 5, 2025 12:15
@tengqm tengqm force-pushed the doc-getting-started branch from ab36692 to 221125f Compare March 5, 2025 12:35
@jerryshao jerryshao merged commit 548ec8d into apache:main Mar 6, 2025
25 checks passed
@tengqm tengqm deleted the doc-getting-started branch March 10, 2025 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants