Branch was updated using the 'autoupdate branch' Actions workflow.
This commit is contained in:
Octomerger Bot
@@ -2,7 +2,7 @@
|
||||
|
||||
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [docs.github.com](https://docs.github.com/en) :sparkles:.
|
||||
|
||||
Read our [Code of Coduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
|
||||
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
|
||||
|
||||
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
|
||||
|
||||
@@ -10,7 +10,7 @@ Use the table of contents icon <img src="./assets/images/table-of-contents.png"
|
||||
|
||||
## New contributor guide
|
||||
|
||||
See the [README](README.md) to get an overview of the project. Here are some helpful resources to get you comfortable with open source contribution:
|
||||
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
|
||||
|
||||
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
|
||||
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
|
||||
@@ -20,9 +20,9 @@ See the [README](README.md) to get an overview of the project. Here are some hel
|
||||
|
||||
## Getting started
|
||||
|
||||
See [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) to navigate our codebase with confidence :confetti_ball:. See [the GitHub Markdown reference](contributing/content-markup-reference.md) for information on how we write our markdown files.
|
||||
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/working-in-docs-repository.md) :confetti_ball:. For more information on how we write our markdown files, see [the GitHub Markdown reference](contributing/content-markup-reference.md).
|
||||
|
||||
Before making changes, see what [types of contributions](/contributing/types-of-contributions.md) we accept. Some of them don't require writing even a single line of code :sparkles:.
|
||||
Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
|
||||
|
||||
### Issues
|
||||
|
||||
@@ -63,14 +63,14 @@ Click **Make a contribution** at the bottom of any docs page to make small chang
|
||||
|
||||
### Commit your update
|
||||
|
||||
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji's for commit messages.
|
||||
Commit the changes once you are happy with them. See [Atom's contributing guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) to know how to use emoji for commit messages.
|
||||
|
||||
Once you are ready with your changes, don't forget to [self review](/contributing/self-review.md) to quicken the review process :zap:.
|
||||
Once your changes are ready, don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
|
||||
|
||||
### Pull Request
|
||||
|
||||
When you're done making the changes, open a pull request, often referred to as a PR.
|
||||
- Fill out the "Ready for review" template so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
|
||||
When you're finished with the changes, create a pull request, also known as a PR.
|
||||
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
|
||||
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
|
||||
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
|
||||
Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 82 KiB |
@@ -76,3 +76,7 @@ You can check which access policies are applied to a secret in your organization
|
||||
1. The list of secrets includes any configured permissions and policies. For example:
|
||||
|
||||
1. For more details on the configured permissions for each secret, click **Update**.
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)"
|
||||
|
||||
@@ -28,3 +28,7 @@ To manage which users in your organization can use {% data variables.product.pro
|
||||
|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories.
|
||||
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Managing repository access for your codespaces](/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)"
|
||||
|
||||
@@ -19,3 +19,7 @@ When any member of your organization performs an action related to {% data varia
|
||||
|
||||
|
||||
The audit log includes details such as who performed the action, what the action was, and when the action was performed. For information on {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#codespaces-category-actions)."
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Reviewing your security logs for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-codespaces)"
|
||||
|
||||
@@ -80,3 +80,7 @@ You can update the value of an existing secret, and you can change which reposit
|
||||
|
||||
1. Read the warning, then click **OK**.
|
||||
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Managing encrypted secrets for your repository and organization for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)"
|
||||
|
||||
@@ -22,3 +22,7 @@ When you enable access and security for a repository owned by your user account,
|
||||
|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own.
|
||||
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces)"
|
||||
|
||||
@@ -20,3 +20,7 @@ When you perform an action related to {% data variables.product.prodname_codespa
|
||||
|
||||
|
||||
The security log includes details on what action occurred and when you performed it. For information about {% data variables.product.prodname_codespaces %} actions, see "[{% data variables.product.prodname_codespaces %} category actions](/github/authenticating-to-github/reviewing-your-security-log#codespaces-category-actions)".
|
||||
|
||||
## Further Reading
|
||||
|
||||
- "[Reviewing your organization's audit logs for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces)"
|
||||
|
||||
@@ -77,20 +77,29 @@ Name | Type | Description
|
||||
|
||||
By default, the response takes the following form:
|
||||
|
||||
access_token={% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&token_type=bearer
|
||||
```
|
||||
access_token={% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&scope=repo%2Cgist&token_type=bearer
|
||||
```
|
||||
|
||||
You can also receive the content in different formats depending on the Accept
|
||||
header:
|
||||
{% data reusables.apps.oauth-auth-vary-response %}
|
||||
|
||||
Accept: application/json
|
||||
{"access_token":"{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}", "scope":"repo,gist", "token_type":"bearer"}
|
||||
```json
|
||||
Accept: application/json
|
||||
{
|
||||
"access_token":"{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}",
|
||||
"scope":"repo,gist",
|
||||
"token_type":"bearer"
|
||||
}
|
||||
```
|
||||
|
||||
Accept: application/xml
|
||||
<OAuth>
|
||||
<token_type>bearer</token_type>
|
||||
<scope>repo,gist</scope>
|
||||
<access_token>{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}</access_token>
|
||||
</OAuth>
|
||||
```xml
|
||||
Accept: application/xml
|
||||
<OAuth>
|
||||
<token_type>bearer</token_type>
|
||||
<scope>repo,gist</scope>
|
||||
<access_token>{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}</access_token>
|
||||
</OAuth>
|
||||
```
|
||||
|
||||
### 3. Use the access token to access the API
|
||||
|
||||
@@ -138,27 +147,35 @@ Name | Type | Description
|
||||
|
||||
#### Response
|
||||
|
||||
{% ifversion fpt %}
|
||||
```JSON
|
||||
{
|
||||
"device_code": "3584d83530557fdd1f46af8289938c8ef79f9dc5",
|
||||
"user_code": "WDJB-MJHT",
|
||||
"verification_uri": "https://github.com/login/device",
|
||||
"expires_in": 900,
|
||||
"interval": 5
|
||||
}
|
||||
```
|
||||
{% else %}
|
||||
```JSON
|
||||
{
|
||||
"device_code": "3584d83530557fdd1f46af8289938c8ef79f9dc5",
|
||||
"user_code": "WDJB-MJHT",
|
||||
"verification_uri": "http(s)://[hostname]/login/device",
|
||||
"expires_in": 900,
|
||||
"interval": 5
|
||||
}
|
||||
```
|
||||
{% endif %}
|
||||
By default, the response takes the following form:
|
||||
|
||||
```
|
||||
device_code=3584d83530557fdd1f46af8289938c8ef79f9dc5&expires_in=900&interval=5&user_code=WDJB-MJHT&verification_uri=https%3A%2F%{% data variables.product.product_url %}%2Flogin%2Fdevice
|
||||
```
|
||||
|
||||
{% data reusables.apps.oauth-auth-vary-response %}
|
||||
|
||||
```json
|
||||
Accept: application/json
|
||||
{
|
||||
"device_code": "3584d83530557fdd1f46af8289938c8ef79f9dc5",
|
||||
"user_code": "WDJB-MJHT",
|
||||
"verification_uri": "{% data variables.product.oauth_host_code %}/login/device",
|
||||
"expires_in": 900,
|
||||
"interval": 5
|
||||
}
|
||||
```
|
||||
|
||||
```xml
|
||||
Accept: application/xml
|
||||
<OAuth>
|
||||
<device_code>3584d83530557fdd1f46af8289938c8ef79f9dc5</device_code>
|
||||
<user_code>WDJB-MJHT</user_code>
|
||||
<verification_uri>{% data variables.product.oauth_host_code %}/login/device</verification_uri>
|
||||
<expires_in>900</expires_in>
|
||||
<interval>5</interval>
|
||||
</OAuth>
|
||||
```
|
||||
|
||||
#### Response parameters
|
||||
|
||||
@@ -196,14 +213,32 @@ Name | Type | Description
|
||||
|
||||
#### Response
|
||||
|
||||
By default, the response takes the following form:
|
||||
|
||||
```
|
||||
access_token={% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}&token_type=bearer&scope=repo%2Cgist
|
||||
```
|
||||
|
||||
{% data reusables.apps.oauth-auth-vary-response %}
|
||||
|
||||
```json
|
||||
Accept: application/json
|
||||
{
|
||||
"access_token": "{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}",
|
||||
"token_type": "bearer",
|
||||
"scope": "user"
|
||||
"scope": "repo,gist"
|
||||
}
|
||||
```
|
||||
|
||||
```xml
|
||||
Accept: application/xml
|
||||
<OAuth>
|
||||
<access_token>{% ifversion fpt or ghes > 3.1 or ghae-next %}gho_16C7e42F292c6912E7710c838347Ae178B4a{% else %}e72e16c7e42f292c6912e7710c838347ae178b4a{% endif %}</access_token>
|
||||
<token_type>bearer</token_type>
|
||||
<scope>gist,repo</scope>
|
||||
</OAuth>
|
||||
```
|
||||
|
||||
### Rate limits for the device flow
|
||||
|
||||
When a user submits the verification code on the browser, there is a rate limit of 50 submissions in an hour per application.
|
||||
|
||||
@@ -60,6 +60,7 @@ shortTitle: Associate text editors
|
||||
## Using Atom as your editor
|
||||
|
||||
1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "atom --wait"
|
||||
|
||||
@@ -23,16 +23,7 @@ If your enterprise is uses {% data variables.product.prodname_emus %}, your memb
|
||||
|
||||
{% data reusables.saml.about-linked-identities %}
|
||||
|
||||
If your enterprise is uses {% data variables.product.prodname_emus %}, you will not be able to deprovision or remove user accounts from the enterprise on {% data variables.product.product_name %}. Any changes you need to make to your enterprise's {% data variables.product.prodname_managed_users %} should be made through your IdP.
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** For organizations using SCIM:
|
||||
- Revoking a linked user identity on {% data variables.product.product_name %} will also remove the SAML and SCIM metadata. As a result, the identity provider will not be able to synchronize or deprovision the linked user identity.
|
||||
- An admin must revoke a linked identity through the identity provider.
|
||||
- To revoke a linked identity and link a different account through the identity provider, an admin can remove and re-assign the user to the {% data variables.product.product_name %} application. For more information, see your identity provider's docs.
|
||||
|
||||
{% endwarning %}
|
||||
If your enterprise uses {% data variables.product.prodname_emus %}, you will not be able to deprovision or remove user accounts from the enterprise on {% data variables.product.product_name %}. Any changes you need to make to your enterprise's {% data variables.product.prodname_managed_users %} should be made through your IdP.
|
||||
|
||||
{% data reusables.identity-and-permissions.revoking-identity-team-sync %}
|
||||
|
||||
|
||||
@@ -23,7 +23,19 @@ You can view and revoke each member's linked identity, active sessions, and auth
|
||||
|
||||
## Viewing and revoking a linked identity
|
||||
|
||||
{% data reusables.saml.about-linked-identities %}
|
||||
{% data reusables.saml.about-linked-identities %}
|
||||
|
||||
When available, the entry will include SCIM data. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)."
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** For organizations using SCIM:
|
||||
- Revoking a linked user identity on {% data variables.product.product_name %} will also remove the SAML and SCIM metadata. As a result, the identity provider will not be able to synchronize or deprovision the linked user identity.
|
||||
- An admin must revoke a linked identity through the identity provider.
|
||||
- To revoke a linked identity and link a different account through the identity provider, an admin can remove and re-assign the user to the {% data variables.product.product_name %} application. For more information, see your identity provider's documentation.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
||||
{% data reusables.identity-and-permissions.revoking-identity-team-sync %}
|
||||
|
||||
|
||||
@@ -49,6 +49,8 @@ To search for specific events, use the `action` qualifier in your query. Actions
|
||||
| [`enterprise`](#enterprise-category-actions) | Contains activities related to enterprise settings. | {% endif %}
|
||||
| [`hook`](#hook-category-actions) | Contains all activities related to webhooks.
|
||||
| [`integration_installation_request`](#integration_installation_request-category-actions) | Contains all activities related to organization member requests for owners to approve integrations for use in the organization. |
|
||||
| [`ip_allow_list`](#ip_allow_list) | Contains activitites related to enabling or disabling the IP allow list for an organization.
|
||||
| [`ip_allow_list_entry`](#ip_allow_list_entry) | Contains activities related to the creation, deletion, and editing of an IP allow list entry for an organization.
|
||||
| [`issue`](#issue-category-actions) | Contains activities related to deleting an issue. {% ifversion fpt %}
|
||||
| [`marketplace_agreement_signature`](#marketplace_agreement_signature-category-actions) | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
| [`marketplace_listing`](#marketplace_listing-category-actions) | Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% ifversion fpt or ghes > 3.0 %}
|
||||
@@ -335,6 +337,23 @@ An overview of some of the most common actions that are recorded as events in th
|
||||
| `create` | Triggered when an organization member requests that an organization owner install an integration for use in the organization.
|
||||
| `close` | Triggered when a request to install an integration for use in an organization is either approved or denied by an organization owner, or canceled by the organization member who opened the request.
|
||||
|
||||
### `ip_allow_list` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `enable` | Triggered when an IP allow list was enabled for an organization.
|
||||
| `disable` | Triggered when an IP allow list was disabled for an organization.
|
||||
| `enable_for_installed_apps` | Triggered when an IP allow list was enabled for installed {% data variables.product.prodname_github_apps %}.
|
||||
| `disable_for_installed_apps` | Triggered when an IP allow list was disabled for installed {% data variables.product.prodname_github_apps %}.
|
||||
|
||||
### `ip_allow_list_entry` category actions
|
||||
|
||||
| Action | Description
|
||||
|------------------|-------------------
|
||||
| `create` | Triggered when an IP address was added to an IP allow list.
|
||||
| `update` | Triggered when an IP address or its description was changed.
|
||||
| `destroy` | Triggered when an IP address was deleted from an IP allow list.
|
||||
|
||||
### `issue` category actions
|
||||
|
||||
| Action | Description
|
||||
|
||||
@@ -35,7 +35,7 @@ When you clone a repository or wiki, only Git data, such as project files and co
|
||||
- [Projects](/rest/reference/projects#list-repository-projects)
|
||||
{% endif %}
|
||||
|
||||
Once you have {% ifversion ghes or ghae %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup service such as [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
|
||||
Once you have {% ifversion ghes or ghae %}a local version of all the content you want to back up, you can create a zip archive and {% else %}downloaded your archive, you can {% endif %}copy it to an external hard drive and/or upload it to a cloud-based backup or storage service such as [Azure Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-overview/), [Google Drive](https://www.google.com/drive/) or [Dropbox](https://www.dropbox.com/).
|
||||
|
||||
{% ifversion fpt %}
|
||||
## Third-party backup tools
|
||||
|
||||
1
data/reusables/apps/oauth-auth-vary-response.md
Normal file
1
data/reusables/apps/oauth-auth-vary-response.md
Normal file
@@ -0,0 +1 @@
|
||||
You can also receive the response in different formats if you provide the format in the `Accept` header. For example, `Accept: application/json` or `Accept: application/xml`:
|
||||
@@ -1,3 +1,3 @@
|
||||
You can view the single sign-on identity that a member has linked to their {% data variables.product.product_name %} account. When available, the entry will include SCIM data. For more information, see "[About SCIM](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim)."
|
||||
You can view the single sign-on identity that a member has linked to their {% data variables.product.product_name %} account.
|
||||
|
||||
If a member links the wrong identity to their {% data variables.product.product_name %} account, you can revoke the linked identity to allow the member to try again.
|
||||
|
||||
Reference in New Issue
Block a user