Skip to content

Update to Improving Documentation workflow handbook page

Michael Gibson requested to merge mgibsongl-contributing-to-docs into master

Why is this change being made?

Per the RFC I opened (#4972), this MR is intended to collect some information on a single to assist Support Engineers when they wish to contribute to Documentation.

I've preserved much of the original content of this page to include the Zendesk workflow, while adding the additional information I found to be useful. If there is anything you think I've missed, please feel free to suggest it.

Author Checklist

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added, and the content is SAFE
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • 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 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
    • The when to get approval handbook section explains the workflow in more detail
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #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.

I've also assigned as reviewers those folks who commented on the RFC. Thanks again!


Merge request reports

Loading