Geo: Document the 2 versions of project repo replication based on FFs
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
As part of epic &17974, Geo is gaining a new V2 code path for project repository replication, gated behind the geo_project_repository_replication_v2 feature flag. Under V2, Geo enumerates the project_repositories table instead of the projects table (see #546175), because a ProjectRepository record represents an actual Git repository, whereas a Project may not have one.
During the transition period, both code paths coexist. Administrators and contributors need clear documentation explaining the two versions, how to enable them, and what the expected behaviour is in each case.
What needs to be documented
-
The two versions of project repository replication and the feature flags that control them:
- V1 (default):
geo_project_repository_replication— enumeratesprojects, enabled by default - V2:
geo_project_repository_replication_v2— enumeratesproject_repositories, must be explicitly enabled - When both flags are enabled, V2 takes priority
- V1 (default):
-
The eventual deprecation path:
geo_project_repository_replication_v2will be removed once V2 becomes the default, andgeo_project_repository_replicationwill cover both -
Update the
data_managementdocumentation to reflect the V2 behaviour (e.g. the data management view showsproject_repositoriesinstead ofprojectsunder V2)
Note: this issue is blocked by #563394, which handles toggling between the two versions. Documentation should reflect the final toggling behaviour once that is resolved.