Skip to content

Indicate file where to place the code fragments

What does this MR do?

When reading this documentation page, I was not able to figure out what file this was to be added to. In hindsight, it is relatively obvious, but really could be more direct and clear.

To be confident, I had to read some other docs and eventually found: https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent/-/blob/e2779d446345f90c81da071e07f922ab3da5530e/doc/kubernetes_ci_access.md#apiv4joballowed_agents-api

Related issues

I didn't find one when I searched, and I didn't create one. Let me know if I need to.

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 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 Suzanne Selhorn

Merge request reports