Update admin docs with new admin area access info
What does this MR do?
GitLab 14.0 includes an interface change that moves the UI element to access the Admin Area to a new location; from the top menu bar to within the Menu option on the top menu bar.
This updates the administration documentation pages that describe accessing the Admin Area to reflect the new interface change.
Related issues
For #333270 (closed)
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.
-
Request a review from 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.
Merge request reports
Activity
changed milestone to %14.0
added Technical Writing devopssystems documentation groupdistribution labels
requested review from @cnorris
assigned to @axil
@cnorris here's a small one
😄 - Resolved by Achilleas Pipinellis
1 Warning ⚠ This merge request is quite big (520 lines changed), please consider splitting it into multiple merge requests. 1 Message 📖 This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
doc/administration/auditor_users.md
doc/administration/geo/disaster_recovery/background_verification.md
doc/administration/geo/disaster_recovery/planned_failover.md
doc/administration/geo/disaster_recovery/runbooks/planned_failover_multi_node.md
doc/administration/geo/disaster_recovery/runbooks/planned_failover_single_node.md
doc/administration/geo/replication/configuration.md
doc/administration/geo/replication/disable_geo.md
doc/administration/geo/replication/docker_registry.md
doc/administration/geo/replication/object_storage.md
doc/administration/geo/replication/remove_geo_site.md
doc/administration/geo/replication/troubleshooting.md
doc/administration/geo/replication/tuning.md
doc/administration/housekeeping.md
doc/administration/maintenance_mode/index.md
doc/administration/operations/extra_sidekiq_processes.md
doc/administration/operations/fast_ssh_key_lookup.md
doc/administration/polling.md
doc/administration/raketasks/check.md
doc/administration/raketasks/project_import_export.md
doc/administration/raketasks/storage.md
doc/install/azure/index.md
doc/user/admin_area/geo_nodes.md
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
🚫 Danger- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
added 1 commit
- 9635d378 - Update administration pages with new admin area access info
added 1 commit
- 3f469784 - Update administration pages with new admin area access info
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
- Resolved by Achilleas Pipinellis
removed review request for @mkozono
added sectioncore platform label
added 157 commits
-
5754ac60...c044eeae - 156 commits from branch
master
- b53a4c06 - Update administration pages with new admin area access info
-
5754ac60...c044eeae - 156 commits from branch
mentioned in issue #334020
added 17 commits
-
b53a4c06...2aa4fa13 - 16 commits from branch
master
- fb4a0046 - Update administration pages with new admin area access info
-
b53a4c06...2aa4fa13 - 16 commits from branch
@sselhorn this should be ready.
added Pick into 14.0 label
requested review from @sselhorn
enabled an automatic merge when the pipeline for d0925f33 succeeds
@axil MWPS!
🚀 mentioned in commit b7892c51
added workflowstaging label
added workflowcanary label and removed workflowstaging label
added docsfeature label
added workflowproduction label and removed workflowcanary label
picked the changes into the branch
14-0-stable-ee-patch-1
with commit 75ed1095mentioned in commit 75ed1095
Automatically picked into !64764 (merged), will merge into
14-0-stable-ee
ready for14.0.1-ee
.removed Pick into 14.0 label
mentioned in merge request !64764 (merged)
added releasedcandidate label