Remove all instances of "high availability" from docs
Problem to solve
We have received feedback that the term is ambiguous to customers - it can set different expectations depending on the reader. It is better to speak directly to GitLab's capabilities and how we recommend scaling our application to accommodate various numbers of users (via our reference architectures). Mentions of availability will instead be exclusively covered in content on about.gitlab.com.
Actions
Per business requirements and direction from the executive level, we need to remove all mentions of high availability (and its different forms, including HA and highly available) from the product documentation. GitLab will continue to talk about high availability by way of information in the Handbook, but they want us to "get out of the business" of talking about this conceptually in the documentation, and instead use the documentation to drive people to our defined Reference Architecture pages.
This change is related to the upcoming Style Guide update to avoid the use of high availability (!31917 (merged)) but we have an organizationally mandated deadline that we have to meet.
The following list includes the files that need to be changed for this issue:
| Path | Writer | MR |
|---|---|---|
| /doc/administration/file_hooks.md | (Amy) | !32222 (merged) |
| /doc/administration/geo/replication/datatypes.md | (Amy) Axil | !32222 (merged) |
| /doc/administration/geo/replication/external_database.md | (Amy) Axil | !32222 (merged) |
| /doc/administration/geo/replication/geo_validation.md | (Evan) Axil | !32269 (merged) |
| /doc/administration/geo/replication/high_availability.md | (Evan) Axil | !32269 (merged) |
| /doc/administration/geo/replication/index.md | (Evan) Axil | !32269 (merged) |
| /doc/administration/geo/replication/troubleshooting.md | (Evan) Axil | !32269 (merged) |
| /doc/administration/geo/replication/version_specific_updates.md | (Amy) Axil | !32234 (merged) |
| /doc/administration/gitaly/praefect.md | Russell | !32228 (merged) |
| /doc/administration/index.md | Russell | !32232 (merged) |
| /doc/administration/monitoring/gitlab_self_monitoring_project/index.md | Russell | !32268 (merged) |
| /doc/administration/monitoring/prometheus/index.md | Amy | !32210 (merged) |
| /doc/administration/object_storage.md | Suzanne | !32197 (merged) |
| /doc/administration/packages/container_registry.md | Suzanne | !32202 (merged) |
| /doc/administration/reference_architectures/index.md | (Amy) Axil | !32257 (merged) |
| /doc/administration/troubleshooting/postgresql.md | Amy | !32234 (merged) |
| /doc/development/testing_guide/end_to_end/rspec_metadata_tests.md | Marcia (Amy) | !32234 (merged) |
| /doc/development/uploads.md | Marcia (Craig) | !32208 (merged) |
| /doc/install/aws/index.md | (Amy) | !32217 (merged) |
| /doc/topics/autodevops/customize.md | (Amy) | !32217 (merged) |
| /doc/user/clusters/applications.md | Amy | !32210 (merged) |
Procedure
- Review the list to determine if you have any pages that belong to you to change. If so, edit this issue description to associate your name with your page or pages. If you don't own any of these pages, you're done.
- Create an MR to update the page or pages to remove all forms of the phrase high availability (including highly available and HA).
- Link your MR to this issue, for tracking.
This hopefully will be changes for only a few files, and should be prioritized over other items you have in your queue. If you have prioritization issues, or you cannot complete this work by your EOD tomorrow (Friday, May 15), please let me know. And if you you have any other questions about this, please drop a comment or message me in Slack.
Items of note
- Unless you see an HA that is literally preceded by Gitaly (as in Gitaly HA), you'll need to remove/replace it with something else.
- There's no hard and fast rule here, as we use this term in lots of different ways. We shouldn't replace high availability with scalable (as that's likely to be removed/revised in the future), but you have opportunities to remove unneeded lines or phrases that may refer to this concept, or to rework content into references for more information about how we handle more users by way of our defined reference architectures (https://docs.gitlab.com/ee/administration/reference_architectures/).
- This issue doesn't include any of the HA references in the doc/administration/high_availability directory, as there will be a separate issue for that work.
- This issue does not address existing or upcoming work with release posts. We can address RPs starting with 13.1 as they're developed, based on our updated style guide to avoid the HA term.