Skip to content

Fix Technical Writing pages in handbook

Evan Read requested to merge eread/fix-technical-writing-pages into main

Why is this change being made?

Many of the pages in the Technical Writing space are broken because they don't adhere to Hugo site standards.

A larger fix is proposed for the Technical Writing index page in !1199 (closed). This MR makes much smaller fixes, and mostly to the other pages.

Results

Index page:

Hiring Technical Writers page:

Setting up a local environment page:

Technical Writing Fundamentals page:

Editing content into different topic types page:

Technical Writing workflows page:

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
Edited by Evan Read

Merge request reports