зеркало из https://github.com/github/docs.git
Fix Markdown list indentation (#37388)
This commit is contained in:
Родитель
3653454f3d
Коммит
151285093e
|
@ -20,28 +20,28 @@ The time required to failover depends on how long it takes to manually promote t
|
|||
|
||||
1. If the primary appliance is available, to allow replication to finish before you switch appliances, on the primary appliance, put the primary appliance into maintenance mode.
|
||||
|
||||
- Put the appliance into maintenance mode.
|
||||
- Put the appliance into maintenance mode.
|
||||
|
||||
- To use the management console, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)"
|
||||
- To use the management console, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)"
|
||||
|
||||
- You can also use the `ghe-maintenance -s` command.
|
||||
```shell
|
||||
$ ghe-maintenance -s
|
||||
```
|
||||
- You can also use the `ghe-maintenance -s` command.
|
||||
```shell
|
||||
$ ghe-maintenance -s
|
||||
```
|
||||
|
||||
- When the number of active Git operations, MySQL queries, and Resque jobs reaches zero, wait 30 seconds.
|
||||
|
||||
{% note %}
|
||||
{% note %}
|
||||
|
||||
**Note:** Nomad will always have jobs running, even in maintenance mode, so you can safely ignore these jobs.
|
||||
**Note:** Nomad will always have jobs running, even in maintenance mode, so you can safely ignore these jobs.
|
||||
|
||||
{% endnote %}
|
||||
{% endnote %}
|
||||
|
||||
- To verify all replication channels report `OK`, use the `ghe-repl-status -vv` command.
|
||||
|
||||
```shell
|
||||
$ ghe-repl-status -vv
|
||||
```
|
||||
```shell
|
||||
$ ghe-repl-status -vv
|
||||
```
|
||||
|
||||
4. On the replica appliance, to stop replication and promote the replica appliance to primary status, use the `ghe-repl-promote` command. This will also automatically put the primary node in maintenance mode if it’s reachable.
|
||||
```shell
|
||||
|
@ -52,7 +52,7 @@ The time required to failover depends on how long it takes to manually promote t
|
|||
|
||||
**Note:** If the primary node is unavailable, warnings and timeouts may occur but can be ignored.
|
||||
|
||||
{% endnote %}
|
||||
{% endnote %}
|
||||
|
||||
5. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica.
|
||||
6. Notify users that they can resume normal operations.
|
||||
|
|
|
@ -64,38 +64,38 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G
|
|||
- For "Provider name", enter a name for the provider.
|
||||
- For "Issuer (URL)", enter the following URL, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
|
||||
|
||||
```
|
||||
https://HOSTNAME/_services/token
|
||||
```
|
||||
```
|
||||
https://HOSTNAME/_services/token
|
||||
```
|
||||
|
||||
For example:
|
||||
For example:
|
||||
|
||||
```
|
||||
https://my-ghes-host.example.com/_services/token
|
||||
```
|
||||
- Under "Audiences", leave **Default audience** selected, but note the identity provider URL, as it is needed later. The identity provider URL is in the format `https://iam.googleapis.com/projects/PROJECT-NUMBER/locations/global/workloadIdentityPools/POOL-NAME/providers/PROVIDER-NAME`.
|
||||
- Click **Continue**.
|
||||
```
|
||||
https://my-ghes-host.example.com/_services/token
|
||||
```
|
||||
- Under "Audiences", leave **Default audience** selected, but note the identity provider URL, as it is needed later. The identity provider URL is in the format `https://iam.googleapis.com/projects/PROJECT-NUMBER/locations/global/workloadIdentityPools/POOL-NAME/providers/PROVIDER-NAME`.
|
||||
- Click **Continue**.
|
||||
1. Under "Configure provider attributes":
|
||||
|
||||
- For the "OIDC 1" mapping, enter `assertion.sub`.
|
||||
- Under "Attribute Conditions", click **Add condition**.
|
||||
- For "Condition CEL", enter the following condition, replacing `HOSTNAME` with the public hostname for {% data variables.location.product_location_enterprise %}:
|
||||
|
||||
```
|
||||
google.subject == "HOSTNAME"
|
||||
```
|
||||
```
|
||||
google.subject == "HOSTNAME"
|
||||
```
|
||||
|
||||
For example:
|
||||
For example:
|
||||
|
||||
```
|
||||
google.subject == "my-ghes-host.example.com"
|
||||
```
|
||||
```
|
||||
google.subject == "my-ghes-host.example.com"
|
||||
```
|
||||
|
||||
{% note %}
|
||||
{% note %}
|
||||
|
||||
**Note:** The hostname of {% data variables.location.product_location_enterprise %} used here _must not_ include the protocol.
|
||||
**Note:** The hostname of {% data variables.location.product_location_enterprise %} used here _must not_ include the protocol.
|
||||
|
||||
{% endnote %}
|
||||
{% endnote %}
|
||||
- Click **Save**.
|
||||
1. After creating the identity pool, at the top of the identity pool's page, click **Grant access**.
|
||||
- Under "Select service account", select the service account that you created in the previous procedure.
|
||||
|
|
|
@ -33,7 +33,7 @@ Before setting up {% data variables.visual_studio.prodname_vss_ghe %}, it's impo
|
|||
- Your team's {% data variables.product.prodname_vs %} subscription must include {% data variables.product.prodname_enterprise %}. For more information, see [{% data variables.product.prodname_vs %} Subscriptions and Benefits](https://visualstudio.microsoft.com/subscriptions/) on the {% data variables.product.prodname_vs %} website and
|
||||
[Overview of admin responsibilities](https://docs.microsoft.com/en-us/visualstudio/subscriptions/admin-responsibilities) in Microsoft Docs.
|
||||
|
||||
- Your team must have an enterprise on {% data variables.location.product_location %}. If you're not sure whether your team has an enterprise, contact your {% data variables.product.prodname_dotcom %} administrator. If you're not sure who on your team is responsible for {% data variables.product.prodname_dotcom %}, contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)."
|
||||
- Your team must have an enterprise on {% data variables.location.product_location %}. If you're not sure whether your team has an enterprise, contact your {% data variables.product.prodname_dotcom %} administrator. If you're not sure who on your team is responsible for {% data variables.product.prodname_dotcom %}, contact {% data variables.contact.contact_enterprise_sales %}. For more information, see "[AUTOTITLE](/admin/overview/about-enterprise-accounts)."
|
||||
|
||||
## Setting up {% data variables.visual_studio.prodname_vss_ghe %}
|
||||
|
||||
|
|
|
@ -40,7 +40,7 @@ You can upload the results using {% data variables.product.prodname_actions %},
|
|||
|
||||
- {% data variables.product.prodname_actions %} to run the {% data variables.product.prodname_codeql %} action, there is no further action required. The {% data variables.product.prodname_codeql %} action uploads the SARIF file automatically when it completes analysis.
|
||||
- {% data variables.product.prodname_actions %} to run a SARIF-compatible analysis tool, you could update the workflow to include a final step that uploads the results (see below).
|
||||
- The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[AUTOTITLE](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").
|
||||
- The {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_code_scanning %} in your CI system, you can use the CLI to upload results to {% data variables.product.prodname_dotcom %} (for more information, see "[AUTOTITLE](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system)").
|
||||
- A tool that generates results as an artifact outside of your repository, you can use the {% data variables.product.prodname_code_scanning %} API to upload the file (for more information, see "[AUTOTITLE](/rest/code-scanning#upload-an-analysis-as-sarif-data)").
|
||||
|
||||
{% data reusables.code-scanning.not-available %}
|
||||
|
|
|
@ -202,10 +202,10 @@ See [step 3 from the previous section](#3-launch-codeql).
|
|||
|
||||
- Run `codeql resolve languages` to show which languages are available for database creation. This will list the languages supported by default in your {% data variables.product.prodname_codeql_cli %} package.
|
||||
- Run `codeql resolve qlpacks` to show which {% data variables.product.prodname_codeql %} packs the CLI can find. This will display the names of all the {% data variables.product.prodname_codeql %} packs directly available to the {% data variables.product.prodname_codeql_cli %}. This should include:
|
||||
- Query packs for each supported language, for example, `codeql/{language}-queries`. These packs contain the standard queries that will be run for each analysis.
|
||||
- Library packs for each supported language, for example, `codeql/{language}-all`. These packs contain query libraries, such as control flow and data flow libraries, that may be useful to query writers.
|
||||
- Example packs for each supported language, for example, `codeql/{language}-examples`. These packs contain useful snippets of {% data variables.product.prodname_codeql %} that query writers may find useful.
|
||||
- Legacy packs that ensure custom queries and libraries created using older products are compatible with your version of {% data variables.product.prodname_codeql %}.
|
||||
- Query packs for each supported language, for example, `codeql/{language}-queries`. These packs contain the standard queries that will be run for each analysis.
|
||||
- Library packs for each supported language, for example, `codeql/{language}-all`. These packs contain query libraries, such as control flow and data flow libraries, that may be useful to query writers.
|
||||
- Example packs for each supported language, for example, `codeql/{language}-examples`. These packs contain useful snippets of {% data variables.product.prodname_codeql %} that query writers may find useful.
|
||||
- Legacy packs that ensure custom queries and libraries created using older products are compatible with your version of {% data variables.product.prodname_codeql %}.
|
||||
|
||||
## Using two versions of the {% data variables.product.prodname_codeql_cli %}
|
||||
|
||||
|
|
|
@ -69,16 +69,16 @@ We recommend that you use the **Affected versions** field to specify which versi
|
|||
{% note %}
|
||||
|
||||
**Notes:** The lower-bound limitation:
|
||||
- is due to incompatibilities with the OSV (Open Source Vulnerability) schema.
|
||||
- only applies when you make a suggestion on an existing advisory in the {% data variables.product.prodname_advisory_database %}.
|
||||
- is due to incompatibilities with the OSV (Open Source Vulnerability) schema.
|
||||
- only applies when you make a suggestion on an existing advisory in the {% data variables.product.prodname_advisory_database %}.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
- You cannot specify multiple affected version ranges in the same field, such as `> 2.0, < 2.3, > 3.0, < 3.2`.To specify more than one range, you must create a new **Affected products** section for each range, by clicking the **+ Add another affected product** button.
|
||||
|
||||
![Screenshot of the "Affected products" area of the security advisory form. A link, labeled "Add another affected product", is highlighted with a dark orange outline.](/assets/images/help/security/security-advisory-add-another-affected-product.png)
|
||||
- If the affected version range includes only a single upper or lower bound:
|
||||
- The implicit value is always `> 0` if the lower bound is not explicitly specified.
|
||||
- The implicit value is always infinity if the upper bound is not explicitly specified.
|
||||
- If the affected version range includes only a single upper or lower bound:
|
||||
- The implicit value is always `> 0` if the lower bound is not explicitly specified.
|
||||
- The implicit value is always infinity if the upper bound is not explicitly specified.
|
||||
|
||||
For more information about the {% data variables.product.prodname_advisory_database %}, see [https://github.com/github/advisory-database](https://github.com/github/advisory-database).
|
||||
|
|
|
@ -42,7 +42,7 @@ You can also use the REST API to create repository security advisories. For more
|
|||
|
||||
![Screenshot of a draft security advisory. A dropdown menu, labeled "Choose a credit type," is highlighted with an orange outline.](/assets/images/help/security/security-advisories-choose-credit-type.png)
|
||||
|
||||
- Optionally, to remove someone, click {% octicon "x" aria-label="The icon to remove someone's credit" %} next to the credit type.{% endif %}
|
||||
- Optionally, to remove someone, click {% octicon "x" aria-label="The icon to remove someone's credit" %} next to the credit type.{% endif %}
|
||||
1. Click **Create draft security advisory**.
|
||||
|
||||
{% data reusables.repositories.security-advisory-credits-notification %}
|
||||
|
|
|
@ -34,14 +34,14 @@ You can also use the REST API to edit repository security advisories. For more i
|
|||
{% data reusables.repositories.security-advisory-edit-details %}
|
||||
{% data reusables.repositories.security-advisory-edit-severity %}
|
||||
{% data reusables.repositories.security-advisory-edit-cwe %}
|
||||
1. Optionally, under "Credits", remove existing credits, or use the search box to find additional people you want to credit on the security advisory, then click their username to add them.
|
||||
1. Optionally, under "Credits", remove existing credits, or use the search box to find additional people you want to credit on the security advisory, then click their username to add them.
|
||||
{% ifversion security-advisories-credit-types %}
|
||||
- Use the dropdown menu next to the name of the person you're crediting to assign a credit type. For more information about credit types, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory#about-credits-for-repository-security-advisories)."
|
||||
- Use the dropdown menu next to the name of the person you're crediting to assign a credit type. For more information about credit types, see "[AUTOTITLE](/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory#about-credits-for-repository-security-advisories)."
|
||||
|
||||
![Screenshot of a draft security advisory. A dropdown menu, labeled "Choose a credit type," is highlighted with an orange outline.](/assets/images/help/security/security-advisories-choose-credit-type.png)
|
||||
![Screenshot of a draft security advisory. A dropdown menu, labeled "Choose a credit type," is highlighted with an orange outline.](/assets/images/help/security/security-advisories-choose-credit-type.png)
|
||||
|
||||
- Optionally, to remove someone, click the {% octicon "x" aria-label="The icon to remove a credit to someone" %} next to the credit type.{% endif %}
|
||||
1. Click **Update security advisory**.
|
||||
- Optionally, to remove someone, click the {% octicon "x" aria-label="The icon to remove a credit to someone" %} next to the credit type.{% endif %}
|
||||
1. Click **Update security advisory**.
|
||||
|
||||
{% data reusables.repositories.security-advisory-credits-notification %}
|
||||
|
||||
|
|
|
@ -61,7 +61,7 @@ In the left sidebar, you'll find the **Changes** and **History** views.
|
|||
|
||||
![Screenshot of the GitHub Desktop app. A sidebar on the left-hand side, with tabs labeled "Changes" and "History", is highlighted with an orange outline.](/assets/images/help/desktop/changes-and-history.png)
|
||||
|
||||
- The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to.
|
||||
- The **Changes** view shows changes you've made to files in your current branch but haven't committed to your local repository. At the bottom, there is a box with "Summary" and "Description" text boxes and a **Commit to BRANCH** button. This is where you'll commit new changes. The **Commit to BRANCH** button is dynamic and will display which branch you're committing your changes to.
|
||||
- The **History** view shows the previous commits on the current branch of your repository. You should see an "Initial commit" that was created by {% data variables.product.prodname_desktop %} when you created your repository. To the right of the commit, depending on the options you selected while creating your repository, you may see _.gitattributes_, _.gitignore_, LICENSE, or README files. You can click each file to see a diff for that file, which is the changes made to the file in that commit. The diff only shows the parts of the file that have changed, not the entire contents of the file
|
||||
|
||||
## Part 4: Publishing your repository to {% data variables.product.product_name %}
|
||||
|
@ -70,11 +70,11 @@ When you create a new repository, it only exists on your computer and you are th
|
|||
1. In the repository bar, click **Publish repository**.
|
||||
![Screenshot of the repository bar. A button, labeled "Publish repository", is highlighted with an orange outline.](/assets/images/help/desktop/publish-repository.png)
|
||||
1. In the "Publish Repository" window, enter details for your new repository.
|
||||
- {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository.
|
||||
- **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available.
|
||||
- The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}.
|
||||
1. Click **Publish Repository**.
|
||||
1. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser.
|
||||
- {% data variables.product.prodname_desktop %} automatically fills the "Name" and "Description" fields with the information you entered when you created the repository.
|
||||
- **Keep this code private** lets you control who can view your project. If you leave this option unselected, other users on {% data variables.product.product_name %} will be able to view your code. If you select this option, your code will not be publicly available.
|
||||
- The **Organization** drop-down menu, if present, lets you publish your repository to a specific organization that you belong to on {% data variables.product.product_name %}.
|
||||
1. Click **Publish Repository**.
|
||||
1. You can access the repository on {% data variables.product.prodname_dotcom_the_website %} from within {% data variables.product.prodname_desktop %}. In the file menu, click **Repository**, then click **View on GitHub**. This will take you directly to the repository in your default browser.
|
||||
|
||||
## Part 5: Making, committing, and pushing changes
|
||||
Now that you've created and published your repository, you're ready to make changes to your project and start crafting your first commit to your repository.
|
||||
|
|
|
@ -60,7 +60,7 @@ With dependency insights you can view vulnerabilities, licenses, and other impor
|
|||
1. To see which dependents in your organization are using each library, next to a vulnerability, click {% octicon "package" aria-hidden-"true" %} **X dependents**.
|
||||
|
||||
## Further reading
|
||||
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-organizations)"
|
||||
- "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository)"
|
||||
- "[AUTOTITLE](/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights)"{% ifversion ghec %}
|
||||
- "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/about-organizations)"
|
||||
- "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository)"
|
||||
- "[AUTOTITLE](/organizations/managing-organization-settings/changing-the-visibility-of-your-organizations-dependency-insights)"{% ifversion ghec %}
|
||||
- "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-dependency-insights-in-your-enterprise)"{% endif %}
|
||||
|
|
|
@ -39,9 +39,9 @@ permissions: Organization owners can remove members from an organization.
|
|||
{% warning %}
|
||||
|
||||
**Warning:** When you remove members from an organization:
|
||||
- Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property.
|
||||
- Removed members will lose access to private forks of your organization's private repositories, but may still have local copies. However, they cannot sync local copies with your organization's repositories. Their private forks can be restored if the user is [reinstated as an organization member](/organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization) within three months of being removed from the organization. Ultimately, you are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property.
|
||||
- Removed members will also lose access to private forks of your organization's internal repositories, if the removed member is not a member of any other organization in your enterprise.
|
||||
- Any organization invitations sent by the removed user, that have not been accepted, are canceled and will not be accessible.
|
||||
- Any organization invitations sent by the removed user, that have not been accepted, are canceled and will not be accessible.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче