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

Create a variable for the latest product version in TiDB user documents #177

Open
qiancai opened this issue Sep 16, 2021 · 0 comments
Open
Assignees

Comments

@qiancai
Copy link
Contributor

qiancai commented Sep 16, 2021

Is your feature request related to a problem? Please describe.

Currently, when there is a new product version, the Docs team needs to update the current product version to the new version by searching the current version and replacing it with the new version.

However, not all product versions need to be updated to the new version, because some of them are just version-specific information, so the Docs team has to check each replacement (usually more than 100 instances) individually and update the version-specific information back to the old version, which is quite time-consuming and prone to errors.

Describe the solution you'd like

  1. Create a variable for the latest product version and add the variable definition to one Markdown file. For example, the variable name could be "tidb_latest_version", and the variable value could be "TiDB v5.0.4“。

  2. In each place where the product version needs to be pumped, update the product version (for example, TiDB v5.0.4) to the variable name (for example, $tidb_latest_version$).

  3. In the future, if there is a new product release, the Docs team can only update the variable value in that variable definition file.

@qiancai qiancai changed the title Create a variable for the latest product version in the user documents Create a variable for the latest product version in TiDB user documents Sep 16, 2021
@cw1997 cw1997 pinned this issue Sep 30, 2021
@cw1997 cw1997 unpinned this issue Sep 30, 2021
@Bosn Bosn self-assigned this Sep 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants