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

docs: fix broken links and add CI for checking document build status #1131

Merged
merged 2 commits into from
Sep 13, 2024

Conversation

ChenYi015
Copy link
Collaborator

What this PR does / why we need it:

  • Fix broken links in tensorflow/triton serving documentation
  • Add CI for checking whether docs can be built correctly without errors and warnings

Rational:

There is some broken doc links when building arena documentation:

$ mkdocs build --strict
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /Users/chenyi/code/github.com/kubeflow/arena/site
...
WARNING -  Doc file 'serving/tfserving/update-serving.md' contains a link 'tfserving/gpu.md', but the target 'serving/tfserving/tfserving/gpu.md' is not found among documentation files.
WARNING -  Doc file 'serving/triton/update-serving.md' contains a link 'triton/serving.md', but the target 'serving/triton/triton/serving.md' is not found among documentation files.

Aborted with 2 warnings in strict mode!

Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
@ChenYi015
Copy link
Collaborator Author

/assign @Syulin7 @cheyang

Copy link
Collaborator

@cheyang cheyang left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@google-oss-prow google-oss-prow bot added the lgtm label Sep 13, 2024
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cheyang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit bf53ba3 into kubeflow:master Sep 13, 2024
5 checks passed
@ChenYi015 ChenYi015 deleted the docs/broken-link branch September 13, 2024 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants