Skip to content

Development docs: move some docs content from Handbook and improve content/headings

Mike Lewis requested to merge docs-move-content-from-handbook-and-improve into master

What does this MR do?

  • Moves some content from https://about.gitlab.com/handbook/documentation/ to /doc/development/index.md /doc/development/styleguide.md as it affects more than just GitLabbers
  • Improves balance of content across those two /doc/development pages, bringing more into the Style Guide
  • Uses more descriptive headers
  • Other minor edits

Related issues

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.

/label ~Documentation

Edited by Achilleas Pipinellis

Merge request reports