Update dev and API docs related to importing to GitLab
This is a follow up of Update user documentation regarding migrating g... (#385000 - closed), where we look into and update, if needed, API and development documentation related to importing to GitLab.
GitLab Migration API doc
-
Avoid GitLab Migration name in API documentation - (!109443 (merged), !117490 (merged)) -
Link API documentation in main user doc page. (see link at: https://docs.gitlab.com/ee/user/group/import/index.html#migrate-groups-by-direct-transfer-recommended)
Check if needs updating, link to user docs:
-
dev docs for migrating groups by direct transfer (see: https://docs.gitlab.com/ee/development/bulk_import.html) -
dev docs for migrating groups by file export/import -
dec docs for migrating projects by file export/import (see: https://docs.gitlab.com/ee/development/import_export.html) -
related rake tasks, if any (see: https://docs.gitlab.com/ee/administration/raketasks/project_import_export.html) -
API for group file export/import (see: https://docs.gitlab.com/ee/api/group_import_export.html#prerequisites) -
API for project file export/import (see: https://docs.gitlab.com/ee/api/project_import_export.html#prerequisites) -
API for group migration via direct transfer (https://docs.gitlab.com/ee/api/bulk_imports.html#prerequisites)
Check is this related, check links:
-
https://docs.gitlab.com/ee/raketasks/import.html -
doc/user/gitlab_com/index.md - talks about import/export rate limits, need to change the name there? -
check if the are other places, like above, that link or talk about file-based import/export and if they need renaming
Details:
-
read_repository
scope is only required when migrating from GitLab source < 15.0 (see: https://docs.gitlab.com/ee/user/group/import/index.html#prerequisites) -
add a note in Congregate (or even better in the export/import docs pointing to PS, that for SaaS one is free to try the beta GitLab migration feature as well, add in Congregate readme link to the migrating groups and projects docs -
usernames in the comments itself don't get converted -
confirming emails is also a requirement for the mapping to work
Questions - should we document in migrating groups doc
-
that we recommend upgrading first, if from SM to SaaS? Comment: "we have it in the version history at: https://docs.gitlab.com/ee/user/group/import/#migrate-groups-by-direct-transfer-recommended, but that might be too subtle? WDYT? Things get messy when we embed lots of version numbers in the docs, but it might be warranted in this case?" -
how to find out what relations would not be migrated if customers decided not to upgrade before migration? (see diffs of project/import_export.yml
andgroup/import_export.yml
) -
Workaround for creating confirmed users on SM - either in bulk in Rails console or creating users one by one by Admin?
Edited by Magdalena Frankiewicz