Skip to content

Revamp predefined variables page

Marcel Amirault requested to merge docs-variables-reading-level into master

What does this MR do?

A revamp to the Predefined variables page.

  • The largest change is that the variables for merge request pipelines and external pull request pipelines are pulled out into their own sub-table.

    By doing this we can eliminate all the repetition that say things like Only available if [the pipelines are for merge requests](../merge_request_pipelines/index.md) and the merge request is created, and instead put that information in the intro to the table. This keeps the tables smaller and more manageable, and dramatically reduces the word/character count.

    It also makes it easier to see that these variables are only available in those specific pipelines.

  • Aligns the language around the words present, included and available. I decided to standardize on available, in the sense of "the variable is 'available' in the job in case X".

  • Aligns most of the grammar so that the same structure and grammar is used throughout. The structure being essentially:

    [Simple description][Availability][default value or example]

    Every variable had a different mix of these 3 bits of information, but they are now always ordered in the same way.

Related issues

Resolves #300722 (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