Propose stage assignments for administration pages
What does this MR do?
Proposes stage / group assignments for the following pages:
- administration/auth/smartcard.md - devopsmanage ~"group::access" because it's about authentication (@mjang1)
- administration/compliance.md - devopsmanage groupcompliance because it's about compliance (@mjang1)
- administration/database_load_balancing.md - devopsenablement groupdatabase because it's about databases (@axil)
- administration/object_storage.md - devopsenablement groupdistribution because omnibus-gitlab!4368 (merged) came from there in %13.2. (@axil)
- administration/operations/extra_sidekiq_processes.md - devopsenablement groupdistribution because it's about Omnibus GitLab (@axil)
- administration/raketasks/doctor.md - devopsenablement groupgeo because it's mostly about #20069 (closed) which was added by this group in %13.1 (@axil)
- administration/raketasks/geo.md - devopsenablement groupgeo because it says in the first sentence it's about Geo (@axil)
- administration/raketasks/ldap.md - devopsmanage ~"group::access" because LDAP is about authentication (@mjang1)
- administration/troubleshooting/elasticsearch.md - devopsenablement groupglobal search because it's about search (@axil)
- administration/troubleshooting/group_saml_scim.md - devopsmanage ~"group::access" because SAML is about authentication (@mjang1)
I am open to any of these being wrong. I'm making guesses based on linked MRs and what's on the page.
Related issues
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.