Skip to content

Move development/contributing docs to docsy theme repo (embed via /docs/development), sync tools with other handbooks (hugolint, Hugo v0.123.7, CI/CD components)

Michael Friedrich requested to merge docs-ssot-tools-sync into main

Why is this change being made?

💡 Provide a detailed answer to the question on why this change is being proposed, in accordance with our value of Transparency.

The documentation in the README.md became the only updated location for handbook editing, bringing the internal and docsy-gitlab projects out of sync.

  1. This MR moves the development documentation to the docsy-theme (it deletes all README.md content, re-added and revised in docsy-gitlab!72 (merged))
    1. Bump docsy-gitlab to v0.3.16 which includes the documentation updates, and pulls it into the handbook sources as a Go module on hugo build
  2. CI/CD: Update hugolint to handbook-tools container registry path
  3. Bump the required Hugo version in config.yml to be in sync with CI/CD and documentation
  4. Rename LICENCE to LICENSE, fix copyright year to avoid future yearly updates
  5. Use CI/CD components instead of templates
  6. Bump docsy-gitlab to v0.3.17 to fetch the latest /docs/development content

Related to

  1. Handbook: Get to fast, stable state (&10)
  2. Development docs: General docs, Hugo module dep... (docsy-gitlab#4 - closed)

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
    • Division: If the update affects your division, share the MR in your division 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