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

[#6335] fix(python-client): Fix pypi document link error #6342

Merged
merged 3 commits into from
Jan 22, 2025

Conversation

FANNG1
Copy link
Contributor

@FANNG1 FANNG1 commented Jan 21, 2025

What changes were proposed in this pull request?

Correct the Gravitino document link from https://datastrato.ai/docs/latest to https://gravitino.apache.org/docs/latest, suppose the publish version is 0.8.0-incubating, the link will start with https://gravitino.apache.org/docs/latest

Why are the changes needed?

Fix: #6335

Does this PR introduce any user-facing change?

no

How was this patch tested?

run ./gradlew :clients:client-python:distribution -x test and check README

@FANNG1 FANNG1 self-assigned this Jan 21, 2025
@FANNG1 FANNG1 added the branch-0.8 Automatically cherry-pick commit to branch-0.8 label Jan 21, 2025
@FANNG1
Copy link
Contributor Author

FANNG1 commented Jan 21, 2025

@jerryshao @xunliu PTAL

@@ -122,7 +124,7 @@ fun generatePypiProjectHomePage() {
// relative path of the images in the how-to-use-python-client.md file is incorrect. We need
// to fix the relative path of the images/markdown to the absolute path.
val content = outputFile.readText()
val docsUrl = "https://datastrato.ai/docs/latest"
val docsUrl = "https://gravitino.apache.org/docs/$gravitinoVersion"
Copy link
Member

Choose a reason for hiding this comment

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

Please change to

val docsUrl = "https://gravitino.apache.org/docs/latest"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If using latest, all release pypi document will link to the latest Gravitino document page, is it expected?

Copy link
Member

@xunliu xunliu left a comment

Choose a reason for hiding this comment

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

LGTM

@FANNG1 FANNG1 merged commit 68e31e2 into apache:main Jan 22, 2025
25 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 22, 2025
### What changes were proposed in this pull request?

Correct the Gravitino document link from
`https://datastrato.ai/docs/latest` to
`https://gravitino.apache.org/docs/$gravitinoVersion`, suppose the
publish version is `0.8.0-incubating`, the link will start with
`https://gravitino.apache.org/docs/0.8.0-incubating`

### Why are the changes needed?

Fix: #6335 

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

### How was this patch tested?

run `./gradlew :clients:client-python:distribution -x test` and check
`README`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch-0.8 Automatically cherry-pick commit to branch-0.8
Projects
None yet
2 participants