Removed duplicate information, pared down language
What does this MR do?
We want a single source of truth, and this page had a smattering of random info, some of which was duplicated on other pages, or belonged on other pages.
This MR removes all of the extra language and pares it down to a list of links.
Even these links will hopefully not be needed when /help goes away. Links like this are hard to maintain.
Specific changes
- Moved uninstall information into its own page.
- Moved version mapping details to the version mapping page.
- Added
## Subcharts
heading. I'd like to start calling these charts that are part of the GitLab Helm chartsubcharts
. - Edited the intro information.
- Removed bullet about the certificate-based Kubernetes integration because it's out-of-date.
Related issues
Related to: gitlab-org/technical-writing#642 (closed)
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
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 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.
-
-
-
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 Suzanne Selhorn