pingcap / pingcap/website-docs

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

Open
#177 0 comments 0 reactions 1 assignee View on GitHub

@Bosn is already working on this.

Since Sep 11, 2023.

Dominant language
TypeScript
Stars
23
Forks
33
Avg merge
3d 5h
Merged PRs (30d)
7

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.