Rewrite all docs/reference destinations to be inline ref URIs #6538
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdbaldry
force-pushed
the
jdb/2024-02-use-inline-ref-uris
branch
2 times, most recently
from
81a552b
to
becbd65
Compare
Signed-off-by: Jack Baldry <[email protected]>
It takes too long to run each time for a regular DX task like `make docs`. I'd rather risk that the file is out of sync. Signed-off-by: Jack Baldry <[email protected]>
Matching the implementation in grafana/website#18304. Signed-off-by: Jack Baldry <[email protected]>
jdbaldry
force-pushed
the
jdb/2024-02-use-inline-ref-uris
branch
from
becbd65
to
b0ab483
Compare
|
This PR has not had any activity in the past 30 days, so the |
github-actions
bot
added
the
needs-attention
rfratto
added
variant/static
github-actions
bot
removed
the
needs-attention
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Matching the implementation in https://github.com/grafana/website/pull/18304.
I know of at least one transformation bug that can be seen in the patch for
docs/sources/data-collection.mdwhere the link is missing a trailing space.Drafting this until I can check through the patch and the files to see what other bugs I can uncover.
You can test locally with
make docs DOCS_IMAGE=grafana/docs-base:nightlyIf you have the website repository cloned, you can also use the
jdb/2024-01-link-checkingbranch to do link checking but be aware that link checking doesn't follow aliases nor can it handle therelrefshortcode.You run the two projects together with
make docs 'PROJECTS=agent grafana-cloud' DOCS_IMAGE=grafana/docs-base:nightlyTo see the most viewed Agent pages to prioritize checking them:
https://bi.grafana-ops.net/d/e7be048f-625e-486b-a4d3-37a393fe834f/docs-page-views?orgId=1&var-repository=All&var-path=%5E%2Fdocs%2Fagent&viewPanel=7 or https://bi.grafana-ops.net/d/fdc2ghw1231fkf/health-check-3e-pages?orgId=1&var-regexp=%5E%2Fdocs%2Fagent&var-projects=Agent