Revise the subheadings about state file UI
What does this MR do?
This merge request is intended to support the release post item gitlab-com/www-gitlab-com!71446 (merged) by revamping the section about managing terraform state through the UI. Revamping the full page is out of scope of what can be done before %13.8 lands, but I can bring this section of the page closer to the concepts-tasks-resources format we're supposed to adhere to.
What this MR does:
- Adds introduced-in information to the UI section. (If we don't, gitlab-com/www-gitlab-com!71446 (merged) will be flagged as a problem prior to the %13.8 release)
- Starts the section by describing the concept of managing terraform state through the UI, and describes the UI.
- Where applicable (the actions menu) crosslinks to more information.
- Clarifies what user levels can view information and take action.
- Combines the subheadings about removing a state file. Doing this through the UI and through the REST API are essentially one-liners and don't need subheadings. The GraphQL version is long enough to keep in a subheading.
- Some cleanup of wording issues identified by Vale.
Related issues
Related to gitlab-com/www-gitlab-com!71446 (merged) which is the release post for this item.
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. - If you have Developer permissions or higher:
-
Ensure that the product tier badge is added to doc's h1
. -
Apply the documentation label, plus: - The corresponding DevOps stage and group labels, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
-
Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.
When applicable:
-
Update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Add the product tier badge accordingly. -
Add GitLab's version history note(s). -
Add/update the feature flag section.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage. -
Ensure docs metadata are present and up-to-date. -
Ensure Technical Writing and documentation are added. -
Add the corresponding docs::
scoped label. -
If working on UI text, add the corresponding UI Text
scoped label. -
Add twdoing when starting work on the MR. -
Add twfinished if Technical Writing team work on the MR is complete but it remains open.
-
For more information about labels, see Technical Writing workflows - Labels.
For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:
- Clear typos, like
this is a typpo
. - Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.
For more information, see our documentation on Merging a merge request.
3. Maintainer
-
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. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.