Skip to content

Use keyword and not parameter in CI docs

Marcel Amirault requested to merge docs-yaml-parameters-to-keywords into master

What does this MR do?

As per the related issue, we are mixing keyword and parameter when talking about YAML config. After looking through our docs and details about YAML, it's clear that we need to use keyword as the standard word for the configuration words in GitLab CI/CD config files. It's already the most common word we use, we just need to replace the remaining cases of parameter, but only when it applies to GitLab CI/CD keywords.

Related issues

Related to #244621 (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.

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