Skip to content

Commit

Permalink
Unify API terminology around 'REST API' for Migrations content (#33672)
Browse files Browse the repository at this point in the history
  • Loading branch information
subatoi authored Jan 3, 2023
1 parent 1d3dcc4 commit 3bd0823
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion content/rest/migrations/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Migrations
intro: 'The Migration API lets you migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.'
intro: 'Use the REST API to migrate the repositories and users of your organization from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.'
redirect_from:
- /v3/migrations
- /v3/migration
Expand Down
6 changes: 3 additions & 3 deletions content/rest/migrations/orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Organization migrations
allowTitleToDifferFromFilename: true
shortTitle: Organizations
intro: ''
intro: 'Use the REST API to move a repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}.'
versions:
fpt: '*'
ghec: '*'
Expand All @@ -13,8 +13,8 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the Organization migrations API
## About organization migrations

The Migrations API is only available to authenticated organization owners. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)."
These endpoints are only available to authenticated organization owners. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)."

{% data variables.migrations.organization_migrations_intro %}
6 changes: 3 additions & 3 deletions content/rest/migrations/source-imports.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Source imports
intro: ''
intro: 'Use the REST API to start an import from a Git, Subversion, Mercurial, or Team Foundation Version Control source repository.'
versions:
fpt: '*'
ghec: '*'
Expand All @@ -9,13 +9,13 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the Source imports API
## About source imports

{% data reusables.user-settings.imports-api-classic-pat-only %}

{% data variables.migrations.source_imports_intro %} A typical source import would start the import and then (optionally) update the authors and/or update the preference for using Git LFS if large files exist in the import. You can also create a webhook that listens for the [`RepositoryImportEvent`](/developers/webhooks-and-events/webhook-events-and-payloads#repository_import) to find out the status of the import.

A more detailed example can be seen in this diagram:
The following diagram provides a more detailed example:

```
+---------+ +--------+ +---------------------+
Expand Down
6 changes: 3 additions & 3 deletions content/rest/migrations/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: User migrations
allowTitleToDifferFromFilename: true
shortTitle: Users
intro: ''
intro: 'Use the REST API to review, backup, or migrate your user data stored on {% data variables.product.product_name %}.com.'
versions:
fpt: '*'
ghec: '*'
Expand All @@ -13,9 +13,9 @@ topics:
miniTocMaxHeadingLevel: 3
---

## About the User migrations API
## About user migrations

The Users migrations API is only available to authenticated account owners. For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)."
These endpoints are only available to authenticated account owners. For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)".

{% data variables.migrations.user_migrations_intro %} For a list of migration data that you can download, see "[Download a user migration archive](#download-a-user-migration-archive)."

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% ifversion pat-v2 %}
{% note %}

The REST API for source imports only supports authentication using a {% data variables.product.pat_v1 %}. For more information, see "[Creating a {% data variables.product.pat_generic %} ](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
These endpoints only support authentication using a {% data variables.product.pat_v1 %}. For more information, see "[Creating a {% data variables.product.pat_generic %} ](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."

{% endnote %}
{% endif %}
6 changes: 3 additions & 3 deletions data/variables/migrations.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
user_migrations_intro: >-
You can use this API to review, backup, or migrate your user data stored on {% data variables.product.product_name %}.com.
You can use these endpoints to review, backup, or migrate your user data stored on {% data variables.product.product_name %}.com.
organization_migrations_intro: >-
The organization migrations API lets you move a repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}. For more information, see "[Exporting migration data from GitHub.com](/enterprise-server@latest/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom)" in the {% data variables.product.prodname_ghe_server %} documentation.
You can use these endpoints to move a repository from {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.prodname_ghe_server %}. For more information, see "[Exporting migration data from GitHub.com](/enterprise-server@latest/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom)" in the {% data variables.product.prodname_ghe_server %} documentation.
source_imports_intro: >-
The Source Import API lets you start an import from a Git, Subversion,
You can use these endpoints to start an import from a Git, Subversion,
Mercurial, or Team Foundation Version Control source repository. This is the same
functionality as the {% data variables.product.prodname_dotcom %}
Importer. For more information, see "[Importing a repository with {% data variables.product.prodname_dotcom %} Importer](/github/importing-your-projects-to-github/importing-a-repository-with-github-importer)."

0 comments on commit 3bd0823

Please sign in to comment.