-
Notifications
You must be signed in to change notification settings - Fork 636
[v2.7.x] Remove relref shortcodes #4821
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
[v2.7.x] Remove relref shortcodes #4821
Conversation
jdbaldry
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
The website PR has CI that shows that this change introduces no additional broken links.
For any other reviewers, the doc-validator CI is enforcing outdated rules. The current guidance is in https://grafana.com/docs/writers-toolkit/write/links/. The relref shortcode won't be supported in the future and we'd like to prevent the proliferation of its use by copy-paste.
| * [S3]({{< relref "./hosted-storage/s3" >}}) | ||
| * [Azure]({{< relref "./hosted-storage/azure" >}}) | ||
| * [Parquet]({{< relref "./parquet" >}}) | ||
| * [GCS](hosted-storage/gcs/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need the ./ in front of a link for it to work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope! See https://deploy-preview-website-24448-zb444pucvq-vp.a.run.app/docs/tempo/latest/configuration/ (Username/password are in https://github.com/grafana/website/pull/24448)
|
I've set the PR to automerge when all of the checks pass. |
For https://github.com/grafana/website/issues/24017
Removes all relref shortcodes.
Created-By: reverse-changes
Repository: grafana/tempo
Website-Pull-Request: https://github.com/grafana/website/pull/24448