Skip to content

Add structure to admin area page

Evan Read requested to merge docs/admin-area-doc-structure into master

What does this MR do?

As https://gitlab.com/gitlab-org/gitlab-ce/issues/57874 is built out, we need to start making use of more structure.

This MR implements a simple structure that should scale for a while (while everything is maintained in a single page).

Preview: http://review-docs-docs-kfu23x.178.62.207.141.xip.io/ce/user/admin_area/index.html.

CC @rdickenson

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

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

  • Optional: 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.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Evan Read

Merge request reports