Clean up Podman with Kubernetes examples
What does this MR do?
Cleans up the Use Podman with GitLab Runner on Kubernetes doc based on user feedback.
Changes
- Removes feature flags from
.gitlab-ci.ymlexamples and replaces them with a link to the feature flags page.FF_USE_ADVANCED_POD_SPEC_CONFIGURATION: "true"is kept in example 2 as it is required for thepod_specconfiguration to work. - Removes personal test data and internal fields from
config.tomlexample 1:id,token,token_obtained_at, anduser = "ratchade". - Removes empty blocks from both
config.tomlexamples:[[runners.kubernetes.services]],[runners.kubernetes.dns_config], and[runners.kubernetes.pod_labels].
Related issues
https://gitlab.com/gitlab-org/gitlab/-/work_items/595055
Author's checklist
- Optional. Consider taking the GitLab Technical Writing Fundamentals course.
- Follow the:
- If you're adding or changing the main heading of the page (H1), ensure that the product availability details are added.
- If you are a GitLab team member, request a review based on:
- The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue. - The headings (other than the page title) should be active. Instead of
Configuring GDK, say something likeConfigure 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.
- The headings should be something you'd do a Google search for. Instead of
- Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
Edited by Roshni Sarangadharan