The source project of this merge request has been removed.
Docs: SSOT edits to docs that are alone in root directories
What does this MR do?
This MR attempts to brings scattered singleton docs (those that are alone in their own directory in /doc
) up to the standards of the SSOT Epic (&1280 (closed))
-
doc/migrate_ci_to_ce/README.md
: Add front matter, fix formatting issues, troubleshooting section already present. -
doc/policy/maintenance.md
: Add front matter, intro, fix formatting issues, troubleshooting section not added (seems to not make sense here) -
doc/public_access/public_access.md
: Add front matter, clean up intro, make the sections match each other, add troubleshooting section -
doc/push_rules/push_rules.md
: Add front matter, expand intro, improve a link, add troubleshooting section. -
doc/ssh/README.md
: Add front matter, improve links, troubleshooting section already present. Note: Some duplication was present in/gitlab_basics
, but resolved by https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/28039. -
doc/subscriptions/index.md
: Add front matter and troubleshooting section -
doc/system_hooks/system_hooks.md
: Add front matter, a link, and troubleshooting section. -
doc/tools/email.md
: Add front matter, improve intro, fix grammar, add troubleshooting section
Related issues
https://gitlab.com/gitlab-org/gitlab-ce/issues/62265
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
-
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 and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Mike Lewis