[Improvement] README.md should refer the link to our doc website but not doc's source directory #5109
Assignees
Labels
0.7.0
Release v0.7.0
good first issue
Good for newcomers
help wanted
Extra attention is needed
improvement
Improvements on everything
Comments
jerryshao
added
good first issue
|
Hi, I'm interested on working on this. Could I please be assigned? Thanks. |
Sure,please go ahead. |
|
@SeanAverS welcome to your contributions, I just assign the issue to you, please go ahead to work on it! |
|
Thanks for the patch, @SeanAverS ! I have some review comments in your PR, would you take a look? thx! |
jerryshao
added a commit
that referenced
this issue
Oct 22, 2024
### 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 --------- Co-authored-by: Jerry Shao <[email protected]>
|
Thanks for your contribution, @SeanAverS . |
mplmoknijb
pushed a commit
to mplmoknijb/gravitino
that referenced
this issue
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
What would you like to be improved?
README.md is the front page for an open source project, and most users try to locate the related documents they need.
Usually it should link to a document website (if project has), such as spark, ray, etc. which is more convenient for users to read - comparing with our source doc in markdown format.
How should we improve?
Replace the link that point to doc source with link to doc site (latest version).
The text was updated successfully, but these errors were encountered: