Skip to content

Change usage of CI/CD variables terminology in package docs

Marcel Amirault requested to merge docs-package-variables into master

What does this MR do?

In the linked issue, we are trying to standardize how we talk about CI/CD variables. We use a variety of terminology, but the most common issue is the use of "Environment variable", which can be confused with the Environments feature, or variables in other environments than CI/CD.

This MR standardizes the usage of variables in the package docs, following this convention:

  • The first time CI/CD variables are mentioned, use CI/CD variable
  • Any further mentions can use simply variable, as long as the context continues to be clear that it's CI/CD variables.
  • If Environment variable is used to describe variables within an environment, like in a Kubernetes Pod or a container, then it is left unchanged.

Related issues

Related to #321011 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcel Amirault

Merge request reports

Loading