Skip to content

Docs: Merge Misc EE doc/administration files and dirs to CE

Marcel Amirault requested to merge (removed):docs-repo-merge-25-admin-misc into master

What does this MR do?

Ported to EE in https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/12061.

This aligns the CE and EE doc/administration docs, including the doc/administration/img and doc/administration/raketasks sub-directories not covered by any other MR, as part of the effort to combine docs into a single codebase (&199 (closed))

This MR:

  • Brings in EE only files:
    • administration/audit_events.md
    • administration/auditor_users.md
    • administration/database_load_balancing.md
    • administration/instance_review.md
    • administration/maven_packages.md
    • administration/maven_repository.md
    • administration/npm_registry.md
    • administration/packages.md
    • administration/pseudonymizer.md
    • administration/raketasks/geo.md
  • Brings EE only content into:
    • administration/custom_hooks.md
    • administration/incoming_email.md
    • administration/index.md
    • administration/raketasks/storage.md
    • administration/repository_storage_types.md
  • Only changes links to absolute:
    • administration/compliance.md
  • Brings in 8 images for the docs above, and deletes too (explained below)
  • Adds missing badges, as necessary.
  • Note: administration/high_availability/README.md is a special case. The EE version of this file was modified, but not ported to CE. The newer EE version does not link to administration/img/high_availability/active-active-diagram.png or administration/img/high_availability/active-passive-diagram.png anymore, and so those two images were deleted from the /administration/img. The links to those two images causes the lint to fail, so they were removed. The rest of the content will be aligned in a different MR.

When both the EE Port and this MR are merged, the doc/administration, doc/administration/img and doc/administration/raketasks docs should hopefully be aligned between CE and EE.

Then, please merge: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/12063, and the issue will be closed.

Related issues

Related to https://gitlab.com/gitlab-org/gitlab-ce/issues/59156

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 Marcel Amirault

Merge request reports