Skip to content

Reorganize package handbook page

Katie Macoy requested to merge katiemacoy-master-patch-24172 into master

Why is this change being made?

@michelletorres has created an issue to improve package onboarding. I feel this handbook page has too much information, which makes it hard to scan. I think we can solve this by organizing the headings and also moving some sections to their own pages. A good example of a handbook page, in my opinion.

Assumption of who is the target audience of this page:

  • Primary: Package team members, esp. new team members
  • Primary: Members of other GitLab team members, wanting to engage with package team
  • Secondary: GitLab community/users

In this MR:

  • Added a table for recurring meetings
  • Moved async and missed retro to underneath recurring meetings table
  • Removed some of the finer detail about think BIG - this is in the calendar invite
  • Moved demos and speed runs to "Useful links" section
  • Moved "How we measure results" and "Performance indicators" together

I stopped there as this is already a lot of change. This MR is completely up for debate, so feel free to suggest changes.

Ideas for future iterations:

  • Move community contributions to it's own sub-page as it's quite detailed
  • Create a team resources page that would contain things like good examples of recorded meetings, how to create a project with lots of packages quickly, timezones etc.
  • Remove information about product direction and focus, I believe this information should live on the direction page
  • Remove some of the detail of standups, issue updates, missed deliverable retro - this is most relevant to a new team member and could be added to the onboarding issue
  • Remove information that is documented in other places in the handbook, e.g. JTBD - we can link to the JTBD page to explain what they are
  • Add a "how to work with us" section

Author Checklist

  • Provided a concise title for the 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.
  • Assign 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 #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.

Merge request reports