Merge branch 'doc_project_move_states' into 'master'

Give definitions to each of the repository storage move states

See merge request gitlab-org/gitlab!65288

doc/api/group_repository_storage_moves.md

@@ -16,13 +16,13 @@ example, or to migrate a Group Wiki.
 As group repository storage moves are processed, they transition through different states. Values
 of `state` are:
 
-- `initial`
-- `scheduled`
-- `started`
-- `finished`
-- `failed`
-- `replicated`
-- `cleanup failed`
+- `initial`: The record has been created but the background job has not yet been scheduled.
+- `scheduled`: The background job has been scheduled.
+- `started`: The group repositories are being copied to the destination storage.
+- `replicated`: The group has been moved.
+- `failed`: The group repositories failed to copy or the checksums did not match.
+- `finished`: The group has been moved and the repositories on the source storage have been deleted.
+- `cleanup failed`: The group has been moved but the repositories on the source storage could not be deleted.
 
 To ensure data integrity, groups are put in a temporary read-only state for the
 duration of the move. During this time, users receive a `The repository is temporarily

doc/api/project_repository_storage_moves.md

@@ -16,13 +16,13 @@ for example.
 As project repository storage moves are processed, they transition through different states. Values
 of `state` are:
 
-- `initial`
-- `scheduled`
-- `started`
-- `finished`
-- `failed`
-- `replicated`
-- `cleanup failed`
+- `initial`: The record has been created but the background job has not yet been scheduled.
+- `scheduled`: The background job has been scheduled.
+- `started`: The project repositories are being copied to the destination storage.
+- `replicated`: The project has been moved.
+- `failed`: The project repositories failed to copy or the checksums did not match.
+- `finished`: The project has been moved and the repositories on the source storage have been deleted.
+- `cleanup failed`: The project has been moved but the repositories on the source storage could not be deleted.
 
 To ensure data integrity, projects are put in a temporary read-only state for the
 duration of the move. During this time, users receive a `The repository is temporarily

doc/api/snippet_repository_storage_moves.md

@@ -16,13 +16,13 @@ example.
 As snippet repository storage moves are processed, they transition through different states. Values
 of `state` are:
 
-- `initial`
-- `scheduled`
-- `started`
-- `finished`
-- `failed`
-- `replicated`
-- `cleanup failed`
+- `initial`: The record has been created but the background job has not yet been scheduled.
+- `scheduled`: The background job has been scheduled.
+- `started`: The snippet repository is being copied to the destination storage.
+- `replicated`: The snippet has been moved.
+- `failed`: The snippet repository failed to copy or the checksum did not match.
+- `finished`: The snippet has been moved and the repository on the source storage has been deleted.
+- `cleanup failed`: The snippet has been moved but the repository on the source storage could not be deleted.
 
 To ensure data integrity, snippets are put in a temporary read-only state for the
 duration of the move. During this time, users receive a `The repository is temporarily