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

When doing a new release version of the docs, version numbers should get updated #121

Open
maleck13 opened this issue Jun 27, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@maleck13
Copy link
Contributor

In some places in the docs we have the version number such as
https://docs.kuadrant.io/0.8.0/kuadrant-operator/doc/install/install-openshift/#step-5-create-secrets-for-your-credentials (see the catalog image)

along with the channel for the subscription.

Ideally when doing a release these places would automatically be updated

@maleck13 maleck13 added this to the Kuadrant v1 milestone Jun 28, 2024
@david-martin david-martin removed this from the Kuadrant v1 milestone Jan 23, 2025
@david-martin
Copy link
Member

Thoughts on some ways to approach this:

If we used variables, that sounds like a reasonable programatic way to solve this.
However, I'm not aware of any variable support (at least not natively) in markdown or mkdocs.
That would rule out generation time variables (the mkdocs step), without writing or finding some plugin.

One option instead of variables is to have a definitive list of strings, and a script that looks through all markdown files for those strings, replacing them with some new value.
This script would be run as part of the process for doing a new 'release' of docs.
I could see that working well for content that is sourced directly from this docs repo (like getting started, and the install guides).
For content sourced from other repos, it gets complicated as you'd need to update values in potentially multiple repos, results in multiple PRs.

Given the context of the issue description, I think a good first pass on this would be having a script that looks for specific strings of text, like quay.io/kuadrant/kuadrant-operator-catalog:v0.11.0 or https://github.com/Kuadrant/kuadrant-operator//config/install/standard?ref=v1.0.1 and updates them to a new passed in version.
This script would be initially limited to the markdown content in this repo.

@david-martin david-martin added the good first issue Good for newcomers label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: No status
Development

No branches or pull requests

2 participants