Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo sync #26935

Merged
merged 5 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,6 @@ If you have low vision, you may benefit from a high contrast theme, with greater
1. Click the theme you'd like to use.
- If you chose a single theme, click a theme.



- If you chose to follow your system settings, click a day theme and a night theme.{% ifversion fpt or ghec %}
- If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The instructions below assume that you need to set up {% data variables.product.

Before configuring {% data variables.product.prodname_dependabot %}, install Docker on your self-hosted runner. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/managing-self-hosted-runners-for-dependabot-updates#configuring-self-hosted-runners-for-dependabot-updates)."

1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file.
1. On {% data variables.location.product_location %}, navigate to the `github/dependabot-action` repository and retrieve information about the `dependabot-updater` and `dependabot-proxy` container images from the `containers.json` file.

Each release of {% data variables.product.product_name %} includes an updated `containers.json` file at: `https://HOSTNAME/github/dependabot-action/blob/ghes-VERSION/docker/containers.json`. You can see the {% data variables.product.prodname_dotcom_the_website %} version of the file at: [containers.json](https://github.com/github/dependabot-action/blob/main/docker/containers.json).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ topics:

{% data reusables.dependency-review.dependency-review-enabled-ghes %}

After you enable the dependency graph for your enterprise, you can enable {% data variables.product.prodname_dependabot %} to detect insecure dependencies in your repository{% ifversion ghes %} and automatically fix the vulnerabilities{% endif %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."
After you enable the dependency graph for your enterprise, you can enable {% data variables.product.prodname_dependabot %} to detect insecure dependencies in your repository and automatically fix the vulnerabilities. For more information, see "[AUTOTITLE](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)."

{% ifversion ghes %}
You can enable the dependency graph via the {% data variables.enterprise.management_console %} or the administrative shell. We recommend using the {% data variables.enterprise.management_console %} unless {% data variables.location.product_location %} uses clustering.

## Enabling the dependency graph via the {% data variables.enterprise.management_console %}
Expand All @@ -37,24 +36,22 @@ If {% data variables.location.product_location %} uses clustering, you cannot en

## Enabling the dependency graph via the administrative shell

{% endif %}
{% data reusables.enterprise_site_admin_settings.sign-in %}
1. In the administrative shell, enable the dependency graph on {% data variables.location.product_location %}:
{% ifversion ghes %}```shell
ghe-config app.dependency-graph.enabled true

```shell
ghe-config app.dependency-graph.enabled true
```
{% else %}```shell
ghe-config app.github.dependency-graph-enabled true
ghe-config app.github.vulnerability-alerting-and-settings-enabled true
```{% endif %}

{% note %}

**Note**: For more information about enabling access to the administrative shell via SSH, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)."

{% endnote %}
1. Apply the configuration.

```shell
$ ghe-config-apply
ghe-config-apply
```

1. Return to {% data variables.product.prodname_ghe_server %}.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ You can perform initial validation of your maintenance operation by configuring

## Validating changes in maintenance mode using the IP exception list


The IP exception list provides controlled and restricted access to {% data variables.location.product_location %}, which is ideal for initial validation of server health following a maintenance operation. Once enabled, {% data variables.location.product_location %} will be taken out of maintenance mode and available only to the configured IP addresses. The maintenance mode checkbox will be updated to reflect the change in state.

If you re-enable maintenance mode, the IP exception list will be disabled and {% data variables.location.product_location %} will return to maintenance mode. If you just disable the IP exception list, {% data variables.location.product_location %} will return to normal operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ shortTitle: Manage GitHub Mobile

You can allow or disallow people from using {% data variables.product.prodname_mobile %} to authenticate to {% data variables.location.product_location %} and access your instance's data. By default, {% data variables.product.prodname_mobile %} is enabled for people who use {% data variables.location.product_location %}.


## Enabling or disabling {% data variables.product.prodname_mobile %}

{% data reusables.enterprise_site_admin_settings.access-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ To install the official bundled actions and starter workflows within a designate
ghe-config app.actions.github-org ORGANIZATION
```

1. To add the bundled actions to your organization, unset the SHA.
1. To add the bundled actions to your organization, unset the SHA.

```shell
ghe-config --unset 'app.actions.actions-repos-sha1sum'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ This article explains how site administrators can configure {% data variables.pr

## Review hardware requirements


The CPU and memory resources available to {% data variables.location.product_location %} determine the number of runners that can be configured without performance loss. {% data reusables.actions.minimum-hardware %}

The peak quantity of connected runners without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated performance targets for GitHub Enterprise Server on a range of CPU and memory configurations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ After you configure the application for {% data variables.product.product_name %

{% endif %}


{% ifversion ghes %}

{% data reusables.enterprise_user_management.external_auth_disables_2fa %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -920,7 +920,6 @@ After running RuboCop and saving the linting results, this code runs the command

The `rm -rf` command cannot be undone. To keep your app secure, the code in this tutorial checks incoming webhooks for injected malicious commands that could be used to remove a different directory than intended by your app. For example, if a bad actor sent a webhook with the repository name `./`, your app would remove the root directory. The `verify_webhook_signature` method validates the sender of the webhook. The `verify_webhook_signature` event handler also checks that the repository name is valid. For more information, see "[Define a `before` filter](#define-a-before-filter)."


### Test the code

The following steps will show you how to test that the code works and view the errors reported by RuboCop.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Rolling {% data variables.product.prodname_code_scanning %} out across hundreds
{% ifversion ghec %}
{% data variables.product.prodname_code_scanning_caps %} is also available for all public repositories on {% data variables.product.prodname_dotcom_the_website %} without a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %}


### Preparing teams for {% data variables.product.prodname_code_scanning %}

First, prepare your teams to use {% data variables.product.prodname_code_scanning %}. The more teams that use {% data variables.product.prodname_code_scanning %}, the more data you'll have to drive remediation plans and monitor progress on your rollout. During this phase, focus on leveraging APIs and running internal enablement events.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ To calculate the security severity of an alert, we use Common Vulnerability Scor

By default, any {% data variables.product.prodname_code_scanning %} results with a security severity of `Critical` or `High` will cause a check failure. You can specify which security severity level for {% data variables.product.prodname_code_scanning %} results should cause a check failure. For more information, see "[AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning#defining-the-severities-causing-pull-request-check-failure)."


### About {% ifversion remove-code-scanning-configurations %}alerts from multiple configurations{% else %}analysis origins{% endif %}

{% ifversion remove-code-scanning-configurations %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ From macOS version 10.15 ("Catalina") onwards you need to ensure that your web b
1. Click the **General** Tab.
1. Ensure the check-box labeled **Open "safe" files after downloading** is unchecked.


### 2. Extract the zip archive

For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) simply extract the zip archive.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ For more information, see "[Reviewing and fixing alerts](#reviewing-and-fixing-a
1. Optionally, to filter alerts, select a filter in a dropdown menu then click the filter that you would like to apply. You can also type filters into the search bar. {% ifversion dependabot-filter-label-security-advisory %}Alternatively, to filter by label, click a label assigned to an alert to automatically apply that filter to the alert list.{% endif %} For more information about filtering and sorting alerts, see "[Prioritizing {% data variables.product.prodname_dependabot_alerts %}](#prioritizing-dependabot-alerts)."

{%- ifversion dependabot-bulk-alerts %}
![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% endif %}
![Screenshot of the filter and sort menus in the {% data variables.product.prodname_dependabot_alerts %} tab.](/assets/images/help/graphs/dependabot-alerts-filters-checkbox.png){% endif %}
1. Click the alert that you would like to view.
{% ifversion dependabot-filter-label-security-advisory %}
1. Optionally, to suggest an improvement to the related security advisory, on the right-hand side of the alert details page, click **Suggest improvements for this advisory on the {% data variables.product.prodname_advisory_database %}**. For more information, see "[AUTOTITLE](/code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ For more information, see "[AUTOTITLE](/code-security/supply-chain-security/unde

For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts){% ifversion fpt or ghec %}" and "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-security-and-analysis-settings-for-your-personal-account){% endif %}."


## Managing dependency review

Dependency review lets you visualize dependency changes in pull requests before they are merged into your repositories. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@ You can manually select the region that your codespaces will be created in, allo
1. Under "Region", select the setting you want: **Set automatically** or **Set manually**.

1. If you chose **Set manually**, select the dropdown menu and click your region.

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ There are costs associated with storing codespaces. You should therefore delete

{% endnote %}


{% vscode %}

{% data reusables.codespaces.deleting-a-codespace-in-vscode %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ Disabling the workflow runs for a prebuild configuration is useful if you need t

{% endnote %}


Deleting a prebuild configuration also deletes all previously created prebuilds for that configuration. As a result, shortly after you delete a configuration, prebuilds generated by that configuration will no longer be available when you create a new codespace.

After you delete a prebuild configuration, workflow runs for that configuration that have been queued or started will still run. They will be listed in the workflow run history, along with previously completed workflow runs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ assignees: octocat
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.files.add-file %}
1. In the file name field:
- To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`.
- To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`.
- To make your issue template visible in the repository's `docs` directory, type _docs/_ followed by the name of your _issue_template_. For example, `docs/issue_template.md`,
- To store your file in a hidden directory, type _.github/_ followed by the name of your _issue_template_. For example, `.github/issue_template.md`.
- To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type _.github/ISSUE_TEMPLATE/_, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ versions:
feature: 'contributing'
---

# Changing the title of an article
## Changing the title of an article

Sometimes, it's necessary to change the title of a help article. There are several considerations to keep in mind when you retitle an article.


## Background on changing the filename

The title of the article corresponds directly to the name of the Markdown file that contains that article, for a couple of reasons:
Expand All @@ -26,19 +25,20 @@ There are several places you may need to update when you give an article a new t

Each article contains a metadata section or frontmatter located at the **top of the article** formatted using YAML syntax. This metadata section generates the title of the article and contains other important data, such as redirects and sometimes even short description conrefs that link to reusable intro text.

```
```yaml
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
```

#### Frontmatter update checklist

- Update title using sentence case
- Update redirects. Almost every time we retitle an article, we should add a redirect referencing the article's old URL and make sure we keep any redirects in the old article's frontmatter.

### Filename

You can use the [`git mv` command](https://git-scm.com/docs/git-mv) in your terminal to change the name of the file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ versions:
feature: 'contributing'
---

# About the {% data variables.product.prodname_dotcom %} documentation philosophy
## About the {% data variables.product.prodname_dotcom %} documentation philosophy

As the home to the world's largest community of developers, we want to make sure that our documentation is accurate, valuable, inclusive, and easy to use. Our documentation philosophy leads us toward these goals.

Expand Down
4 changes: 2 additions & 2 deletions content/contributing/writing-for-github-docs/content-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ Contents of tutorials:
- Does not include the expected amount of time that it may take someone to complete the task - this depends on the experience level of the person completing the tutorial.
- Procedural sections
- Based on the tutorial's audience, the steps can be less explicit and formal than those used in procedural content. You do not have to use existing reusables to form these steps if the audience doesn’t require that level of detail.
- Use: "From your profile, click **Settings, and then click **Developer settings**.”
- Use: "From your profile, click **Settings**, and then click **Developer settings**.”
- Avoid: In the upper-right corner of any page, click your profile photo, then click **Settings**. In the left sidebar, click **Developer settings**.
- Link out to other articles or resources rather than replicating them, to avoid interrupting the flow of information in the tutorial.
- Give visual cues. Use code blocks and screenshots heavily to help reassure people that they are performing the correct actions.
Expand Down Expand Up @@ -434,7 +434,7 @@ Within an article, there is a standard order of content sections. Every article
11. Troubleshooting content
12. Further reading (conditional)

![Screenshot of article with title, intro, permissions, product callout, conceptual section, procedural section, and table of contents labeled](/assets/images/contributing/illustration-of-article-contents.png)
![Screenshot of article with title, intro, permissions, product callout, conceptual section, procedural section, and table of contents labeled.](/assets/images/contributing/illustration-of-article-contents.png)

### Titles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,6 @@ Table content is left-aligned by default. Use Markdown table formatting, colons

The following example shows part of a table from "[AUTOTITLE](/free-pro-team@latest/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)."


<table>
<thead>
<tr>
Expand Down
1 change: 0 additions & 1 deletion content/contributing/writing-for-github-docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,6 @@ Include a bulleted list of tutorials or articles the user can reference to exten

Use the content model for full instructions and examples on how to write for {% data variables.product.prodname_docs %}. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/content-model)."


```yaml
{% raw %}---
title: Guide title
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ versions:

Videos are used rarely in the {% data variables.product.prodname_docs %}. When videos are necessary to provide the best user experience for an article, they are used together with written text. Videos are not a replacement for written content. Videos should never be the only way information is communicated because they are more difficult to keep up to date and are not accessible to everyone.


Use these guidelines to determine if a video is appropriate to include in an article or on a landing page in the docs.

If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-github-docs.md)" file in the `github/docs` repository.
If you add a link to a video or embed a video in the {% data variables.product.prodname_docs %}, add the video's metadata to the "[Videos in {% data variables.product.prodname_docs %}](https://github.com/github/docs/blob/main/contributing/videos-in-docs.md)" file in the `github/docs` repository.

The Docs team does not create or maintain video content. Videos are purely supplemental to help communicate significant or complex topics, and should be used sparingly because they are not a content type owned by the Docs team.

Expand Down
Loading
Loading