Skip to content

Support more than one Technical Writer per group

Why is this change being made?

Now that more than one Technical Writing team member can be assigned to a group, our assignments table needs to support more than one value for tech_writer in data/stages.yml.

CC @kpaizee @dianalogan @ashrafkhamis

How to test

  1. Clone this project.
  2. Check out this branch.
  3. In the root directory of the project, run bundle exec rake build:handbook. Wait for that to complete.
  4. Change into sites/handbook.
  5. Run bundle exec middleman serve. It takes some time to be ready. Wait for == Webpack proxy server enabled: use "http://localhost:4567" or "http://127.0.0.1:4567" to appear. Even then, it can take more time to be ready.
  6. Go to one of the following:
    • http://localhost:4567/handbook/product/ux/technical-writing/#designated-technical-writers
    • http://127.0.0.1:4567/handbook/product/ux/technical-writing/#designated-technical-writers

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.

Edited by Evan Read

Merge request reports