Skip to content

docs: Update "type" for "id_tokens" gitlab ci keyword

DarwinJS requested to merge DarwinJS-update-idtokens-keyword into master

What does this MR do?

Most keywords in https://docs.gitlab.com/ee/ci/yaml indicate a type and what contexts they can be used in. This information is absent from id_tokens. While it might be because id_tokens came after the depreciation of global keywords, it leads to uncertainty when having read existing keywords with the designation.

It is also confusing in that a casual reader won't know if each keyword must be explicitly allowed in "default" job or if all keywords can be there by definition.

An alternative would be to remove "Type" from all keywords if they are all the same and can only be put in "default" jobs.

Related issues

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 DarwinJS

Merge request reports