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

fix(docs): Fix various broken links in docs #5047

Merged
merged 8 commits into from
Jul 21, 2023

Conversation

agrski
Copy link
Contributor

@agrski agrski commented Jul 20, 2023

What this PR does / why we need it:
This PR fixes issues in the Core v2 docs from the models page to Rclone details regarding Docker and Kubernetes.

Which issue(s) this PR fixes:
Fixes #5045

Special notes for your reviewer:
The use of myst_heading_anchors fixes a number of other broken links due to the default for this being 2.

See these warnings from a local build:

docs/source/contents/metrics/usage.md:16: WARNING: 'myst' cross-reference target not found: 'extra-publish-urls' [myst.xref_missing]
docs/source/contents/metrics/usage.md:27: WARNING: 'myst' cross-reference target not found: 'metrics-levels' [myst.xref_missing]
docs/source/contents/metrics/usage.md:29: WARNING: 'myst' cross-reference target not found: 'list-of-metrics' [myst.xref_missing]
docs/source/contents/metrics/usage.md:78: WARNING: 'myst' cross-reference target not found: 'setting-options' [myst.xref_missing]

The usage metrics page has ### Extra publish URLs, i.e. an H3, which is not found with the H2 default.

@agrski agrski self-assigned this Jul 20, 2023
@agrski agrski added the v2 label Jul 20, 2023
@agrski
Copy link
Contributor Author

agrski commented Jul 20, 2023

@cliveseldon I think there are a couple of links which aren't just broken, but rather the content has fundamentally changed.

For example, see the link right at the end of this section for pipeline triggers.

This errors example is also only referenced, but seemingly never used:

$ rg 'error\.yaml' docs/source/
docs/source/contents/pipelines/index.md
190:```{literalinclude} ../../../../samples/pipelines/error.yaml

@agrski
Copy link
Contributor Author

agrski commented Jul 20, 2023

Linting issues seem to be wholly unrelated to this PR. Any way we can ignore @cliveseldon?

These seem to have only cropped up within the last few hours, maybe? Builds from 2 days ago didn't have this, but one from earlier today does.

For me locally, with Go 1.19.6 and golangci-lint 1.51.2, running make -C scheduler lint does not return any errors, just the warnings about deprecated linters.

@agrski agrski marked this pull request as ready for review July 20, 2023 20:58
@agrski agrski changed the title fix(docs): Fix links in model docs for Rclone fix(docs): Fix various broken links in docs Jul 20, 2023
@agrski agrski merged commit f28ec5f into SeldonIO:v2 Jul 21, 2023
3 of 4 checks passed
@agrski agrski deleted the issue-5045-fix-rclone-links-in-docs branch July 21, 2023 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants