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

[#5109] fix(doc): fix link to documentation website in README #5149

Merged

Conversation

SeanAverS
Copy link
Contributor

What changes were proposed in this pull request?

  • Link to documentation website

Why are the changes needed?

  • Link to documentation website instead of documentation directory for easier access

Fix: #5109

Does this PR introduce any user-facing change?

  • No user-facing changes

How was this patch tested?

  • Link to website shows in README upon updating text

Copy link
Contributor

@JunpingDu JunpingDu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should use “https://gravitino.apache.org/docs/{version}” instead, as gravitino project is apache project now and apache website is the official document site.
For version, I would suggest to use "latest" which will link to the latest version (now is 0.6.0-incubating) automatically. Otherwise, it need to be updated once we have new version.
Beside doc folder here, we have several other links in README.md, such as how to build, how to test, .... Can you help to update them together?

@SeanAverS
Copy link
Contributor Author

@JunpingDu please let me know if I missed anything

@jerryshao jerryshao changed the title [IMPROVEMENT] fix: link to documentation website in README [#5109]fix(doc): fix link to documentation website in README Oct 22, 2024
@jerryshao jerryshao changed the title [#5109]fix(doc): fix link to documentation website in README [#5109] fix(doc): fix link to documentation website in README Oct 22, 2024
Copy link
Contributor

@jerryshao jerryshao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @SeanAverS for your contribution.

@jerryshao jerryshao merged commit 3f2456e into apache:main Oct 22, 2024
21 checks passed
mplmoknijb pushed a commit to mplmoknijb/gravitino that referenced this pull request Nov 6, 2024
…pache#5149)

### What changes were proposed in this pull request?

- Link to documentation website 

### Why are the changes needed?

- Link to documentation website instead of documentation directory for
easier access

Fix: apache#5109 

### Does this PR introduce _any_ user-facing change?

- No user-facing changes 

### How was this patch tested?

- Link to website shows in README upon updating text

---------

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Improvement] README.md should refer the link to our doc website but not doc's source directory
3 participants