Create new reference architectures page
What does this MR do?
Review app: http://docs-preview-ee-30781.178.62.207.141.nip.io/ee/administration/reference_architectures/index.html
-
A single page doc/administration/reference_architectures/index.md
in the docs that:-
Describes the base set up (<1000 users) -
Adds the reference architectures of the scaling page -
Describes (or links to) the actual procedure for setting up the reference architecture
-
-
Adds the following 4 availability complexities - Automated Backups
- Traffic Load Balancer
- Automated Database Failover
- Instance level replication with GitLab Geo
-
Deprecate all the other pages which are confusing users (and us) and fix backlinks to them: -
https://docs.gitlab.com/ee/administration/scaling/ -
https://docs.gitlab.com/ee/administration/availability/ -
https://docs.gitlab.com/ee/administration/high_availability/ -
https://docs.gitlab.com/ee/administration/high_availability/gitlab.html => This refers to the GitLab Rails app, we can't deprecate it, but we should change the title. -
We should make an honest effort to find any more, because it keeps seeming like there is a new discovery every day
-
-
There are some stylistic things we need to change, which Sid describes in the video https://www.youtube.com/watch?v=wV3lzzXUogs -
"don't say 'simple'" -
Don't link to the list of all performance issues below each ref arch. -
Don't say "high availability" everywhere -
don't say "A 3k ref arch is being worked on", just add it when it exists
-
-
"Scaling" & "Availability" are still in the lefthand sidebar, even though they redirect gitlab-docs!841 (merged) -
The GitLab rails app page still exists, but the breadcrumb is broken. Let's rename it. It also seems to have a bunch of peer pages (visible in the left nav) e.g. /ee/administration/high_availability/database.html
tackle in a follow-up #214353 (closed) -
Add a link in "essential documentation" on the docs overview page: https://docs.gitlab.com/ee/README.html#overview -
Under "Up to 3,000 users" it says "Supported users (approximate): 2,000" I assume this is a typo -
Get rid of the sections: "GitLab reference architectures" (the top of page), "Overview", "Trade-offs", "Reference architectures", "Availability complexity" and rewrite something simpler and put in a chart. -
The "Configure GitLab to scale" needs to be per-reference architecture. It's very disembodied tackle in a follow-up #216448 (closed)
Follow-ups:
- Move reference architectures components to a new location
- Document how to configure GitLab to scale per reference architecture
- Find occurrences of HA in the docs and change them to the new ref architectures page
- Re-evaluate the four levels of availability complexity in the reference architecture docs
- Refactor the requirements docs in regards to the reference architectures
Related issues
Addresses part of #215161 (closed)
Author's checklist (required)
-
Follow the Documentation Guidelines and Style Guide. -
Apply the documentation label, plus: - The corresponding DevOps stage and group label, if applicable.
-
development guidelines when changing docs under
doc/development/*
,CONTRIBUTING.md
, orREADME.md
. -
development guidelines and Documentation guidelines when changing docs under
development/documentation/*
. - development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
-
Assign the designated Technical Writer.
When applicable:
-
Add the product tier badge. -
If you're changing document headings, search doc/*
,app/views/*
, andee/app/views/*
for old headings replacing with the new ones to avoid broken anchors.
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
-
Optional: 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. -
Add Technical Writing and docs::
workflow label. -
Add docs-only when the only files changed are under doc/*
.
-
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖