Skip to content

Update Product Handbook to reference new MR template when making changes to the Product Handbook

Brian Rhea requested to merge reference-to-product-handbook-mr-template into master

To suggest a change to the Product Handbook, please review the updating the Product Handbook section.

Related to:

Product#3425 (closed)

Please provide a brief explanation for this change:

This is an update to the Product Handbook which references this very MR template which should be used when making updates to the Product Handbook.

The Change-Product-Handbook merge request description template will add the appropriate labels and reviewers to make sure your changes appear on the Product Handbook updates page.

Please indicate the types of revisions being suggested for the Product Handbook (please check all that apply):

  • Small improvement (typos, clarifications, etc.)
  • Adding a new section
  • Modifying existing section
  • Documenting a new process
  • Adding a new page or directory
  • Other

Please indicate Milestone

  • Assigned to Milestone

Author Checklist

  • Provided a concise title for the MR
  • Provided a brief explanation for this change (say-why-not-just-what)
    • (Attach screenshots, Slack conversations, etc. as necessary)
  • Indicated the types of changes included in this MR
  • Verified that no confidential data is in this MR
  • Assigned reviewers for this change to the correct DRI(s)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #product or #whats-happening-at-gitlab linking to this MR.
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.
Edited by Brian Rhea

Merge request reports