Skip to content

Adds template for architecture design documents

Marc Saleiko requested to merge ms/design-docs/adds-documents-template into main

Why is this change being made?

Contributes to Move Architecture Blueprints to Public Handbook (#279 - closed)

We're migrating architecture design documents from the GitLab project to the handbook.

This MR adds the design docs template to the handbook.

Additional changes:

  1. Replaces blueprint with document or design document everywhere.
  2. Adds necessary front matter attributes and shortcodes to the template
  3. Minor comment changes for the new location

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

Commits

  • Adds template for architecture design documents

Edited by Marc Saleiko

Merge request reports

Loading