зеркало из https://github.com/github/docs.git
Spelling fixes for various typos (#30890)
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
This commit is contained in:
Josh Soref
GitHub
Родитель
f46562a87b
Коммит
d90a746e7e
|
|
@ -20,7 +20,7 @@ To get an overview of the project, read the [README](README.md) file. Here are s
|
|||
|
||||
## Getting started
|
||||
|
||||
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Makrdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs).
|
||||
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs).
|
||||
|
||||
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:.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
name: Set up local Elasticsearch
|
||||
|
||||
description: Install a local Elasticseach with version that matches prod
|
||||
description: Install a local Elasticsearch with version that matches prod
|
||||
|
||||
inputs:
|
||||
token:
|
||||
|
|
|
|||
|
|
@ -75,7 +75,7 @@ Use a wait timer to delay a job for a specific amount of time after the job is i
|
|||
Use deployment branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} to restrict which branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} can deploy to the environment. Below are the options for deployment branches{% ifversion deployment-protections-tag-patterns %} and tags{% endif %} for an environment:
|
||||
|
||||
{% ifversion deployment-protections-tag-patterns %}
|
||||
- **No restriction**: No restriction on which branch or tag can deploy to the enviornment.
|
||||
- **No restriction**: No restriction on which branch or tag can deploy to the environment.
|
||||
{%- else %}
|
||||
- **All branches**: All branches in the repository can deploy to the environment.
|
||||
{%- endif %}
|
||||
|
|
|
|||
|
|
@ -284,7 +284,7 @@ The following table shows the type of properties that {% data variables.product.
|
|||
| `caches` | `actions/cache` | Supported |
|
||||
| `clone` | `actions/checkout` | Supported |
|
||||
| `condition` | `job.<job_id>.steps[*].run` | Supported |
|
||||
| `deployment` | `jobs.<job_id>.environmen` | Supported |
|
||||
| `deployment` | `jobs.<job_id>.environment` | Supported |
|
||||
| `image` | `jobs.<job_id>.container` | Supported |
|
||||
| `max-time` | `jobs.<job_id>.steps[*].timeout-minutes` | Supported |
|
||||
| `options.docker` | None | Supported |
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Administering your instance using the GitHub CLI
|
||||
intro: 'You can adminster your GitHub Enterprise Server instance using the GitHub CLI extension for GHES Manage API.'
|
||||
intro: 'You can administer your GitHub Enterprise Server instance using the GitHub CLI extension for GHES Manage API.'
|
||||
versions:
|
||||
feature: ghes-manage-api-cli-extension
|
||||
type: how_to
|
||||
|
|
|
|||
|
|
@ -973,7 +973,7 @@ This utility starts {% data variables.product.prodname_actions %} on {% data var
|
|||
|
||||
{% endnote %}
|
||||
|
||||
If your system is configured correctly, you'll see the following ouput:
|
||||
If your system is configured correctly, you'll see the following output:
|
||||
|
||||
```shell
|
||||
Actions was enabled!
|
||||
|
|
|
|||
|
|
@ -169,7 +169,7 @@ You will use a script to automate configuring your Azure resources.
|
|||
|
||||
You can use the following GraphQL query to retrieve your enterprise `databaseId`. You will use the enterprise `databaseId` for the value of the `DATABASE_ID` environment variable in the next step. For more information on working with GraphQL, see "[AUTOTITLE](/graphql/guides/forming-calls-with-graphql)."
|
||||
|
||||
{% data reusables.enterprise_migrations.retreive-enterprise-id-graphql %}
|
||||
{% data reusables.enterprise_migrations.retrieve-enterprise-id-graphql %}
|
||||
|
||||
```graphql
|
||||
query(
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ After creating your {% data variables.product.pat_generic %} and storing it secu
|
|||
|
||||
### Configuring provisioning if you use a partner IdP
|
||||
|
||||
To use a partner IdP's application both authentication and provisioning, review the parner's instructions for configuring provisioning in the links in the following table. {% else %} For instructions about the configuration of provisioning on your IdP, click a link in the following table.
|
||||
To use a partner IdP's application both authentication and provisioning, review the partner's instructions for configuring provisioning in the links in the following table. {% else %} For instructions about the configuration of provisioning on your IdP, click a link in the following table.
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ If {% data variables.product.prodname_dotcom %} is unable to synchronize team me
|
|||
1. In the list of IdP groups, click the group you'd like to review.
|
||||
1. To review the synchronization error for the group, under the name of the group, click **Teams**.
|
||||
|
||||
|
||||
|
||||
|
||||
If a team is unable to sync membership with a group on your IdP, you'll see a description of the problem under the team's name and membership count.
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ Before suspending site administrators, you must demote them to regular users. Fo
|
|||
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
1. In the left sidebar, click **Suspended users**.
|
||||
1. A list of suspened users displays.
|
||||
1. A list of suspended users displays.
|
||||
|
||||
## Suspending a user from the site admin dashboard
|
||||
|
||||
|
|
|
|||
|
|
@ -193,7 +193,7 @@ You can view a list of all dormant users {% ifversion ghes or ghae %} who have n
|
|||
|
||||
## Filtering by member type{% ifversion ghec %} in an {% data variables.enterprise.prodname_emu_enterprise %}{% endif %}
|
||||
|
||||
{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% elsif ghes or ghae %}You{% endif %} can filter the member list of an organization by type to determine if memberships are managed through an IdP or managed directly. Memberships managed through an IdP were added through an IdP group, and the IdP group was connected to a team within the organization. Memberships managed directly were added to the organization manually. The way a membership is mananaged in an organization determines how it must be removed. You can use this filter to determine how members were added to an organization, so you know how to remove them.{% ifversion ghec %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#about-organization-membership-management)."{% endif %}
|
||||
{% ifversion ghec %}If your enterprise uses {% data variables.product.prodname_emus %}, you{% elsif ghes or ghae %}You{% endif %} can filter the member list of an organization by type to determine if memberships are managed through an IdP or managed directly. Memberships managed through an IdP were added through an IdP group, and the IdP group was connected to a team within the organization. Memberships managed directly were added to the organization manually. The way a membership is managed in an organization determines how it must be removed. You can use this filter to determine how members were added to an organization, so you know how to remove them.{% ifversion ghec %} For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#about-organization-membership-management)."{% endif %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
1. Under "Organizations", in the search bar, begin typing the organization's name until it appears in the search results.
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@ CM | `packages_stats.ecosystems.ruby_gems.registry_enabled` | Whether Rubygems i
|
|||
CN | `packages_stats.ecosystems.ruby_gems.published_packages_count` | Number of published Rubygems packages (private, public, and internal)
|
||||
CO | `packages_stats.ecosystems.ruby_gems.private_packages_count` | Number of private Rubygems packages
|
||||
CP | `packages_stats.ecosystems.ruby_gems.public_packages_count` | Number of public Rubygems packages
|
||||
CQ | `packages_stats.ecosystems.ruby_gems.internal_packages_count` | Number of internal Rubygems packaes
|
||||
CQ | `packages_stats.ecosystems.ruby_gems.internal_packages_count` | Number of internal Rubygems packages
|
||||
CR | `packages_stats.ecosystems.ruby_gems.user_packages_count` | Number of Rubygems packages owned by user accounts
|
||||
CS | `packages_stats.ecosystems.ruby_gems.organization_packages_count` | Number of Rubygems packages owned by organizations
|
||||
CT | `packages_stats.ecosystems.ruby_gems.daily_download_count` | Number of downloads of Rubygems packages
|
||||
|
|
|
|||
|
|
@ -269,7 +269,7 @@ To get a list of IP address ranges that {% data variables.product.prodname_dotco
|
|||
|
||||
- The port on which the application accepts data.<br>
|
||||
|
||||
If you're using Splunk Cloud and haven't changed the port configration, `Port` should be `443`.
|
||||
If you're using Splunk Cloud and haven't changed the port configuration, `Port` should be `443`.
|
||||
|
||||
If you're using the free trial version of Splunk Cloud, `Port` should be `8088`.
|
||||
|
||||
|
|
|
|||
|
|
@ -295,7 +295,7 @@ The unauthenticated git protocol on port 9418 is no longer supported.
|
|||
|
||||
{% ifversion ghes %}
|
||||
|
||||
If you wish to support the unathenticated Git protocol in your environment, you must manually re-enable the feature. Run the following commands after your upgrade:
|
||||
If you wish to support the unauthenticated Git protocol in your environment, you must manually re-enable the feature. Run the following commands after your upgrade:
|
||||
|
||||
```shell
|
||||
sudo ghe-config app.gitauth.git-protocol true
|
||||
|
|
|
|||
|
|
@ -288,7 +288,7 @@ class GHAapp < Sinatra::Application
|
|||
# Instantiate an Octokit client authenticated as a GitHub App.
|
||||
# GitHub App authentication requires that you construct a
|
||||
# JWT (https://jwt.io/introduction/) signed with the app's private key,
|
||||
# so GitHub can be sure that it came from the app an not altererd by
|
||||
# so GitHub can be sure that it came from the app and not altered by
|
||||
# a malicious third party.
|
||||
def authenticate_app
|
||||
payload = {
|
||||
|
|
@ -885,7 +885,7 @@ Open your `server.rb` file. In the code block that starts with `helpers do`, whe
|
|||
|
||||
The code above uses the `ruby-git` gem to clone the repository using the app's installation token. It clones the code in the same directory as `server.rb`. To run Git commands in the repository, the code needs to change into the repository directory. Before changing directories, the code stores the current working directory in a variable (`pwd`) to remember where to return before exiting the `clone_repository` method.
|
||||
|
||||
From the repository directory, this code fetches and merges the latest changes (`@git.pull`), and checks out the specifig Git ref (`@git.checkout(ref)`). The code to do all of this fits nicely into its own method. To perform these operations, the method needs the name and full name of the repository and the ref to checkout. The ref can be a commit SHA, branch, or tag. When it's done, the code changes the directory back to the original working directory (`pwd`).
|
||||
From the repository directory, this code fetches and merges the latest changes (`@git.pull`), and checks out the specific Git ref (`@git.checkout(ref)`). The code to do all of this fits nicely into its own method. To perform these operations, the method needs the name and full name of the repository and the ref to checkout. The ref can be a commit SHA, branch, or tag. When it's done, the code changes the directory back to the original working directory (`pwd`).
|
||||
|
||||
Now you've got a method that clones a repository and checks out a ref. Next, you need to add code to get the required input parameters and call the new `clone_repository` method.
|
||||
|
||||
|
|
@ -1510,7 +1510,7 @@ class GHAapp < Sinatra::Application
|
|||
# Instantiate an Octokit client authenticated as a GitHub App.
|
||||
# GitHub App authentication requires that you construct a
|
||||
# JWT (https://jwt.io/introduction/) signed with the app's private key,
|
||||
# so GitHub can be sure that it came from the app an not altererd by
|
||||
# so GitHub can be sure that it came from the app and not altered by
|
||||
# a malicious third party.
|
||||
def authenticate_app
|
||||
payload = {
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ If your organization uses SAML SSO, you may not be able to see your organization
|
|||
|
||||
## Installing or requesting {% data variables.product.prodname_github_apps %} for SAML users
|
||||
|
||||
If your organization uses SAML, you may not see your organzation listed when you try to install or request an {% data variables.product.prodname_github_app %} for your organization. To resolve this issue, follow these steps:
|
||||
If your organization uses SAML, you may not see your organization listed when you try to install or request an {% data variables.product.prodname_github_app %} for your organization. To resolve this issue, follow these steps:
|
||||
|
||||
1. Go to `https://github.com/orgs/ORGANIZATION-NAME/sso` to start an active SAML session for your organization. Replace `ORGANIZATION-NAME` with the name of your organization.
|
||||
1. Try to install or request the {% data variables.product.prodname_github_app %} again. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)," "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)," and "[AUTOTITLE](/apps/using-github-apps/requesting-a-github-app-from-your-organization-owner)."
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ When you upgrade an app, your payment method is charged a prorated amount based
|
|||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. In the "Marketplace apps" tab, find the app you want to uprade.
|
||||
1. In the "Marketplace apps" tab, find the app you want to upgrade.
|
||||
1. Next to the organization where you want to upgrade the app, select **{% octicon "kebab-horizontal" aria-label="More" %}** and then click **Change plan**.
|
||||
1. Select the **Edit your plan** dropdown and click an account's plan to edit.
|
||||
{% data reusables.marketplace.choose-new-plan %}
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ If you still have too many results, check how many queries you are using to anal
|
|||
|
||||
Sometimes a single query reports many results because the codebase has a specific coding style, or because the analysis does not understand a particular library. You can review the results file in a SARIF viewer to see the distribution of results. For example, https://microsoft.github.io/sarif-web-component/.
|
||||
|
||||
- Check if the results are dominated by alerts identfied by a single query. Try excluding that query from analysis. You can reintroduce it when other alerts are fixed. For more information about {% data variables.product.prodname_codeql %} query configuration, see "[Excluding a query from analysis](#excluding-a-query-from-analysis)."
|
||||
- Check if the results are dominated by alerts identified by a single query. Try excluding that query from analysis. You can reintroduce it when other alerts are fixed. For more information about {% data variables.product.prodname_codeql %} query configuration, see "[Excluding a query from analysis](#excluding-a-query-from-analysis)."
|
||||
- Check if there are dataflow queries with many deep paths. Try omitting dataflow paths from the output. For more information about {% data variables.product.prodname_codeql %} analysis configuration, see "[Omitting dataflow paths from the output](#omitting-dataflow-paths-from-the-output)."
|
||||
|
||||
## Fixing the problem
|
||||
|
|
|
|||
|
|
@ -239,7 +239,7 @@ registry=https://<private-registry-url>
|
|||
|
||||
{% endraw %}
|
||||
|
||||
Aternatively you can add the private registry URL to an existing `.npmrc` file using the following command.
|
||||
Alternatively you can add the private registry URL to an existing `.npmrc` file using the following command.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
|
@ -627,7 +627,7 @@ If you are restricting which IPs can reach your Nexus host, you need to add the
|
|||
- "3.217.93.44/32"
|
||||
For more information, see [Securing Nexus Repository Manager](https://help.sonatype.com/repomanager3/planning-your-implementation/securing-nexus-repository-manager) in the Sonatype documentation.
|
||||
|
||||
Registries can be proxied to reach out to a public registry in case a dependency is not available in the private regstry.{% ifversion dependabot-private-registries %} However, you may want {% data variables.product.prodname_dependabot %} to only access the private registry and not access the public registry at all. For more information, see [Quick Start Guide - Proxying Maven and NPM](https://help.sonatype.com/repomanager3/planning-your-implementation/quick-start-guide---proxying-maven-and-npm)" in the Sonatype documentation, and "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries)."{% endif %}
|
||||
Registries can be proxied to reach out to a public registry in case a dependency is not available in the private registry.{% ifversion dependabot-private-registries %} However, you may want {% data variables.product.prodname_dependabot %} to only access the private registry and not access the public registry at all. For more information, see [Quick Start Guide - Proxying Maven and NPM](https://help.sonatype.com/repomanager3/planning-your-implementation/quick-start-guide---proxying-maven-and-npm)" in the Sonatype documentation, and "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries)."{% endif %}
|
||||
|
||||
### ProGet
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Protect your organization's repositories and settings by implementing security b
|
|||
|
||||
{% ifversion ghec %}- Enabling secure authentication processes by using SAML and SCIM integrations, as well as 2FA authentication whenever possible. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)," "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations)," and "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa)." {% endif %}
|
||||
|
||||
- Requiring organization members, outside collaborators, and billing managers to enable 2FA for their personal accounts, making it harder for malicious actors to access an organization's repositories and settings.{% ifversion ghec %} This is one step further from enabling secure autentication.{% endif %} For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)."
|
||||
- Requiring organization members, outside collaborators, and billing managers to enable 2FA for their personal accounts, making it harder for malicious actors to access an organization's repositories and settings.{% ifversion ghec %} This is one step further from enabling secure authentication.{% endif %} For more information, see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization)."
|
||||
|
||||
- Encouraging your users to create strong passwords and secure them appropriately, by following {% data variables.product.prodname_dotcom %}’s recommended password guidelines. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password)."
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ As an organization owner, you should limit and review access as appropriate for
|
|||
Recommendation | More information
|
||||
------------------ | -----------------
|
||||
Disable the ability to fork repositories. | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)"
|
||||
Disable changing repository visiblity. | "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)"
|
||||
Disable changing repository visibility. | "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-visibility-changes-in-your-organization)"
|
||||
Restrict repository creation to private or internal. | "[AUTOTITLE](/organizations/managing-organization-settings/restricting-repository-creation-in-your-organization)"
|
||||
Disable repository deletion and transfer. | "[AUTOTITLE](/organizations/managing-organization-settings/setting-permissions-for-deleting-or-transferring-repositories)"
|
||||
Scope {% data variables.product.pat_generic %}s to the minimum permissions necessary. | None
|
||||
|
|
@ -75,9 +75,9 @@ There are two forms of {% data variables.product.prodname_secret_scanning %} ava
|
|||
When enabled, {% data variables.secret-scanning.user_alerts %} can be detected on the following types of repository:{% ifversion fpt %}
|
||||
- Public repositories owned by personal accounts on {% data variables.product.prodname_dotcom_the_website %}
|
||||
- Public repositories owned by organizations
|
||||
- Private and internal repositorites owned by organizations using {% data variables.product.prodname_ghe_cloud %}, when you have a license for {% data variables.product.prodname_GH_advanced_security %}{% elsif ghec %}
|
||||
- Private and internal repositories owned by organizations using {% data variables.product.prodname_ghe_cloud %}, when you have a license for {% data variables.product.prodname_GH_advanced_security %}{% elsif ghec %}
|
||||
- Public repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} (for free)
|
||||
- Private and internal repositorites when you have a license for {% data variables.product.prodname_GH_advanced_security %}{% endif %}
|
||||
- Private and internal repositories when you have a license for {% data variables.product.prodname_GH_advanced_security %}{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes %}Your site administrator must enable {% data variables.product.prodname_secret_scanning %} for {% data variables.location.product_location %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance)."{% endif %}
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ This quickstart guide walks you through setting up and enabling {% data variable
|
|||
## Prerequisites
|
||||
|
||||
{% ifversion ghes %}
|
||||
Before you can use the {% data variables.product.prodname_dependabot_alerts %} feature in {% data variables.product.product_name %}, you must ensure that your enterprise administator enables {% data variables.product.prodname_dependabot %} for the instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise#enabling-dependabot-alerts)."
|
||||
Before you can use the {% data variables.product.prodname_dependabot_alerts %} feature in {% data variables.product.product_name %}, you must ensure that your enterprise administrator enables {% data variables.product.prodname_dependabot %} for the instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise#enabling-dependabot-alerts)."
|
||||
{% endif %}
|
||||
|
||||
For the purpose of this guide, we're going to use a demo repository to illustrate how {% data variables.product.prodname_dependabot %} finds vulnerabilities in dependencies, where you can see {% data variables.product.prodname_dependabot_alerts %} on {% data variables.product.prodname_dotcom %}, and how you can explore, fix, or dismiss these alerts.
|
||||
|
|
@ -121,7 +121,7 @@ You can fix or dismiss {% data variables.product.prodname_dependabot_alerts %} o
|
|||
|
||||
- Select a reason for dismissing the alert. {% ifversion dependabot-alerts-dismissal-comment %}
|
||||
- Optionally, add a dismissal comment. The dismissal comment will be added to the alert timeline and can be used as justification during auditing and reporting.{% endif %}
|
||||
- Click **Dismiss alert**. The alert won't appear aymore in the **Open** tab of the alert list, and you are able to view it in the **Closed** tab.
|
||||
- Click **Dismiss alert**. The alert won't appear anymore in the **Open** tab of the alert list, and you are able to view it in the **Closed** tab.
|
||||
|
||||
For more information about reviewing and updating {% data variables.product.prodname_dependabot_alerts %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#reviewing-and-fixing-alerts)."
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Managing privately reported security vulnerabilities
|
||||
intro: Repository maintainers can manage security vulnerabilities that have been privately reported to them by security reseachers for repositories where private vulnerability reporting is enabled.
|
||||
intro: Repository maintainers can manage security vulnerabilities that have been privately reported to them by security researchers for repositories where private vulnerability reporting is enabled.
|
||||
permissions: 'Anyone with admin permissions to a repository can see, review, and manage privately-reported vulnerabilities for the repository.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ You can check the current service status on the [Status Dashboard](https://www.g
|
|||
|
||||
## Option 3: Clone the repository locally or edit in the browser
|
||||
|
||||
While {% data variables.product.prodname_github_codespaces %} provides the benefit of a pre-configured developer environmnent, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_github_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
|
||||
While {% data variables.product.prodname_github_codespaces %} provides the benefit of a pre-configured developer environment, your source code should always be accessible through the repository hosted on {% data variables.product.prodname_dotcom_the_website %}. In the event of a {% data variables.product.prodname_github_codespaces %} outage, you can still clone the repository locally or edit files in the {% data variables.product.company_short %} browser editor. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)."
|
||||
|
||||
While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve.
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ shortTitle: Using Copilot Chat
|
|||
|
||||
{% data variables.product.prodname_copilot_chat %} is available to all organizations and enterprises that have an active {% data variables.product.prodname_copilot_for_business %} license. You can enable or disable {% data variables.product.prodname_copilot_chat %} for your organization or enterprise in the {% data variables.product.prodname_copilot_for_business %} settings page.
|
||||
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enbaled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enabled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_copilot_chat %} at the organization level
|
||||
|
||||
|
|
@ -163,7 +163,7 @@ To share feedback about {% data variables.product.prodname_copilot_chat %}, you
|
|||
|
||||
{% data variables.product.prodname_copilot_chat %} is available to all organizations and enterprises that have an active {% data variables.product.prodname_copilot_for_business %} license. You can enable or disable {% data variables.product.prodname_copilot_chat %} for your organization or enterprise in the {% data variables.product.prodname_copilot_for_business %} settings page.
|
||||
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enbaled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enabled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_copilot_chat %} at the organization level
|
||||
|
||||
|
|
|
|||
|
|
@ -146,7 +146,7 @@ You can chat with {% data variables.product.prodname_copilot_short %} about a fi
|
|||
- How could I improve this code?
|
||||
- How can I test this script?
|
||||
|
||||
If you are aksing about specific lines, you could enter:
|
||||
If you are asking about specific lines, you could enter:
|
||||
- Explain the function at the selected lines.
|
||||
- How could I improve this class?
|
||||
- Add error handling to this code.
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ If you are experiencing authentication issues after installing the {% data varia
|
|||
|
||||
If you are experiencing authentication issues after installing the {% data variables.product.prodname_copilot_chat %} extension in {% data variables.product.prodname_vs %}, you can try the following steps to resolve the issue.
|
||||
|
||||
1. Check that the {% data variables.product.prodname_dotcom %} ID you are signed into {% data variables.product.prodname_vs %} with is the same as the one that you have been granted acess to {% data variables.product.prodname_copilot_chat %} with.
|
||||
1. Check that the {% data variables.product.prodname_dotcom %} ID you are signed into {% data variables.product.prodname_vs %} with is the same as the one that you have been granted access to {% data variables.product.prodname_copilot_chat %} with.
|
||||
1. Check whether your {% data variables.product.prodname_dotcom %} ID/credentials need refreshing in {% data variables.product.prodname_vs %}. For more information, see "[Work with {% data variables.product.prodname_dotcom %} accounts in {% data variables.product.prodname_vs %}](https://learn.microsoft.com/en-us/visualstudio/ide/work-with-github-accounts?view=vs-2022)" in the {% data variables.product.prodname_vs %} documentation.
|
||||
1. Try removing and re-adding your {% data variables.product.prodname_dotcom %} ID to {% data variables.product.prodname_vs %} and restarting {% data variables.product.prodname_vs %}.
|
||||
1. If the above steps don't work, click the **Share feedback** button and select **Report a problem** to report the issue to the {% data variables.product.prodname_vs %} team.
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@ shortTitle: Collapsed sections
|
|||
|
||||
You can temporarily obscure sections of your Markdown by creating a collapsed section that the reader can choose to expand. For example, when you want to include technical details in an issue comment that may not be relevant or interesting to every reader, you can put those details in a collapsed section.
|
||||
|
||||
Any Markdown within the `<details>` block will be collapsed until the reader clicks {% octicon "triangle-right" aria-label="The right triange icon" %} to expand the details.
|
||||
Any Markdown within the `<details>` block will be collapsed until the reader clicks {% octicon "triangle-right" aria-label="The right triangle icon" %} to expand the details.
|
||||
|
||||
Within the `<details>` block, use the `<summary>` tag to let readers know what is inside. The label appears to the right of {% octicon "triangle-right" aria-label="The right triange icon" %}.
|
||||
Within the `<details>` block, use the `<summary>` tag to let readers know what is inside. The label appears to the right of {% octicon "triangle-right" aria-label="The right triangle icon" %}.
|
||||
|
||||
````markdown
|
||||
<details>
|
||||
|
|
@ -40,7 +40,7 @@ The Markdown inside the `<summary>` label will be collapsed by default:
|
|||
|
||||
|
||||
|
||||
After a reader clicks {% octicon "triangle-right" aria-label="The right triange icon" %}, the details are expanded:
|
||||
After a reader clicks {% octicon "triangle-right" aria-label="The right triangle icon" %}, the details are expanded:
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ type: tutorial
|
|||
|
||||
## About programmatic import of repositories
|
||||
|
||||
In the following guide, you can learn how to programatically run "source and history" migrations of Git repositories to {% data variables.product.prodname_dotcom_the_website %}. Different options are available depending on where the repository is stored.
|
||||
In the following guide, you can learn how to programmatically run "source and history" migrations of Git repositories to {% data variables.product.prodname_dotcom_the_website %}. Different options are available depending on where the repository is stored.
|
||||
|
||||
To learn more about "source and history" and other types of migrations, see "[AUTOTITLE](/migrations/overview/planning-your-migration-to-github)."
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ If the source repository is on {% data variables.product.prodname_dotcom_the_web
|
|||
|
||||
To use repository templates, you must either have read access to an existing repository that's a template, or you must have access to create a template.
|
||||
|
||||
You can programatically create a repository from a repository template using the REST API. For more information, see "[AUTOTITLE](/rest/repos/repos)" in the REST API documentation.
|
||||
You can programmatically create a repository from a repository template using the REST API. For more information, see "[AUTOTITLE](/rest/repos/repos)" in the REST API documentation.
|
||||
|
||||
## Using {% data variables.product.prodname_importer_proper_name %}
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ In addition to your source and version control history, {% data variables.produc
|
|||
|
||||
To use {% data variables.product.prodname_importer_proper_name %}, you must have admin access to the source repository.
|
||||
|
||||
You can programatically import repositories with {% data variables.product.prodname_importer_proper_name %} using the GraphQL API.
|
||||
You can programmatically import repositories with {% data variables.product.prodname_importer_proper_name %} using the GraphQL API.
|
||||
|
||||
## Using the Git CLI
|
||||
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ query(
|
|||
}
|
||||
```
|
||||
|
||||
{% data reusables.enterprise_migrations.retreive-enterprise-id-graphql %}
|
||||
{% data reusables.enterprise_migrations.retrieve-enterprise-id-graphql %}
|
||||
|
||||
## Step 2: Start your organization migration
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ Organization owners have full administrative access to the organization. {% data
|
|||
{% endnote %}
|
||||
|
||||
{% ifversion enterprise-owner-join-org %}
|
||||
If your organization is owned by an enterprise account, any enterprise owner can make themself an owner of your organization. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."
|
||||
If your organization is owned by an enterprise account, any enterprise owner can make themselves an owner of your organization. For more information, see "[AUTOTITLE](/admin/user-management/managing-organizations-in-your-enterprise/managing-your-role-in-an-organization-owned-by-your-enterprise)."
|
||||
{% endif %}
|
||||
|
||||
## Appointing an organization owner
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ If an organization member has missing SCIM metadata, then you can re-provision S
|
|||
|
||||
If you suspect or notice that any users are not provisioned or deprovisioned as expected, we recommend that you audit all users in your organization.
|
||||
|
||||
To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programatically check all organization members using the {% data variables.product.prodname_dotcom %} API.
|
||||
To check whether users have a SCIM identity (SCIM metadata) in their external identity, you can review SCIM metadata for one organization member at a time on {% data variables.product.prodname_dotcom %} or you can programmatically check all organization members using the {% data variables.product.prodname_dotcom %} API.
|
||||
|
||||
When the IdP sends a provisioning call to the {% data variables.product.prodname_dotcom %} SCIM API, the SCIM `userName` in that API call needs to match the stored SAML `nameID` in the user's linked SAML identity in the organization. If these two values do not match, the SCIM metadata will not get populated, and the SCIM identity will not get successfully linked. To check whether these values match, use the {% data variables.product.prodname_dotcom %} API.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Many REST API endpoints require authentication or return additional information
|
|||
|
||||
To authenticate your request, you will need to provide an authentication token with the required scopes or permissions. There a few different ways to get a token: You can create a {% data variables.product.pat_generic %}, generate a token with a {% data variables.product.prodname_github_app %}, or use the built-in `GITHUB_TOKEN` in a {% data variables.product.prodname_actions %} workflow.
|
||||
|
||||
After creating a token, you can authenticate your request by sending the token in the `Authorization` header of your request. For example, in the folllowing request, replace `YOUR-TOKEN` with a reference to your token:
|
||||
After creating a token, you can authenticate your request by sending the token in the `Authorization` header of your request. For example, in the following request, replace `YOUR-TOKEN` with a reference to your token:
|
||||
|
||||
```shell
|
||||
curl --request GET \
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Issue 9102 and a Hubber-contirbution PR /docs-internal/pull/36758
|
||||
# Issue 9102 and a Hubber-contribution PR /docs-internal/pull/36758
|
||||
# Documentation for single-use registration tokens and just-in-time runners
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Documentation for adding business.sso_response and org.sso_repsonse
|
||||
# Documentation for adding business.sso_response and org.sso_response
|
||||
|
||||
versions:
|
||||
ghec: '*'
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Reference: #5604.
|
||||
# Documentation for the beta release of CodeQL queries boosted by machine learning
|
||||
# to generate experiemental alerts in code scanning.
|
||||
# to generate experimental alerts in code scanning.
|
||||
# Now deprecated and sunset. Reference: #12391
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
{% data variables.product.prodname_copilot_chat %} is available to all organizations and enterprises that have an active {% data variables.product.prodname_copilot_for_business %} license. You can enable or disable {% data variables.product.prodname_copilot_chat %} for your organization or enterprise in the {% data variables.product.prodname_copilot_for_business %} settings page.
|
||||
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enbaled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
If {% data variables.product.prodname_copilot_chat_short %} is enabled or disabled at the enterprise level, organizations within the enterprise cannot override the setting.
|
||||
|
||||
### Enabling or disabling {% data variables.product.prodname_copilot_chat %} at the organization level
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
### Usage limits
|
||||
|
||||
There are usage limits for the team synchonization feature. Exceeding these limits will lead to a degredation in performance and may cause synchronization failures.
|
||||
There are usage limits for the team synchronization feature. Exceeding these limits will lead to a degradation in performance and may cause synchronization failures.
|
||||
|
||||
- Maximum number of members in a GitHub team: 5,000
|
||||
- Maximum number of members in a GitHub organization: 10,000
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{% note %}
|
||||
|
||||
**Note:** If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerabiliy reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)."
|
||||
**Note:** If you are a security researcher, you should directly contact maintainers to ask them to create security advisories or issue CVEs on your behalf in repositories that you don't administer. However, if private vulnerability reporting is enabled for the repository, you can _privately_ report a vulnerability yourself. For more information, see "[AUTOTITLE](/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability)."
|
||||
|
||||
{% endnote %}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
1. Optionally, if you're sponsoring as an organization in the middle of a billing cycle, to make the full monthly payment instead of paying a prorated amount, click **Full amount**.
|
||||
|
||||
|
||||
|
||||
|
||||
If you pay for {% data variables.product.prodname_sponsors %} by invoice, you also have the option to pay at the start of your next billing cycle. This means you don't have to pay anything when setting up a sponsorship, and you will be charged the full amount on your next billing date. To schedule the sponsorship for your next billing cycle, click **Pay later**.
|
||||
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ A few things are harder to categorize, so there's some broad folders:
|
|||
- `frame/`, for things that make the header, footer, global sidebar functional. And there's no more specific option.
|
||||
- `workflows/`, for things that are processes rather than the production application. And there's no more specific option.
|
||||
|
||||
But don't hestitate to make a new subject folder if there's at least a few files related.
|
||||
But don't hesitate to make a new subject folder if there's at least a few files related.
|
||||
|
||||
## Where to get help
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ The second name in the `names` array is the readable name, which also matches th
|
|||
|
||||
### `description`
|
||||
|
||||
When writing the `description` for your rule, choose a succint one-sentence description that describes the high-level violation you are trying to avoid. There is an opportunity to provide more detail when setting the error message in the rule's function. Avoid using end punctuation in the `description`.
|
||||
When writing the `description` for your rule, choose a succinct one-sentence description that describes the high-level violation you are trying to avoid. There is an opportunity to provide more detail when setting the error message in the rule's function. Avoid using end punctuation in the `description`.
|
||||
|
||||
### `tags`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Article title
|
||||
shortTitle: '<article>'
|
||||
intro: 'This page uses < and > in the title and `shortTitle` to demonstrate that that works'
|
||||
intro: 'This page uses < and > in the title and `shortTitle` to demonstrate that it works'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ In this example, the
|
|||
|
||||
After 3 spaces, here's the "body" of the second bullet point.
|
||||
|
||||
## Injected insode a code block
|
||||
## Injected inside a code block
|
||||
|
||||
1. Here's some Yaml code.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Raw Liquid tag
|
||||
intro: Demonstrates the the use of {% raw %}{% raw %}{% endraw %}
|
||||
intro: Demonstrates the use of {% raw %}{% raw %}{% endraw %}
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Link rewriting
|
||||
intro: 'When rendered, links are rewritting to perfection for viewing'
|
||||
intro: 'When rendered, links are rewriting to perfection for viewing'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
|
|
|
|||
|
|
@ -105,7 +105,7 @@ The dates we use for Enterprise releases and deprecations are stored in [release
|
|||
|
||||
- [ ] Completed step 4 ✅
|
||||
|
||||
This step will remove the version from the drop-down picker, effectively deprecating the version from a user's perspective. The content for the deperecated release will still exist in the Markdown files.
|
||||
This step will remove the version from the drop-down picker, effectively deprecating the version from a user's perspective. The content for the deprecated release will still exist in the Markdown files.
|
||||
|
||||
1. In your `docs-internal` checkout, create a new branch: `git checkout -b deprecate-<version>`.
|
||||
|
||||
|
|
@ -132,7 +132,7 @@ This step will remove the version from the drop-down picker, effectively depreca
|
|||
|
||||
- [ ] ✅ Completed step 5
|
||||
|
||||
1. Create a new tag for the most recent commit on the `main` branch so that we can keep track of where in commit history we removed the GHES release. Create a tag called `enterprise-<release number>-release`. To create only a tag and not a release, you can [create a new release](https://github.com/github/docs-internal/releases), which allows you to "Choose a tag." Select add a new tag and use the tag name as the release title. After creating the new release, you wil see the new tag as well. You can then delete the release.
|
||||
1. Create a new tag for the most recent commit on the `main` branch so that we can keep track of where in commit history we removed the GHES release. Create a tag called `enterprise-<release number>-release`. To create only a tag and not a release, you can [create a new release](https://github.com/github/docs-internal/releases), which allows you to "Choose a tag." Select add a new tag and use the tag name as the release title. After creating the new release, you will see the new tag as well. You can then delete the release.
|
||||
|
||||
## Step 6: Remove static files for the version
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ This step will remove the version from the drop-down picker, effectively depreca
|
|||
npm run remove-version-markup -- --release <number>
|
||||
```
|
||||
|
||||
1. If data resuables were deleted automatically, you'll need to remove references to the deleted reusable in the content. Using VSCode to find the occurrences is quick and there are typically only a few to update. If you have any questions, reach out to the docs-content team in #docs-content to ask for help updating the Markdown files.
|
||||
1. If data reusables were deleted automatically, you'll need to remove references to the deleted reusable in the content. Using VSCode to find the occurrences is quick and there are typically only a few to update. If you have any questions, reach out to the docs-content team in #docs-content to ask for help updating the Markdown files.
|
||||
|
||||
1. Open a PR with the results.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче