Geo Admin Dashboard: Align Component names with Docs
Why are we doing this work
Currently, in Geo we represent a replicable's component name different in the UI than we do in the docs. This can be confusing when trying to find information about a replicable and not being able to find it in the docs (due to the name being different).
We should align with the docs and update the UI component names to match what is in the docs currently.
Relevant links
- Component Name Docs: https://docs.gitlab.com/ee/administration/geo/replication/datatypes.html#data-types
- Follow up from conversation: #367087 (comment 2319072713)
- Current way titles are generated in the UI: https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/gitlab/geo/replicator.rb#L83-91
Implementation plan
The following replicator's names do not match the component names in the documentation:
| Replicator name (i.e in the UI/console) | Component name (from data types docs) | Comments |
|---|---|---|
| Container Repository | Container registry | Container Repositories are stored in the Container Registry, so maybe needs more alignment of docs and UI here than just the naming. @karras: Added in #517362 (closed). |
| Dependency Proxy Blob | Dependency proxy image | |
| Dependency Proxy Manifest | ?? | |
| Design Management Repository | Project designs repository | |
| Job Artifact | CI job artifact | |
| Merge Request Diff | External merge request diffs | |
| Package File | Package registry | |
| Pages Deployment | Page | |
| Snippet Repository | Snippet | Can be personal or project snippets |
| Terraform State Version | Versioned Terraform State | |
| Uploads | User upload |
After synchronous alignment, this issue can be addressed by:
- Adding a table like the one above to the Geo Glossary, highlighting the naming in the documentation (Component name) vs. in the Admin UI and Rails console (Replicator name);
- Involve
@axil(the Geo technical writer) as early in the process as possible to make sure the addition provides value and not more confusion.
Edited by Michael Hofer