You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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
The text was updated successfully, but these errors were encountered: