Skip to content

Commit

Permalink
Update frontmatter and intro info for the migrations API (#27335)
Browse files Browse the repository at this point in the history
  • Loading branch information
skedwards88 authored May 3, 2022
1 parent 5586624 commit 13bc5da
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
11 changes: 7 additions & 4 deletions content/rest/migrations/orgs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Organization
intro: 'The Migrations API is only available to authenticated organization owners.'
title: Organization migrations
allowTitleToDifferFromFilename: true
shortTitle: Organizations
intro: ''
versions:
fpt: '*'
ghec: '*'
Expand All @@ -9,9 +11,10 @@ versions:
topics:
- API
miniTocMaxHeadingLevel: 3
allowTitleToDifferFromFilename: true
---

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)."
## About the Organization migrations API

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)."

{% data variables.migrations.organization_migrations_intro %}
8 changes: 5 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: '{% data variables.migrations.source_imports_intro %}'
title: Source imports
intro: ''
versions:
fpt: '*'
ghec: '*'
Expand All @@ -9,7 +9,9 @@ topics:
miniTocMaxHeadingLevel: 3
---

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.
## About the Source imports API

{% 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:

Expand Down
10 changes: 7 additions & 3 deletions content/rest/migrations/users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Users
intro: 'The Users migrations API is only available to authenticated account owners.'
title: User migrations
allowTitleToDifferFromFilename: true
shortTitle: Users
intro: ''
versions:
fpt: '*'
ghec: '*'
Expand All @@ -11,7 +13,9 @@ topics:
miniTocMaxHeadingLevel: 3
---

For more information, see "[Other authentication methods](/rest/overview/other-authentication-methods)."
## About the User migrations API

The Users migrations API is 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

0 comments on commit 13bc5da

Please sign in to comment.