Skip to content

Move Epics instruction docs to a new page

Marcin Sedlak-Jakubowski requested to merge msj-epics-refresh into master

What does this MR do?

This is my first iteration of improving the Epics documentation:

  • Change "-ing" headings to infinitive forms to follow the style guide.
  • Separate how-to sections into a new page "Manage Epics".
🍝 Current epics/index.html 😍 New epics/index.html 😍 New epics/manage_epics.html
image image image

What's in scope of this MR:

  • Move the sections to a new page
  • Lightly edit a section where absolutely necessary

What's not in scope of this MR:

  • Deep edit each section

Related issues

See #217353 (closed) for context.

Follow-up

Author's checklist (required)

When applicable:

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.
  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