Skip to content

Expand yaml reference for yaml options and value

Marcel Amirault requested to merge docs-variables-dropdown-details into master

What does this MR do?

This MR expands the YAML keyword reference with sections specifically for variables: value and variables: options, which previous didn't have their own section (so we couldn't link to them). I have also added some additional details that I noticed while testing this.

I changed the example in the ci/pipelines/index.md page as well, as the old example would be better done as a downdown list with variables:options instead. The updated version shows two use cases that don't need options.

Related to this (and the related issue), now that we have them in the reference, we can link directly to them from the CI schema, so I've updated that as well.

Related issues

Resolves #385015 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports