Merge branch '2021-getting-started-guides' of https://github.com/github/docs-internal into 2021-getting-started-guides
This commit is contained in:
Sarita Iyer
@@ -10,7 +10,7 @@
|
||||
// content model, add the entry to this list, and ensure you loop in the
|
||||
// content and/or content strategy team for review.
|
||||
|
||||
module.exports = [
|
||||
export default [
|
||||
'2FA',
|
||||
'Access management',
|
||||
'Accounts',
|
||||
@@ -155,5 +155,5 @@ module.exports = [
|
||||
'Xamarin.Android',
|
||||
'Xamarin.iOS',
|
||||
'Xamarin',
|
||||
'Xcode'
|
||||
'Xcode',
|
||||
]
|
||||
|
||||
@@ -678,6 +678,9 @@
|
||||
description: >-
|
||||
A log that lists the last 50 actions or those performed within the last 90
|
||||
days.
|
||||
- term: server-to-server request
|
||||
description: >-
|
||||
An API request used by an application that acts as a bot, independently of any particular user. For example, an application that runs on a scheduled basis and closes issues where there has been no activity for a long time. Applications that use this type of authentication don't use a licensed GitHub account so, in an enterprise with a billing plan that allows a certain number of licenses to be used, a server-to-server bot is not consuming one of your GitHub licenses. The token used in a server-to-server request is acquired programmatically, via [the GitHub API](/rest/reference/apps#create-an-installation-access-token-for-an-app). See also, "[user-to-server request](#user-to-server-request)."
|
||||
- term: service hook
|
||||
description: >-
|
||||
Also called "webhook." Webhooks provide a way for notifications to be
|
||||
@@ -764,6 +767,9 @@
|
||||
invited to join organizations or collaborate on another user's repository.
|
||||
- term: username
|
||||
description: A user's handle on GitHub.
|
||||
- term: user-to-server request
|
||||
description: >-
|
||||
An API request used by an application that performs a task on behalf of a particular user. Where a task is carried out with user-to-server authentication it's shown on GitHub as having been done by a user via an application. For example, you might choose to create an issue from within a third-party application, and the application would do this on your behalf on GitHub. The scope of tasks an application can perform using a user-to-server request is restricted by both the app's and the user's permissions and access. The token used in a user-to-server request is acquired via OAuth. For more information, see "[Identifying and authorizing users for GitHub Apps](/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps)." See also, "[server-to-server request](#server-to-server-request)."
|
||||
- term: visible team
|
||||
description: A team that can be viewed and @mentioned by every organization member.
|
||||
- term: watch
|
||||
|
||||
1
data/package.json
Normal file
1
data/package.json
Normal file
@@ -0,0 +1 @@
|
||||
{"type":"module"}
|
||||
@@ -6,7 +6,7 @@ sections:
|
||||
bugs:
|
||||
- '`ghe-cluster-config-node-init` would fail during cluster setup if HTTP proxy is enabled.'
|
||||
- Collectd would not resolve the forwarding destination hostname after the initial startup.
|
||||
- The job that purged stale archived repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- The job that purged stale deleted repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- Git pushes could result in a 500 Internal Server Error during the user reconciliation process on instances using LDAP authentication mode.
|
||||
- A significant number of 503 errors were logged every time a user visited a repository's `/settings` page if the dependency graph was not enabled.
|
||||
changes:
|
||||
|
||||
@@ -9,7 +9,7 @@ sections:
|
||||
- '`ghe-cluster-config-node-init` would fail during cluster setup if HTTP proxy is enabled.'
|
||||
- Pre-receive hooks could encounter an error `Failed to resolve full path of the current executable` due to `/proc` not being mounted on the container.
|
||||
- Collectd would not resolve the forwarding destination hostname after the initial startup.
|
||||
- The job that purged stale archived repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- The job that purged stale deleted repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- Running `git nw-gc --pristine` would result in an error.
|
||||
- Background jobs were being queued to the `spam` queue which were not being processed.
|
||||
- The preferred merge method would be reset when retrying after a failed PR merge.
|
||||
|
||||
@@ -9,7 +9,7 @@ sections:
|
||||
- '`ghe-cluster-config-node-init` would fail during cluster setup if HTTP proxy is enabled.'
|
||||
- Pre-receive hooks could encounter an error `Failed to resolve full path of the current executable` due to `/proc` not being mounted on the container.
|
||||
- Collectd would not resolve the forwarding destination hostname after the initial startup.
|
||||
- The job that purged stale archived repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- The job that purged stale deleted repositories could fail to make progress if some of those repositories were protected from deletion by legal holds.
|
||||
- Background jobs were being queued to the `spam` queue which were not being processed.
|
||||
- The preferred merge method would be reset when retrying after a failed PR merge.
|
||||
- Git pushes could result in a 500 Internal Server Error during the user reconciliation process on instances using LDAP authentication mode.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
By default, the artifacts and log files generated by workflows are retained for 90 days before they are automatically deleted. You can adjust the retention period, depending on the type of repository:
|
||||
|
||||
- For public repositories: you can change this retention period to anywhere between 1 day or 90 days.
|
||||
- For private, internal, and {% data variables.product.prodname_enterprise %} repositories: you can change this retention period to anywhere between 1 day or 400 days.
|
||||
- For private, internal, and {% data variables.product.prodname_ghe_server %} repositories: you can change this retention period to anywhere between 1 day or 400 days.
|
||||
|
||||
When you customize the retention period, it only applies to new artifacts and log files, and does not retroactively apply to existing objects. For managed repositories and organizations, the maximum retention period cannot exceed the limit set by the managing organization or enterprise.
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.prodname_github_app %}s must have the `actions` permission to use this API.
|
||||
{% data variables.product.prodname_github_apps %} must have the `actions` permission to use this API.
|
||||
|
||||
@@ -1 +1 @@
|
||||
This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_github_app %}s. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for {% ifversion ghae %} for internal repos that are available to everyone on the enterprise.{% else %}public repos.{% endif %}
|
||||
This API is available for authenticated users, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %}. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for {% ifversion ghae %} for internal repos that are available to everyone on the enterprise.{% else %}public repos.{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.prodname_github_app %}s making server-to-server requests use the installation's minimum rate limit of 5,000 requests per hour. Organization installations with more than 20 users receive another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour.
|
||||
{% data variables.product.prodname_github_apps %} making server-to-server requests use the installation's minimum rate limit of 5,000 requests per hour. Organization installations with more than 20 users receive another 50 requests per hour for each user. Installations that have more than 20 repositories receive another 50 requests per hour for each repository. The maximum rate limit for an installation is 12,500 requests per hour.
|
||||
|
||||
@@ -1 +1 @@
|
||||
Discussions are an open forum for conversation among maintainers and the community for a project on {% data variables.product.product_name %}.
|
||||
{% data variables.product.prodname_discussions %} is an open forum for conversation among maintainers and the community for a project on {% data variables.product.product_name %}.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
You can enable or disable discussions for a repository.
|
||||
You can enable or disable {% data variables.product.prodname_discussions %} for a repository.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
1. Under your repository name, click {% octicon "gear" aria-label="The gear icon" %}
|
||||
**Settings**.
|
||||
|
||||
1. Under "Features", select **Discussions**.
|
||||
|
||||
|
||||
|
||||
@@ -1 +1 @@
|
||||
You can use discussions to ask and answer questions, share information, make announcements, and conduct or participate in conversations about a project. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
You can use {% data variables.product.prodname_discussions %} to ask and answer questions, share information, make announcements, and conduct or participate in conversations about a project. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
|
||||
@@ -4,6 +4,6 @@
|
||||
```
|
||||
{% warning %}
|
||||
|
||||
**Warning:** `ghe-repl-start` causes a brief outage on the primary server, during which users may see internal server errors. To provide a friendlier message, run `ghe-maintenance -s` on the primary node before running `ghe-repl-start` on the replica node to put the appliance in maintenance mode. Once replication starts, disable maintenance mode with `ghe-maintenance -u`.
|
||||
**Warning:** `ghe-repl-start` causes a brief outage on the primary server, during which users may see internal server errors. To provide a friendlier message, run `ghe-maintenance -s` on the primary node before running `ghe-repl-start` on the replica node to put the appliance in maintenance mode. Once replication starts, disable maintenance mode with `ghe-maintenance -u`. Git replication will not progress while the primary node is in maintenance mode.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. In the left sidebar, click **{% data variables.product.prodname_github_app %}s**.
|
||||
|
||||
1. In the left sidebar, click **{% data variables.product.prodname_github_apps %}**.
|
||||
|
||||
|
||||
@@ -33,7 +33,7 @@ jobs:
|
||||
id: meta
|
||||
uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
|
||||
with:
|
||||
images: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}{% raw %}
|
||||
images: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}{% endraw %}
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
|
||||
|
||||
@@ -1,2 +1,3 @@
|
||||
1. Type a name for your repository and an optional description. If you're creating a user or organization site, your repository must be named `<user>.github.io` or `<organization>.github.io`. For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#types-of-github-pages-sites)."
|
||||
1. Type a name for your repository and an optional description. If you're creating a user or organization site, your repository must be named `<user>.github.io` or `<organization>.github.io`. If your user or organization name contains uppercase letters, you must lowercase the letters.
|
||||
For more information, see "[About {% data variables.product.prodname_pages %}](/articles/about-github-pages#types-of-github-pages-sites)."
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
{% ifversion fpt %}
|
||||
1. Optionally, if the personal account or organization in which you're creating uses any {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}, select any apps you'd like to use in the repository.
|
||||
|
||||
1. Optionally, if the personal account or organization in which you're creating uses any {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %}, select any apps you'd like to use in the repository.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
Enterprise owners can enable SAML SSO and centralized authentication through a SAML IdP across all organizations owned by an enterprise account. After you enable SAML SSO for your enterprise account, SAML SSO is enabled by default for all organizations owned by your enterprise account. All members will be required to authenticate using SAML SSO to gain access to the organizations where they are a member, and enterprise owners will be required to authenticate using SAML SSO when accessing an enterprise account.
|
||||
Enterprise owners can enable SAML SSO and centralized authentication through a SAML IdP across all organizations owned by an enterprise account. After you enable SAML SSO for your enterprise account, SAML SSO is enforced for all organizations owned by your enterprise account. All members will be required to authenticate using SAML SSO to gain access to the organizations where they are a member, and enterprise owners will be required to authenticate using SAML SSO when accessing an enterprise account.
|
||||
|
||||
@@ -74,6 +74,10 @@ Facebook | Facebook Access Token | facebook_access_token{% endif %}
|
||||
Fastly | Fastly API Token | fastly_api_token{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Finicity | Finicity App Key | finicity_app_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Flutterwave | Flutterwave Live API Secret Key | flutterwave_live_api_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
Flutterwave | Flutterwave Test API Secret Key | flutterwave_test_api_secret_key{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
Frame.io | Frame.io JSON Web Token | frameio_jwt{% endif %}
|
||||
{%- ifversion fpt or ghes > 2.22 or ghae-next %}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
For questions, bug reports, and discussions about {% data variables.product.prodname_github_app %}s, {% data variables.product.prodname_oauth_app %}s, and API development, explore the {% data variables.product.prodname_support_forum_with_url %}. The forum is moderated and maintained by {% data variables.product.company_short %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.company_short %} staff.
|
||||
For questions, bug reports, and discussions about {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and API development, explore the {% data variables.product.prodname_support_forum_with_url %}. The forum is moderated and maintained by {% data variables.product.company_short %} staff, but questions posted to the forum are not guaranteed to receive a reply from {% data variables.product.company_short %} staff.
|
||||
|
||||
Consider reaching out to [GitHub Support](https://github.com/contact) directly using the contact form for:
|
||||
- guaranteed response from {% data variables.product.product_name %} staff
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
1. Review the tokens that have access to your account. For those that you don't recognize or that are out-of-date, click **{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}**, then click **Revoke**. To revoke all tokens, click **Revoke all**.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user