Skip to content

Docs: Update 1k reference to match changes in 2K page

Craig Norris requested to merge docs-add-2k-page-changes into master

What does this MR do?

This MR makes several changes to the 1K reference architecture page, based on items developed in the 2K page, including:

  • Metadata with stage/group association
  • Removal of footnotes, and integration of footnote 8 into body text
  • Moving recommendation for "most organization's should use this" to the top of the page
  • Removed code formatting from Azure/AWS/GCP server names to match the vendors' formatting for servers
  • General editing

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Achilleas Pipinellis

Merge request reports