doc/api: Clarify group storage moves API use case
What does this MR do and why?
doc/api: Clarify group storage moves API usecase
The group storage moves API is used to migrate group wiki repositories from one storage to another. Projects contained within a group are not migrated as part of this operation. In the documentation, this is not immediately clear to the reader and it would be reasonable to assume that moving a group to a new storage would also move all associated project repositories.
Clarify the group storage moves API documentation introduction to explicitly explain that a group's project repositories are not moved through the use of this API.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Before | After |
---|---|
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
changed milestone to %16.3
assigned to @justintobler
- A deleted user
added documentation label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/api/group_repository_storage_moves.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost User-
- Resolved by Ashraf Khamis
Per discussion in https://gitlab.com/gitlab-com/gl-infra/reliability/-/issues/24130#note_1476911800, the purpose of the group storage moves API can be easily misunderstood. This change attempts to clarify the documentation for its use case.
@ashrafkhamis Would you mind reviewing?
requested review from @ashrafkhamis
added docs-only label
- Resolved by Ashraf Khamis
added Technical Writing docsimprovement labels
enabled an automatic merge when the pipeline for 28b5519f succeeds
mentioned in commit 9628efa5
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label