Skip to content

Docs: Refactor K8s Agent doc

Marcia Ramos requested to merge docs-k8s-agent-review into master

What does this MR do?

Refactor the k8s Agent main doc. (1st iteration)

  • Better intro. Include the "why", bring K8s, GitOps, GitLab, CD together.
  • Move installation instructions into a new document.

Review apps:

In the next iterations, I plan to move the rest of the install-related content:

  • Kubernetes Network Security Alerts into a new doc
  • Remove the GitLab Kubernetes Agent => into a new doc
  • Troubleshooting => into a new doc

Related issues

Author's checklist

To-dos:

  • Self-review
  • Fix links
  • PM review (or eng review)
  • TW review
  • FE review (if the changes affect help paths) => no help paths changed

Review 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.
    • 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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Marcia Ramos

Merge request reports

Loading