Unify language in the API docs for codespaces (#33148)

Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
This commit is contained in:
Sarah Edwards 2022-12-09 09:02:04 -08:00 коммит произвёл GitHub
Родитель cb882fa10f
Коммит 2e564703f4
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
7 изменённых файлов: 20 добавлений и 20 удалений

Просмотреть файл

@ -1,6 +1,6 @@
---
title: Codespaces
intro: The Codespaces API enables you to manage your codespaces using the REST API.
intro: 'Use the REST API to manage {% data variables.product.prodname_github_codespaces %}.'
versions:
fpt: '*'
ghec: '*'
@ -9,6 +9,6 @@ topics:
miniTocMaxHeadingLevel: 3
---
## About the Codespaces API
## About {% data variables.product.prodname_github_codespaces %}
The {% data variables.product.prodname_github_codespaces %} API enables you to manage {% data variables.product.prodname_codespaces %} using the REST API. This API is available for authenticated users, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %}. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)."
You can manage {% data variables.product.prodname_codespaces %} using the REST API. These endpoints are available for authenticated users, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %}. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)."

Просмотреть файл

@ -1,6 +1,6 @@
---
title: Codespaces
intro: 'The {% data variables.product.prodname_github_codespaces %} API enables you to manage your codespaces using the REST API.'
intro: 'Use the REST API to manage {% data variables.product.prodname_github_codespaces %}.'
versions:
fpt: '*'
ghec: '*'

Просмотреть файл

@ -2,7 +2,7 @@
title: Codespaces machines
allowTitleToDifferFromFilename: true
shortTitle: Machines
intro: 'The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user.'
intro: 'Use the REST API to manage availability of machine types for a codespace.'
versions:
fpt: '*'
ghec: '*'
@ -11,8 +11,8 @@ topics:
miniTocMaxHeadingLevel: 3
---
## About the Codespaces machines API
## About {% data variables.product.prodname_codespaces %} machines
The Codespaces machines API allows a user to determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
You can determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)."
You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)."

Просмотреть файл

@ -2,7 +2,7 @@
title: Codespaces organization secrets
allowTitleToDifferFromFilename: true
shortTitle: Organization secrets
intro: The Codespaces organizations secrets API enables you to manage your organization-level Codespaces secrets using the REST API.
intro: 'Use the REST API to manage your organization-level {% data variables.product.prodname_codespaces %} secrets.'
versions:
fpt: '*'
ghec: '*'
@ -10,8 +10,9 @@ topics:
- API
miniTocMaxHeadingLevel: 3
---
{% note %}
**Note**: The Codespaces organizations secrets API is currently in public beta and subject to change.
**Note**: These endpoints are currently in public beta and subject to change.
{% endnote %}

Просмотреть файл

@ -2,7 +2,7 @@
title: Codespaces organizations
allowTitleToDifferFromFilename: true
shortTitle: Organizations
intro: The Codespaces organizations API enables you to manage your organization members codespaces using the REST API.
intro: 'Use the REST API to manage your organization members codespaces.'
versions:
fpt: '*'
ghec: '*'
@ -11,10 +11,9 @@ topics:
miniTocMaxHeadingLevel: 3
---
## About the Codespaces organizations API
## About {% data variables.product.prodname_codespaces %} organizations
The {% data variables.product.prodname_codespaces %} organizations API enables
you to manage {% data variables.product.prodname_codespaces %} billed to your
organization using the REST API. This API is available for authenticated
You can manage {% data variables.product.prodname_codespaces %} billed to your
organization. These endpoints are available for authenticated
organization admins and OAuth Apps, but not GitHub Apps. For more information,
see "[{% data variables.product.prodname_codespaces %}](/codespaces)."

Просмотреть файл

@ -2,7 +2,7 @@
title: Codespaces repository secrets
allowTitleToDifferFromFilename: true
shortTitle: Repository secrets
intro: 'The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to in a codespace.'
intro: 'Use the REST API to manage secrets for repositories that the user has access to in a codespace.'
permissions: Users with write access to a repository can manage {% data variables.product.prodname_codespaces %} repository secrets.
versions:
fpt: '*'
@ -12,6 +12,6 @@ topics:
miniTocMaxHeadingLevel: 3
---
## About the Codespaces repository secrets API
## About {% data variables.product.prodname_codespaces %} repository secrets
The Codespaces repository secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
You can create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."

Просмотреть файл

@ -2,7 +2,7 @@
title: Codespaces user secrets
allowTitleToDifferFromFilename: true
shortTitle: User secrets
intro: 'The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to in a codespace.'
intro: 'Use the REST API manage secrets that the user has access to in a codespace.'
versions:
fpt: '*'
ghec: '*'
@ -11,6 +11,6 @@ topics:
miniTocMaxHeadingLevel: 3
---
## About the Codespaces user secrets API
## About {% data variables.product.prodname_codespaces %} user secrets
The Codespaces user secrets API allows a user to create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."
You can create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)."