Skip to content

Conversation

@jdbaldry
Copy link
Contributor

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

It's not worth the risk of letting content define arbitrary templates.

Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry added the type/docs Improvements or additions to documentation label Mar 20, 2025
@jdbaldry jdbaldry marked this pull request as ready for review March 20, 2025 17:29
@knylander-grafana knylander-grafana merged commit 0fee9d1 into release-v2.7 Mar 20, 2025
20 checks passed
@knylander-grafana knylander-grafana deleted the grafana-tempo-v2.7.x-jdb/2025-03-disable-inline-shortcodes branch March 20, 2025 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants