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

Reference the latest version + patch for a given version in the docs with a reusable component #5058

Open
akeller opened this issue Feb 21, 2025 · 0 comments
Assignees
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)

Comments

@akeller
Copy link
Member

akeller commented Feb 21, 2025

Goal: Reference the latest version + patch for a given version in the docs with a reusable component. Update in one place and all references would be up-to-date.

We have several pages of docs where we want to include the version or patch number, but we can't do this in a scalable, easy-to-maintain way when the version or patch is in a code block like:

verisonNumber: 8.8.0

I tried creating a React component, similar to how we do reusable components, and that didn't work, it just rendered <react-component />.

versionNumber: <react-component />

A quick search led me to conclude we would need to inject it. I couldn't invest any more time into this and moved on.

Note - I've marked this issue with kind/enhancement but until we have a solution like this, the versions are often stale and need to be manually updated.

@akeller akeller added dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) labels Feb 21, 2025
@akeller akeller mentioned this issue Feb 21, 2025
12 tasks
@pepopowitz pepopowitz self-assigned this Feb 26, 2025
@pepopowitz pepopowitz moved this from 🆕 Inbox to 🔖 Ready in Documentation Team Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants