Skip to content

Update the README

Jamie Maynard requested to merge update-readme into main

Why is this change being made?

  • Update the README

The README has been out of date for a while following changes to Hugo and the docker images we need to use. So this MR updates the README with the latest directions on how to get up and running with the Handbook locally.

  1. Docker is the preferred setup for running Hugo locally to build/preview the handbook
  2. Refine the order of setup steps
    1. Requirements
    2. Getting Started
    3. Clone the repository, sync the data with the new script
    4. Running Hugo
    5. Parameters for Hugo
    6. Build static files
    7. Running Markdown lint
  3. Start with architecture documentation (Hugo extended, requirement for dev environments, Docsy theme Go module, CI/CD pipelines, etc.)

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 Michael Friedrich

Merge request reports