Skip to content

DE/TMM epic templates workflow: Update instructions for more efficient creation (activity questions, etc.)

Michael Friedrich requested to merge de-tmm-epic-templates-handbook-efficiency into master

Why is this change being made?

💡 Provide a detailed answer to the question on why this change is being proposed, in accordance with our value of Transparency.

I've noticed some inefficiencies with filling in the epic templates for DE/TMM content, events and release evangelism.

  1. The activity section had the 4 questions commented out as HTML comments, which makes them harder to edit.
    • Solution: Remove HTML comments and make them a list with 1-4 and sub bullets for answers to fill in. This ensures that all epics provide enough context.
  2. Instructions as HTML comments are not shown when the new rich text editor is used, only in raw markdown.
    • Solution: Use text with notes and bold formatting instead.
  3. The release evangelism epic links to the handbook, which is great. Sometimes, it is faster to access the Slack channel directly for latest updates.
    • Solution: Add Slack channel link into the epic template

FYI @gitlab-de

Author and Reviewer Checklist

Please verify the check list and ensure to tick them off before the MR is merged.

  • 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
  • For transparency, share this MR with the audience that will be impacted.
    • Team: For changes that affect your direct team, share in your group Slack channel
    • Department: If the update affects your department, share the MR in your department Slack channel
    • Company: If the update affects all (or the majority of) GitLab team members, post an update in #whats-happening-at-gitlab linking to this MR

Merge request reports