Skip to content

Initial refactor of Documentation process

Evan Read requested to merge eread/refactor-docs-process into master

What does this MR do?

Combines three documentation workflow topics into one. Does not seek the change any processes, just simplify and to improve the ease with which new and existing GitLabbers can follow them. When combined with: gitlab-docs!572 (merged), provides one simple place for our processes.

Also:

  • Fixes gitlab-foss links, making them gitlab.
  • Fixes outdated references to master permissions, "feature freeze", and dates used in old release processes.
  • Edits the content generally.

CC @gl-docsteam.

Related issues

Relates to: technical-writing#37 (closed).

Author's checklist

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 🤖 GitLab Bot 🤖

Merge request reports

Loading