[v2.6.x] Remove inline shortcodes#4882
Merged
mdisibio merged 3 commits intorelease-v2.6from Mar 24, 2025
Merged
Conversation
It's not worth the risk of letting content define arbitrary templates. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
jdbaldry
requested review from
annanay25,
electron0zero,
ie-pham,
joe-elliott,
knylander-grafana,
mapno,
mdisibio,
stoewer and
zalegrala
as code owners
knylander-grafana
approved these changes
Mar 20, 2025
Contributor
|
We might need to update the doc validator for this PR to pass for this branch. The validator is failing on relref. |
Contributor
Author
|
It doesn't look to be a required check |
Contributor
Author
|
@grafana/tempo, you'll need to review the branch rules for this release branch I think as it's considered a supported version (at least for the docs). |
mdisibio
deleted the
grafana-tempo-v2.6.x-jdb/2025-03-disable-inline-shortcodes
branch
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Inline shortcodes are powerful templating tools and allow source projects to iterate on HTML templates without a PR to the website repository.
However, by accident or malintent, they can be used break the website or expose information.
On the balance of things, the Docs Platform team believes that the risk outweighs the reward and will be disabling the feature.
The team believes it can support the prompt and safe creation of central shortcodes to satisfy the needs of the source projects.
All existing inline shortcodes have already been translated into central shortcodes that everyone can use.
Created-By: reverse-changes
Repository: grafana/tempo
Website-Pull-Request: https://github.com/grafana/website/pull/24705