Skip to content

Include nmalcolm's readme

Nick Malcolm requested to merge nm-readme into main

Why is this change being made?

From @jamiemaynard on Slack:

So the idea is that lots of people either have 2 READMEs or only one in the Handbook or only one on their profile. The idea is that those who's READMEs are in the handbook should migrate them to GitLab where they have full control over their README and to create a page which imports the README and renders it in the Handbook.

For those who have always had their READMEs in GitLab this gives an opportunity to bring them to the Handbook and to have their README as part of their teams group of READMEs

https://gitlab.slack.com/archives/CM74JMLTU/p1694162727064249?thread_ts=1694082595.821569&cid=CM74JMLTU

I am in the latter camp - I've always had my README on my profile https://gitlab.com/nmalcolm / https://gitlab.com/nmalcolm/nmalcolm/-/blob/main/README.md. This MR includes it in the handbook for discoverability.

See https://gitlab.com/gitlab-com/content-sites/handbook/blob/main/content/handbook/ceo/chief-of-staff-team/readmes/jamiemaynard.md for the pattern I copied.

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 Nick Malcolm

Merge request reports