diff --git a/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml b/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml new file mode 100644 index 000000000000..1aaa0e3a0889 --- /dev/null +++ b/.github/ISSUE_COMMENT_TEMPLATE/target-date.yml @@ -0,0 +1,14 @@ +--- +name: Target Date Update +about: Target date update +body: + - type: input + attributes: + name: Target completion date + placeholder: With context if the target completion date has changed + inputType: text + - type: input + attributes: + name: 'Attribution' + value: '_created with :heart: by typing_ `/status`' + inputType: text diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index 576ff559187d..2aaed21b79b0 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -39,6 +39,6 @@ module.exports = [ "repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d", "someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd", "tjenkinson/gh-action-auto-merge-dependency-updates@4d7756c04d9d999c5968697a621b81c47f533d61", - "EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575", + "EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519", "dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58", ]; diff --git a/.github/workflows/openapi-decorate.yml b/.github/workflows/openapi-decorate.yml index 435bfac1d01b..d59b305a3df7 100644 --- a/.github/workflows/openapi-decorate.yml +++ b/.github/workflows/openapi-decorate.yml @@ -25,13 +25,10 @@ jobs: run: script/rest/update-files.js --decorate-only - name: Check in the decorated files - uses: EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575 + uses: EndBug/add-and-commit@b3c7c1e078a023d75fb0bd326e02962575ce0519 with: # The arguments for the `git add` command add: 'lib/rest/static/decorated' # The message for the commit message: 'Add decorated OpenAPI schema files' - - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged diff --git a/.github/workflows/ready-for-doc-review.yml b/.github/workflows/ready-for-doc-review.yml new file mode 100644 index 000000000000..74243dac5507 --- /dev/null +++ b/.github/workflows/ready-for-doc-review.yml @@ -0,0 +1,22 @@ +name: Ready for docs-content review + +# **What it does**: Adds pull requests in the docs-internal repository to the docs-content first responder project board +# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review +# **Who does it impact**: Writers working in the docs-internal repository + +on: + pull_request: + types: [labeled] + +jobs: + request_doc_review: + name: Request a review from the docs-content team + if: github.event.label.name == 'ready-for-doc-review' && github.repository == 'github/docs-internal' + runs-on: ubuntu-latest + steps: + - name: Add pull request to FR project board + uses: rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9 + with: + action-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + project-url: 'https://github.com/orgs/github/projects/1367' + column-name: 'Docs-internal external contributor PRs' diff --git a/.github/workflows/send-eng-issues-to-backlog.yml b/.github/workflows/send-eng-issues-to-backlog.yml deleted file mode 100644 index 11ca0afd2f8d..000000000000 --- a/.github/workflows/send-eng-issues-to-backlog.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Send Issue to EPD backlog - -on: - issues: - types: - - labeled - - reopened - -jobs: - triage: - if: github.repository == 'github/docs-internal' - runs-on: ubuntu-latest - continue-on-error: true - steps: - - name: Add issues with engineering label to project board - if: contains(github.event.issue.labels.*.name, 'engineering') || contains(github.event.issue.labels.*.name, 'design') || contains(github.event.issue.labels.*.name, 'Design') - uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 - with: - github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} - script: | - var column_id = 9659080; - try { - github.projects.createCard({ - column_id: column_id, - content_id: context.payload.issue.id, - content_type: "Issue" - }); - } catch (error) { - console.log(error); - } diff --git a/.github/workflows/send-issues-to-how-how-we-work-boards.yml b/.github/workflows/send-issues-to-how-how-we-work-boards.yml new file mode 100644 index 000000000000..bf6e279ef5dd --- /dev/null +++ b/.github/workflows/send-issues-to-how-how-we-work-boards.yml @@ -0,0 +1,58 @@ +name: Send Issue to How We Work Boards + +on: + issues: + types: + - labeled + - reopened + +jobs: + triage: + runs-on: ubuntu-latest + continue-on-error: true + steps: + - if: contains(github.event.issue.labels.*.name, 'engineering') && !contains(github.event.issue.labels.*.name, 'feature') && !contains(github.event.issue.labels.*.name, 'epic') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 9659080; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } + - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'feature') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 13445681; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } + - if: contains(github.event.issue.labels.*.name, 'engineering') && contains(github.event.issue.labels.*.name, 'epic') + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 + with: + github-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }} + script: | + var column_id = 13445932; + try { + github.projects.createCard({ + column_id: column_id, + content_id: context.payload.issue.id, + content_type: "Issue" + }); + } catch (error) { + console.log(error); + } diff --git a/assets/images/help/billing/ghas-seats-org.png b/assets/images/help/billing/ghas-seats-org.png deleted file mode 100644 index 14b78d9e4f9c..000000000000 Binary files a/assets/images/help/billing/ghas-seats-org.png and /dev/null differ diff --git a/assets/images/help/dependabot/dependabot-secrets.png b/assets/images/help/dependabot/dependabot-secrets.png new file mode 100644 index 000000000000..74aba9a0bbc0 Binary files /dev/null and b/assets/images/help/dependabot/dependabot-secrets.png differ diff --git a/assets/images/help/dependabot/secret-repository-access.png b/assets/images/help/dependabot/secret-repository-access.png new file mode 100644 index 000000000000..a4bd31286156 Binary files /dev/null and b/assets/images/help/dependabot/secret-repository-access.png differ diff --git a/assets/images/help/dependabot/update-remove-org-secret.png b/assets/images/help/dependabot/update-remove-org-secret.png new file mode 100644 index 000000000000..94b7a0b8045c Binary files /dev/null and b/assets/images/help/dependabot/update-remove-org-secret.png differ diff --git a/assets/images/help/dependabot/update-remove-repo-secret.png b/assets/images/help/dependabot/update-remove-repo-secret.png new file mode 100644 index 000000000000..dcbc3a0df463 Binary files /dev/null and b/assets/images/help/dependabot/update-remove-repo-secret.png differ diff --git a/assets/images/help/notifications-v2/mobile-watch-button.png b/assets/images/help/notifications-v2/mobile-watch-button.png new file mode 100644 index 000000000000..b5a3fa3af074 Binary files /dev/null and b/assets/images/help/notifications-v2/mobile-watch-button.png differ diff --git a/assets/images/help/notifications-v2/mobile-watch-settings.png b/assets/images/help/notifications-v2/mobile-watch-settings.png new file mode 100644 index 000000000000..9b6a485bfaca Binary files /dev/null and b/assets/images/help/notifications-v2/mobile-watch-settings.png differ diff --git a/assets/images/help/package-registry/ghes-packages-diagram.png b/assets/images/help/package-registry/ghes-packages-diagram.png deleted file mode 100644 index 7006ce5c96d7..000000000000 Binary files a/assets/images/help/package-registry/ghes-packages-diagram.png and /dev/null differ diff --git a/assets/images/help/package-registry/packages-overview-diagram.png b/assets/images/help/package-registry/packages-overview-diagram.png index adf499d586cc..50f07869cc6f 100644 Binary files a/assets/images/help/package-registry/packages-overview-diagram.png and b/assets/images/help/package-registry/packages-overview-diagram.png differ diff --git a/content/README.md b/content/README.md index 79aa0fca8b3f..45b571c32317 100644 --- a/content/README.md +++ b/content/README.md @@ -228,9 +228,9 @@ includeGuides: - Optional. ### `topics` -- Purpose: Indicate the topics covered by the article. -- Type: `String` -- Optional. +- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of [this page](https://docs.github.com/en/actions/guides) can be filtered by topics and the topics are listed under the guide intro. Topics are also added to all search records that get created for each page. The search records contain a `topics` property that is used to filter search results by topics. For more information, see the [Search](/contributing/search.md) contributing guide. Refer to the content models for more details around adding topics. A full list of existing topics is located in the [allowed topics file](/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](/tests/unit/search/topics.js) will fail. +- Type: Array of `String`s +- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics or a adding a topic to a new article may not add value. ### `contributor` - Purpose: Indicate an article is contributed and maintained by a third-party organization, typically a GitHub Technology Partner. diff --git a/content/actions/guides/adding-labels-to-issues.md b/content/actions/guides/adding-labels-to-issues.md new file mode 100644 index 000000000000..618af66b80e5 --- /dev/null +++ b/content/actions/guides/adding-labels-to-issues.md @@ -0,0 +1,68 @@ +--- +title: Adding labels to issues +intro: You can use {% data variables.product.prodname_actions %} to automatically label issues. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) in a workflow to label newly opened or reopened issues. For example, you can add the `triage` label every time an issue is opened or reopened. Then, you can see all issues that need to be triaged by filtering for issues with the `triage` label. + +In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Label issues + on: + issues: + types: + - reopened + - opened + jobs: + label_issues: + runs-on: ubuntu-latest + steps: + - name: Label issues + uses: andymckay/labeler@1.0.2 + with: + add-labels: "triage" + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `add-labels` to the list of labels that you want to add to the issue. Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information about labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +5. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time an issue in your repository is opened or reopened, this workflow will add the labels that you specified to the issue. + +Test out your workflow by creating an issue in your repository. + +1. Create an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. To see the workflow run that was triggered by creating the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +3. When the workflow completes, the issue that you created should have the specified labels added. + +### Next steps + +- To learn more about additional things you can do with the `andymckay/labeler` action, like removing labels or skipping this action if the issue is assigned or has a specific label, see the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler). +- To learn more about different events that can trigger your workflow, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#issues)." The `andymckay/labeler` action only works on `issues`, `pull_request`, or `project_card` events. +- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/closing-inactive-issues.md b/content/actions/guides/closing-inactive-issues.md new file mode 100644 index 000000000000..461ef0aca2ff --- /dev/null +++ b/content/actions/guides/closing-inactive-issues.md @@ -0,0 +1,77 @@ +--- +title: Closing inactive issues +intro: You can use {% data variables.product.prodname_actions %} to comment on or close issues that have been inactive for a certain period of time. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues) to comment on and close issues that have been inactive for a certain period of time. For example, you can comment if an issue has been inactive for 30 days to prompt participants to take action. Then, if no additional activity occurs after 14 days, you can close the issue. + +In the tutorial, you will first make a workflow file that uses the [`actions/stale` action](https://github.com/marketplace/actions/close-stale-issues). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Close inactive issues + on: + schedule: + - cron: "30 1 * * *" + + jobs: + close-issues: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v3 + with: + days-before-issue-stale: 30 + days-before-issue-close: 14 + stale-issue-label: "stale" + stale-issue-message: "This issue is stale because it has been open for 30 days with no activity." + close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale." + days-before-pr-stale: -1 + days-before-pr-close: -1 + repo-token: ${{ secrets.GITHUB_TOKEN }} + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every day at 1:30 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." + - Change the value for `days-before-issue-stale` to the number of days without activity before the `actions/stale` action labels an issue. If you never want this action to label issues, set this value to `-1`. + - Change the value for `days-before-issue-close` to the number of days without activity before the `actions/stale` action closes an issue. If you never want this action to close issues, set this value to `-1`. + - Change the value for `stale-issue-label` to the label that you want to apply to issues that have been inactive for the amount of time specified by `days-before-issue-stale`. + - Change the value for `stale-issue-message` to the comment that you want to add to issues that are labeled by the `actions/stale` action. + - Change the value for `close-issue-message` to the comment that you want to add to issues that are closed by the `actions/stale` action. +5. {% data reusables.actions.commit-workflow %} + +### Expected results + +Based on the `schedule` parameter (for example, every day at 1:30 UTC), your workflow will find issues that have been inactive for the specified period of time and will add the specified comment and label. Additionally, your workflow will close any previously labeled issues if no additional activity has occurred for the specified period of time. + +{% data reusables.actions.schedule-delay %} + +You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +This workflow will only label and/or close 30 issues at a time in order to avoid rate limit abuse. You can configure this with the `operations-per-run` setting. For more information, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues). + +### Next steps + +- To learn more about additional things you can do with the `actions/stale` action, like closing inactive pull requests, ignoring issues with certain labels or milestones, or only checking issues with certain labels, see the [`actions/stale` action documentation](https://github.com/marketplace/actions/close-stale-issues). +- [Search GitHub](https://github.com/search?q=%22uses%3A+actions%2Fstale%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md new file mode 100644 index 000000000000..50f5ad45a416 --- /dev/null +++ b/content/actions/guides/commenting-on-an-issue-when-a-label-is-added.md @@ -0,0 +1,70 @@ +--- +title: Commenting on an issue when a label is added +intro: You can use {% data variables.product.prodname_actions %} to automatically comment on issues when a specific label is applied. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment) to comment on an issue when a specific label is applied. For example, when the `help-wanted` label is added to an issue, you can add a comment to encourage contributors to work on the issue. + +In the tutorial, you will first make a workflow file that uses the [`peter-evans/create-or-update-comment` action](https://github.com/marketplace/actions/create-or-update-comment). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Add comment + on: + issues: + types: + - labeled + jobs: + add-comment: + if: github.event.label.name == 'help-wanted' + runs-on: ubuntu-latest + steps: + - name: Add comment + uses: peter-evans/create-or-update-comment@v1 + with: + issue-number: ${{ github.event.issue.number }} + body: | + This issue is available for anyone to work on. **Make sure to reference this issue in your pull request.** :sparkles: Thank you for your contribution! :sparkles: + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Replace `help-wanted` in `if: github.event.label.name == 'help-wanted'` with the label that you want to act on. If you want to act on more than one label, separate the conditions with `||`. For example, `if: github.event.label.name == 'bug' || github.event.label.name == 'fix me'` will comment whenever the `bug` or `fix me` labels are added to an issue. + - Change the value for `body` to the comment that you want to add. GitHub flavored markdown is supported. For more information about markdown, see "[Basic writing and formatting syntax](/github/writing-on-github/basic-writing-and-formatting-syntax)." +5. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time an issue in your repository is labeled, this workflow will run. If the label that was added is one of the labels that you specified in your workflow file, the `peter-evans/create-or-update-comment` action will add the comment that you specified to the issue. + +Test your workflow by applying your specified label to an issue. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Label the issue with the specified label in your workflow file. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +3. To see the workflow run triggered by labeling the issue, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +4. When the workflow completes, the issue that you labeled should have a comment added. + +### Next steps + +- To learn more about additional things you can do with the `peter-evans/create-or-update-comment` action, like adding reactions, visit the [`peter-evans/create-or-update-comment` action documentation](https://github.com/marketplace/actions/create-or-update-comment). diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md index 38acc216796f..85043ac3f701 100644 --- a/content/actions/guides/index.md +++ b/content/actions/guides/index.md @@ -62,6 +62,13 @@ includeGuides: - /actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions - /actions/learn-github-actions/migrating-from-jenkins-to-github-actions - /actions/learn-github-actions/migrating-from-travis-ci-to-github-actions + - /actions/guides/using-github-actions-for-project-management + - /actions/guides/closing-inactive-issues + - /actions/guides/scheduling-issue-creation + - /actions/guides/adding-labels-to-issues + - /actions/guides/commenting-on-an-issue-when-a-label-is-added + - /actions/guides/moving-assigned-issues-on-project-boards + - /actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column --- @@ -87,3 +94,11 @@ includeGuides: + + + + + + + + diff --git a/content/actions/guides/moving-assigned-issues-on-project-boards.md b/content/actions/guides/moving-assigned-issues-on-project-boards.md new file mode 100644 index 000000000000..650cbea90d1d --- /dev/null +++ b/content/actions/guides/moving-assigned-issues-on-project-boards.md @@ -0,0 +1,75 @@ +--- +title: Moving assigned issues on project boards +intro: You can use {% data variables.product.prodname_actions %} to automatically move an issue to a specific column on a project board when the issue is assigned. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation) to automatically move an issue to a specific column on a project board when the issue is assigned. For example, when an issue is assigned, you can move it into the `In Progress` column your project board. + +In the tutorial, you will first make a workflow file that uses the [`alex-page/github-project-automation-plus` action](https://github.com/marketplace/actions/github-project-automation). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. In your repository, choose a project board. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)." +3. {% data reusables.actions.make-workflow-file %} +4. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Move assigned card + on: + issues: + types: + - assigned + jobs: + move-assigned-card: + runs-on: ubuntu-latest + steps: + - uses: alex-page/github-project-automation-plus@v0.3.0 + with: + project: Docs Work + column: In Progress + repo-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + ``` + {% endraw %} +5. Customize the parameters in your workflow file: + - Change the value for `project` to the name of your project board. If you have multiple project boards with the same name, the `alex-page/github-project-automation-plus` action will act on all projects with the specified name. + - Change the value for `column` to the name of the column where you want issues to move when they are assigned. + - Change the value for `repo-token`: + 1. Create a personal access token with the `repo` scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." + 1. Store this personal access token as a secret in your repository. For more information about storing secrets, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." + 1. In your workflow file, replace `PERSONAL_ACCESS_TOKEN` with the name of your secret. +6. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Whenever an issue in your repository is assigned, the issue will be moved to the specified project board column. If the issue is not already on the project board, it will be added to the project board. + +If your repository is user-owned, the `alex-page/github-project-automation-plus` action will act on all projects in your repository or user account that have the specified project name and column. Likewise, if your repository is organization-owned, the action will act on all projects in your repository or organization that have the specified project name and column. + +Test your workflow by assigning an issue in your repository. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Assign the issue. For more information, see "[Assigning issues and pull requests to other GitHub users](/github/managing-your-work-on-github/assigning-issues-and-pull-requests-to-other-github-users)." +3. To see the workflow run that assigning the issue triggered, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +4. When the workflow completes, the issue that you assigned should be added to the specified project board column. + +### Next steps + +- To learn more about additional things you can do with the `alex-page/github-project-automation-plus` action, like deleting or archiving project cards, visit the [`alex-page/github-project-automation-plus` action documentation](https://github.com/marketplace/actions/github-project-automation). diff --git a/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md new file mode 100644 index 000000000000..7ab58f630856 --- /dev/null +++ b/content/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column.md @@ -0,0 +1,75 @@ +--- +title: Removing a label when a card is added to a project board column +intro: You can use {% data variables.product.prodname_actions %} to automatically remove a label when an issue or pull request is added to a specific column on a project board. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler) along with a conditional to remove a label from issues and pull requests that are added to a specific column on a project board. For example, you can remove the `needs review` label when project cards are moved into the `Done` column. + +In the tutorial, you will first make a workflow file that uses the [`andymckay/labeler` action](https://github.com/marketplace/actions/simple-issue-labeler). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. Choose a project that belongs to the repository. This workflow cannot be used with projects that belong to users or organizations. You can use an existing project, or you can create a new project. For more information about creating a project, see "[Creating a project board](/github/managing-your-work-on-github/creating-a-project-board)." +3. {% data reusables.actions.make-workflow-file %} +4. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Remove labels + on: + project_card: + types: + - moved + jobs: + remove_labels: + if: github.event.project_card.column_id == '12345678' + runs-on: ubuntu-latest + steps: + - name: remove labels + uses: andymckay/labeler@master + with: + remove-labels: "needs review" + ``` + {% endraw %} +5. Customize the parameters in your workflow file: + - In `github.event.project_card.column_id == '12345678'`, replace `12345678` with the ID of the column where you want to un-label issues and pull requests that are moved there. + + To find the column ID, navigate to your project board. Next to the title of the column, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} then click **Copy column link**. The column ID is the number at the end of the copied link. For example, `24687531` is the column ID for `https://github.com/octocat/octo-repo/projects/1#column-24687531`. + + If you want to act on more than one column, separate the conditions with `||`. For example, `if github.event.project_card.column_id == '12345678' || github.event.project_card.column_id == '87654321'` will act whenever a project card is added to column `12345678` or column `87654321`. The columns may be on different project boards. + - Change the value for `remove-labels` to the list of labels that you want to remove from issues or pull requests that are moved to the specified column(s). Separate multiple labels with commas. For example, `"help wanted, good first issue"`. For more information on labels, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +6. {% data reusables.actions.commit-workflow %} + +### Testing the workflow + +Every time a project card on a project in your repository moves, this workflow will run. If the card is an issue or a pull request and is moved into the column that you specified, then the workflow will remove the specified labels from the issue or a pull request. Cards that are notes will not be affected. + +Test your workflow out by moving an issue on your project into the target column. + +1. Open an issue in your repository. For more information, see "[Creating an issue](/github/managing-your-work-on-github/creating-an-issue)." +2. Label the issue with the labels that you want the workflow to remove. For more information, see "[Managing labels](/github/managing-your-work-on-github/managing-labels#applying-labels-to-issues-and-pull-requests)." +3. Add the issue to the project column that you specified in your workflow file. For more information, see "[Adding issues and pull requests to a project board](/github/managing-your-work-on-github/adding-issues-and-pull-requests-to-a-project-board)." +4. To see the workflow run that was triggered by adding the issue to the project, view the history of your workflow runs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +5. When the workflow completes, the issue that you added to the project column should have the specified labels removed. + +### Next steps + +- To learn more about additional things you can do with the `andymckay/labeler` action, like adding labels or skipping this action if the issue is assigned or has a specific label, visit the [`andymckay/labeler` action documentation](https://github.com/marketplace/actions/simple-issue-labeler). +- [Search GitHub](https://github.com/search?q=%22uses:+andymckay/labeler%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/scheduling-issue-creation.md b/content/actions/guides/scheduling-issue-creation.md new file mode 100644 index 000000000000..d61c7f7ea639 --- /dev/null +++ b/content/actions/guides/scheduling-issue-creation.md @@ -0,0 +1,89 @@ +--- +title: Scheduling issue creation +intro: You can use {% data variables.product.prodname_actions %} to create an issue on a regular basis for things like daily meetings or quarterly reviews. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'tutorial' +topics: + - 'Workflows' + - 'Project management' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + +### Introduction + +This tutorial demonstrates how to use the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action) to create an issue on a regular basis. For example, you can create an issue each week to use as the agenda for a team meeting. + +In the tutorial, you will first make a workflow file that uses the [`imjohnbo/issue-bot` action](https://github.com/marketplace/actions/issue-bot-action). Then, you will customize the workflow to suit your needs. + +### Creating the workflow + +1. {% data reusables.actions.choose-repo %} +2. {% data reusables.actions.make-workflow-file %} +3. Copy the following YAML contents into your workflow file. + + {% raw %} + ```yaml{:copy} + name: Weekly Team Sync + on: + schedule: + - cron: 0 07 * * 1 + + jobs: + create_issue: + name: Create team sync issue + runs-on: ubuntu-latest + steps: + - name: Create team sync issue + uses: imjohnbo/issue-bot@v3.0 + with: + assignees: "monalisa, doctocat, hubot" + labels: "weekly sync, docs-team" + title: "Team sync" + body: | + ### Agenda + + - [ ] Start the recording + - [ ] Check-ins + - [ ] Discussion points + - [ ] Post the recording + + ### Discussion Points + Add things to discuss below + + - [Work this week](https://github.com/orgs/github/projects/3) + pinned: false + close-previous: false + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + ``` + {% endraw %} +4. Customize the parameters in your workflow file: + - Change the value for `on.schedule` to dictate when you want this workflow to run. In the example above, the workflow will run every Monday at 7:00 UTC. For more information about scheduled workflows, see "[Scheduled events](/actions/reference/events-that-trigger-workflows#scheduled-events)." + - Change the value for `assignees` to the list of {% data variables.product.prodname_dotcom %} usernames that you want to assign to the issue. + - Change the value for `labels` to the list of labels that you want to apply to the issue. + - Change the value for `title` to the title that you want the issue to have. + - Change the value for `body` to the text that you want in the issue body. The `|` character allows you to use a multi-line value for this parameter. + - If you want to pin this issue in your repository, set `pinned` to `true`. For more information about pinned issues, see "[Pinning an issue to your repository](/articles/pinning-an-issue-to-your-repository)." + - If you want to close the previous issue generated by this workflow each time a new issue is created, set `close-previous` to `true`. The workflow will close the most recent issue that has the labels defined in the `labels` field. To avoid closing the wrong issue, use a unique label or combination of labels. +5. {% data reusables.actions.commit-workflow %} + +### Expected results + +Based on the `schedule` parameter (for example, every Monday at 7:00 UTC), your workflow will create a new issue with the assignees, labels, title, and body that you specified. If you set `pinned` to `true`, the workflow will pin the issue to your repository. If you set `close-previous` to true, the workflow will close the most recent issue with matching labels. + +{% data reusables.actions.schedule-delay %} + +You can view the history of your workflow runs to see this workflow run periodically. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +### Next steps + +- To learn more about additional things you can do with the `imjohnbo/issue-bot` action, like rotating assignees or using an issue template, see the [`imjohnbo/issue-bot` action documentation](https://github.com/marketplace/actions/issue-bot-action). +- [Search GitHub](https://github.com/search?q=%22uses%3A+imjohnbo%2Fissue-bot%22&type=code) for examples of workflows using this action. diff --git a/content/actions/guides/using-github-actions-for-project-management.md b/content/actions/guides/using-github-actions-for-project-management.md new file mode 100644 index 000000000000..d023cb4e2c0f --- /dev/null +++ b/content/actions/guides/using-github-actions-for-project-management.md @@ -0,0 +1,40 @@ +--- +title: Using GitHub Actions for project management +intro: You can use {% data variables.product.prodname_actions %} to automate many of your project management tasks. +product: '{% data reusables.gated-features.actions %}' +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +type: 'overview' +topics: + - 'Project management' +--- + +You can use {% data variables.product.prodname_actions %} to automate your project management tasks by creating workflows. Each workflow contains a series of tasks that are performed automatically every time the workflow runs. For example, you can create a workflow that runs every time an issue is created to add a label, leave a comment, and move the issue onto a project board. + +### When do workflows run? + +You can configure your workflows to run on a schedule or be triggered when an event occurs. For example, you can set your workflow to run when someone creates an issue in a repository. + +Many workflow triggers are useful for automating project management. + +- An issue is opened, assigned, or labeled. +- A comment is added to an issue. +- A project card is created or moved. +- A scheduled time. + +For a full list of events that can trigger workflows, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)." + +### What can workflows do? + +Workflows can do many things, such as commenting on an issue, adding or removing labels, moving cards on project boards, and opening issues. + +You can learn about using {% data variables.product.prodname_actions %} for project management by following these tutorials, which include example workflows that you can adapt to meet your needs. + +- "[Adding labels to issues](/actions/guides/adding-labels-to-issues)" +- "[Removing a label when a card is added to a project board column](/actions/guides/removing-a-label-when-a-card-is-added-to-a-project-board-column)" +- "[Moving assigned issues on project boards](/actions/guides/moving-assigned-issues-on-project-boards)" +- "[Commenting on an issue when a label is added](/actions/guides/commenting-on-an-issue-when-a-label-is-added)" +- "[Closing inactive issues](/actions/guides/closing-inactive-issues)" +- "[Scheduling issue creation](/actions/guides/scheduling-issue-creation)" diff --git a/content/actions/learn-github-actions/security-hardening-for-github-actions.md b/content/actions/learn-github-actions/security-hardening-for-github-actions.md index 5880ba20fd5e..d5b53f25cfeb 100644 --- a/content/actions/learn-github-actions/security-hardening-for-github-actions.md +++ b/content/actions/learn-github-actions/security-hardening-for-github-actions.md @@ -123,6 +123,24 @@ For example, you can use the audit log to track the `org.update_actions_secret` The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." +{% if currentVersion == "free-pro-team@latest" %} +#### Events for environments + +| Action | Description +|------------------|------------------- +| `environment.create_actions_secret` | Triggered when a secret is created in an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.delete` | Triggered when an environment is deleted. For more information, see ["Deleting an environment](/actions/reference/environments#deleting-an-environment)." +| `environment.remove_actions_secret` | Triggered when a secret is removed from an environment. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +| `environment.update_actions_secret` | Triggered when a secret in an environment is updated. For more information, see ["Environment secrets](/actions/reference/environments#environment-secrets)." +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +#### Events for configuration changes +| Action | Description +|------------------|------------------- +| `repo.actions_enabled` | Triggered when {% data variables.product.prodname_actions %} is enabled for a repository. Can be viewed using the UI. This event is not visible when you access the audit log using the REST API. For more information, see "[Using the REST API](#using-the-rest-api)." +{% endif %} + #### Events for secret management | Action | Description |------------------|------------------- @@ -135,11 +153,15 @@ The following tables describe the {% data variables.product.prodname_actions %} #### Events for self-hosted runners | Action | Description -|------------------|------------------- +|------------------|-------------------{% if currentVersion ver_gt "enterprise-server@2.21" %}{% else %} | `enterprise.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an enterprise](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise)." -| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." +| `enterprise.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. +| `enterprise.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." +| `enterprise.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI. This event is not included when you export the audit log as JSON data or a CSV file. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)" and "[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#exporting-the-audit-log)."{% endif %} | `org.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to an organization](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization)." | `org.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see [Removing a runner from an organization](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization). +| `org.runner_group_runners_updated` | Triggered when a runner group's list of members is updated. For more information, see "[Set self-hosted runners in a group for an organization](/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization)." +| `org.runner_group_updated` | Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `org.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." | `repo.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." | `repo.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)." @@ -150,13 +172,13 @@ The following tables describe the {% data variables.product.prodname_actions %} |------------------|------------------- | `enterprise.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an enterprise](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-enterprise)." | `enterprise.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." -| `enterprise.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. +| `enterprise.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. | `enterprise.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." | `enterprise.runner_group_updated` |Triggered when the configuration of a self-hosted runner group is changed. For more information, see "[Changing the access policy of a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." | `org.runner_group_created` | Triggered when a self-hosted runner group is created. For more information, see "[Creating a self-hosted runner group for an organization](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization)." | `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." | `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." -| `org.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. +| `org.runner_group_runner_removed` | Triggered when the REST API is used to remove a self-hosted runner from a group. For more information, see "[Remove a self-hosted runner from a group for an organization](/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization)." #### Events for workflow activities diff --git a/content/actions/reference/events-that-trigger-workflows.md b/content/actions/reference/events-that-trigger-workflows.md index 9f3e2327e2ec..d1e9e8de83ed 100644 --- a/content/actions/reference/events-that-trigger-workflows.md +++ b/content/actions/reference/events-that-trigger-workflows.md @@ -43,11 +43,7 @@ The following steps occur to trigger a workflow run: The `schedule` event allows you to trigger a workflow at a scheduled time. -{% note %} - -Note: Due to load, the `schedule` event may be delayed - -{% endnote %} +{% data reusables.actions.schedule-delay %} #### `schedule` @@ -725,12 +721,14 @@ on: {% data reusables.github-actions.branch-requirement %} | Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` | -| --------------------- | -------------- | ------------ | -------------| -| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - n/a | Last commit on default branch | Default branch | +| --------------------- | -------------- | ------------ | -------------| +| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - `completed`
- `requested` | Last commit on default branch | Default branch | + +{% data reusables.developer-site.limit_workflow_to_activity_types %} If you need to filter branches from this event, you can use `branches` or `branches-ignore`. -In this example, a workflow is configured to run after the separate “Run Tests” workflow completes. +In this example, a workflow is configured to run after the separate "Run Tests" workflow completes. ```yaml on: @@ -744,6 +742,27 @@ on: {% endif %} +To run a workflow job conditionally based on the result of the previous workflow run, you can use the [`jobs..if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif) or [`jobs..steps[*].if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsif) conditional combined with the `conclusion` of the previous run. For example: + +```yaml +on: + workflow_run: + workflows: ["Build"] + types: [completed] + +jobs: + on-success: + runs-on: ubuntu-latest + if: {% raw %}${{ github.event.workflow_run.conclusion == 'success' }}{% endraw %} + steps: + ... + on-failure: + runs-on: ubuntu-latest + if: {% raw %}${{ github.event.workflow_run.conclusion == 'failure' }}{% endraw %} + steps: + ... +``` + ### Triggering new workflows using a personal access token {% data reusables.github-actions.actions-do-not-trigger-workflows %} For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index c59edbf1010c..2ab089a0ed64 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - billing --- {% data reusables.actions.enterprise-beta %} diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 9883e1bca38e..c5431f7372f2 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -314,7 +314,6 @@ Available {% data variables.product.prodname_dotcom %}-hosted runner types are: {% data reusables.github-actions.supported-github-runners %} -{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.macos-runner-preview %} ##### Example diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index bbcebb10c5a3..8a6228e0bb80 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -55,7 +55,6 @@ Hardware specification for macOS virtual machines: {% data reusables.github-actions.supported-github-runners %} -{% data reusables.github-actions.ubuntu-runner-preview %} {% data reusables.github-actions.macos-runner-preview %} Workflow logs list the runner used to run a job. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." diff --git a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md index c1ccb9a41745..097850a1339d 100644 --- a/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md +++ b/content/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/allowing-built-in-authentication-for-users-outside-your-identity-provider versions: enterprise-server: '*' +topics: + - enterprise --- ### About built-in authentication for users outside your identity provider diff --git a/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md b/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md index e21b5d8ae4f2..cc0d48b47cd1 100644 --- a/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md +++ b/content/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance.md @@ -11,5 +11,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/authentication/changing-authentication-methods.md b/content/admin/authentication/changing-authentication-methods.md index b3f8f58c0532..b9a864ebe2a6 100644 --- a/content/admin/authentication/changing-authentication-methods.md +++ b/content/admin/authentication/changing-authentication-methods.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/changing-authentication-methods versions: enterprise-server: '*' +topics: + - enterprise --- User accounts on {% data variables.product.product_location %} are preserved when you change the authentication method and users will continue to log into the same account as long as their username doesn't change. diff --git a/content/admin/authentication/disabling-unauthenticated-sign-ups.md b/content/admin/authentication/disabling-unauthenticated-sign-ups.md index 5987411ce0d9..cd9861decca8 100644 --- a/content/admin/authentication/disabling-unauthenticated-sign-ups.md +++ b/content/admin/authentication/disabling-unauthenticated-sign-ups.md @@ -7,6 +7,8 @@ redirect_from: intro: 'If you''re using built-in authentication, you can block unauthenticated people from being able to create an account.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_site_admin_settings.access-settings %} diff --git a/content/admin/authentication/index.md b/content/admin/authentication/index.md index deacdaf76f0d..b55ee5094f13 100644 --- a/content/admin/authentication/index.md +++ b/content/admin/authentication/index.md @@ -1,11 +1,13 @@ --- title: Authentication -intro: You can configure how users sign into {% data variables.product.product_name %}. +intro: 'You can configure how users sign into {% data variables.product.product_name %}.' redirect_from: - /enterprise/admin/authentication versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/authentication/using-built-in-authentication.md b/content/admin/authentication/using-built-in-authentication.md index 4df510e488bc..0e05f30cd0dd 100644 --- a/content/admin/authentication/using-built-in-authentication.md +++ b/content/admin/authentication/using-built-in-authentication.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/authentication/using-built-in-authentication versions: enterprise-server: '*' +topics: + - enterprise --- You can create custom messages that users will see on the sign in and sign out pages. For more information, see "[Customizing user messages on your instance](/enterprise/admin/user-management/customizing-user-messages-on-your-instance)." diff --git a/content/admin/authentication/using-cas.md b/content/admin/authentication/using-cas.md index fa765d66b83b..d5c29850907b 100644 --- a/content/admin/authentication/using-cas.md +++ b/content/admin/authentication/using-cas.md @@ -8,6 +8,8 @@ redirect_from: intro: 'CAS is a single sign-on (SSO) protocol for multiple web applications. A CAS user account does not take up a {% if currentVersion ver_gt "enterprise-server@2.16" %}user license{% else %}seat{% endif %} until the user signs in.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-ldap.md b/content/admin/authentication/using-ldap.md index 959c6df2fba4..53858a708b76 100644 --- a/content/admin/authentication/using-ldap.md +++ b/content/admin/authentication/using-ldap.md @@ -11,6 +11,8 @@ redirect_from: intro: 'LDAP lets you authenticate {% data variables.product.prodname_ghe_server %} against your existing accounts and centrally manage repository access. LDAP is a popular application protocol for accessing and maintaining directory information services, and is one of the most common protocols used to integrate third-party software with large company user directories.' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/authentication/using-saml.md b/content/admin/authentication/using-saml.md index e4cdd3808ee9..2da3fd18ccfa 100644 --- a/content/admin/authentication/using-saml.md +++ b/content/admin/authentication/using-saml.md @@ -8,6 +8,8 @@ redirect_from: intro: 'SAML is an XML-based standard for authentication and authorization. {% data variables.product.prodname_ghe_server %} can act as a service provider (SP) with your internal SAML identity provider (IdP).' versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_user_management.built-in-authentication %} diff --git a/content/admin/configuration/about-enterprise-configuration.md b/content/admin/configuration/about-enterprise-configuration.md index 8f90db06228d..1436036526e0 100644 --- a/content/admin/configuration/about-enterprise-configuration.md +++ b/content/admin/configuration/about-enterprise-configuration.md @@ -4,6 +4,8 @@ intro: 'You can use the site admin dashboard{% if enterpriseServerVersions conta versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/accessing-the-administrative-shell-ssh.md b/content/admin/configuration/accessing-the-administrative-shell-ssh.md index 73cf3530c7eb..939c25bd3797 100644 --- a/content/admin/configuration/accessing-the-administrative-shell-ssh.md +++ b/content/admin/configuration/accessing-the-administrative-shell-ssh.md @@ -13,6 +13,8 @@ redirect_from: intro: '{% data reusables.enterprise_site_admin_settings.about-ssh-access %}' versions: enterprise-server: '*' +topics: + - enterprise --- ### About administrative shell access diff --git a/content/admin/configuration/accessing-the-management-console.md b/content/admin/configuration/accessing-the-management-console.md index 94a312d87735..62921a128c10 100644 --- a/content/admin/configuration/accessing-the-management-console.md +++ b/content/admin/configuration/accessing-the-management-console.md @@ -12,6 +12,8 @@ redirect_from: - /enterprise/admin/configuration/accessing-the-management-console versions: enterprise-server: '*' +topics: + - enterprise --- ### About the {% data variables.enterprise.management_console %} diff --git a/content/admin/configuration/command-line-utilities.md b/content/admin/configuration/command-line-utilities.md index d10388e2f96f..6abacadb3cf2 100644 --- a/content/admin/configuration/command-line-utilities.md +++ b/content/admin/configuration/command-line-utilities.md @@ -9,6 +9,8 @@ redirect_from: miniTocMaxHeadingLevel: 4 versions: enterprise-server: '*' +topics: + - enterprise --- You can execute these commands from anywhere on the VM after signing in as an SSH admin user. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/)." diff --git a/content/admin/configuration/configuring-a-hostname.md b/content/admin/configuration/configuring-a-hostname.md index 3e7bd4b662ab..981e4abd9f6c 100644 --- a/content/admin/configuration/configuring-a-hostname.md +++ b/content/admin/configuration/configuring-a-hostname.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-a-hostname versions: enterprise-server: '*' +topics: + - enterprise --- If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software. diff --git a/content/admin/configuration/configuring-advanced-security-features.md b/content/admin/configuration/configuring-advanced-security-features.md index e9a8a1113feb..353c1e424618 100644 --- a/content/admin/configuration/configuring-advanced-security-features.md +++ b/content/admin/configuration/configuring-advanced-security-features.md @@ -7,5 +7,7 @@ redirect_from: - /enterprise/admin/configuration/configuring-advanced-security-features versions: enterprise-server: '>=2.22' +topics: + - enterprise --- diff --git a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md index 8a398553fa42..b58ca8f40074 100644 --- a/content/admin/configuration/configuring-an-outbound-web-proxy-server.md +++ b/content/admin/configuration/configuring-an-outbound-web-proxy-server.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-an-outbound-web-proxy-server versions: enterprise-server: '*' +topics: + - enterprise --- When a proxy server is enabled for {% data variables.product.product_location %}, outbound messages sent by {% data variables.product.prodname_ghe_server %} are first sent through the proxy server, unless the destination host is added as an HTTP proxy exclusion. Types of outbound messages include outgoing webhooks, uploading bundles, and fetching legacy avatars. The proxy server's URL is the protocol, domain or IP address, plus the port number, for example `http://127.0.0.1:8123`. diff --git a/content/admin/configuration/configuring-applications.md b/content/admin/configuration/configuring-applications.md index 534c4c76d9af..da0908fc888f 100644 --- a/content/admin/configuration/configuring-applications.md +++ b/content/admin/configuration/configuring-applications.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-applications versions: enterprise-server: '*' +topics: + - enterprise --- ### Adjusting image caching diff --git a/content/admin/configuration/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-backups-on-your-appliance.md index dbea15fc2644..62754fac2419 100644 --- a/content/admin/configuration/configuring-backups-on-your-appliance.md +++ b/content/admin/configuration/configuring-backups-on-your-appliance.md @@ -15,6 +15,8 @@ redirect_from: intro: 'As part of a disaster recovery plan, you can protect production data on {% data variables.product.product_location %} by configuring automated backups.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_enterprise_backup_utilities %} diff --git a/content/admin/configuration/configuring-built-in-firewall-rules.md b/content/admin/configuration/configuring-built-in-firewall-rules.md index 1ee5bcda80c2..73415a9df1f4 100644 --- a/content/admin/configuration/configuring-built-in-firewall-rules.md +++ b/content/admin/configuration/configuring-built-in-firewall-rules.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-built-in-firewall-rules versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.product_location %}'s firewall diff --git a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md index 7b579bfe1dd9..152e36452ec1 100644 --- a/content/admin/configuration/configuring-code-scanning-for-your-appliance.md +++ b/content/admin/configuration/configuring-code-scanning-for-your-appliance.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-code-scanning-for-your-appliance versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.code-scanning.beta %} diff --git a/content/admin/configuration/configuring-dns-nameservers.md b/content/admin/configuration/configuring-dns-nameservers.md index 5e3dd8edbf83..89d69a723c34 100644 --- a/content/admin/configuration/configuring-dns-nameservers.md +++ b/content/admin/configuration/configuring-dns-nameservers.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-dns-nameservers versions: enterprise-server: '*' +topics: + - enterprise --- The nameservers you specify must resolve {% data variables.product.product_location %}'s hostname. diff --git a/content/admin/configuration/configuring-email-for-notifications.md b/content/admin/configuration/configuring-email-for-notifications.md index 665d0177ca72..25ae0e9c526d 100644 --- a/content/admin/configuration/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-email-for-notifications.md @@ -1,6 +1,6 @@ --- title: Configuring email for notifications -intro: To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments. +intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments.' redirect_from: - /enterprise/admin/guides/installation/email-configuration/ - /enterprise/admin/articles/configuring-email/ @@ -10,6 +10,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md index 29a92ff609f6..3a27d659cc6b 100644 --- a/content/admin/configuration/configuring-github-pages-for-your-enterprise.md +++ b/content/admin/configuration/configuring-github-pages-for-your-enterprise.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Enabling public sites for {% data variables.product.prodname_pages %} diff --git a/content/admin/configuration/configuring-network-settings.md b/content/admin/configuration/configuring-network-settings.md index b5d7abf7e09d..fe94a7b2b0c1 100644 --- a/content/admin/configuration/configuring-network-settings.md +++ b/content/admin/configuration/configuring-network-settings.md @@ -11,5 +11,7 @@ intro: 'Configure {% data variables.product.prodname_ghe_server %} with the DNS mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/configuring-rate-limits.md b/content/admin/configuration/configuring-rate-limits.md index 5cffccdf1693..46f56ef79e54 100644 --- a/content/admin/configuration/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-rate-limits.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-rate-limits versions: enterprise-server: '*' +topics: + - enterprise --- ### Enabling rate limits for {% data variables.product.prodname_enterprise_api %} diff --git a/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md b/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md index b806b45f2995..361702b4b3bb 100644 --- a/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md +++ b/content/admin/configuration/configuring-secret-scanning-for-your-appliance.md @@ -6,6 +6,8 @@ product: '{% data reusables.gated-features.secret-scanning %}' miniTocMaxHeadingLevel: 4 versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% data reusables.secret-scanning.beta %} diff --git a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md index c8b25b42dcc7..f814b48cf9c9 100644 --- a/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md +++ b/content/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-the-ip-address-using-the-virtual-machine-console versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/configuration/configuring-time-synchronization.md b/content/admin/configuration/configuring-time-synchronization.md index d9042f873dcf..a71272ab860a 100644 --- a/content/admin/configuration/configuring-time-synchronization.md +++ b/content/admin/configuration/configuring-time-synchronization.md @@ -10,6 +10,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-time-synchronization versions: enterprise-server: '*' +topics: + - enterprise --- ### Changing the default NTP servers diff --git a/content/admin/configuration/configuring-tls.md b/content/admin/configuration/configuring-tls.md index fd106938d1f5..4b9d1bb375d5 100644 --- a/content/admin/configuration/configuring-tls.md +++ b/content/admin/configuration/configuring-tls.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/configuring-tls versions: enterprise-server: '*' +topics: + - enterprise --- ### About Transport Layer Security diff --git a/content/admin/configuration/configuring-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise.md index 5afbbe175155..641f5e61093a 100644 --- a/content/admin/configuration/configuring-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Configuring your enterprise -intro: "After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization's needs." +intro: 'After {% data variables.product.product_name %} is up and running, you can configure your enterprise to suit your organization''s needs.' redirect_from: - /enterprise/admin/guides/installation/basic-configuration/ - /enterprise/admin/guides/installation/administrative-tools/ @@ -12,5 +12,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md index f3e412341cfb..30be76ad5171 100644 --- a/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md +++ b/content/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_github_connect %} diff --git a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md index 8d25c497ef94..3311ca660537 100644 --- a/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md +++ b/content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md @@ -8,6 +8,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot %}{% else %}security{% endif %} alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %}.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About alerts for vulnerable dependencies on {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md index 832241da5f92..52dfaa160ba6 100644 --- a/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md +++ b/content/admin/configuration/enabling-and-scheduling-maintenance-mode.md @@ -12,6 +12,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-and-scheduling-maintenance-mode versions: enterprise-server: '*' +topics: + - enterprise --- ### About maintenance mode diff --git a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md index a320a62917a3..3c161a317111 100644 --- a/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/admin/configuration/enabling-automatic-user-license-sync-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -7,6 +7,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable automatic user license synchronization.' versions: enterprise-server: '*' +topics: + - enterprise --- ### About license synchronization diff --git a/content/admin/configuration/enabling-private-mode.md b/content/admin/configuration/enabling-private-mode.md index 831e440b7ff8..1e32ab673fbc 100644 --- a/content/admin/configuration/enabling-private-mode.md +++ b/content/admin/configuration/enabling-private-mode.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-private-mode versions: enterprise-server: '*' +topics: + - enterprise --- You must enable private mode if {% data variables.product.product_location %} is publicly accessible over the Internet. In private mode, users cannot anonymously clone repositories over `git://`. If built-in authentication is also enabled, an administrator must invite new users to create an account on the instance. For more information, see "[Using built-in authentication](/enterprise/{{ currentVersion }}/admin/guides/user-management/using-built-in-authentication)." diff --git a/content/admin/configuration/enabling-subdomain-isolation.md b/content/admin/configuration/enabling-subdomain-isolation.md index 76012af69f84..782d4033e734 100644 --- a/content/admin/configuration/enabling-subdomain-isolation.md +++ b/content/admin/configuration/enabling-subdomain-isolation.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/enabling-subdomain-isolation versions: enterprise-server: '*' +topics: + - enterprise --- ### About subdomain isolation diff --git a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md index 7c85654bea55..2d609c74fbc5 100644 --- a/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-contributions-between-github-enterprise-server-and-githubcom.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified contributions between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '*' +topics: + - enterprise --- As a site administrator, you can allow end users to send anonymized contribution counts for their work from {% data variables.product.prodname_ghe_server %} to their {% data variables.product.prodname_dotcom_the_website %} contribution graph. diff --git a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md index 33130ca6fe11..d34e2ebdba38 100644 --- a/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md +++ b/content/admin/configuration/enabling-unified-search-between-github-enterprise-server-and-githubcom.md @@ -10,6 +10,8 @@ redirect_from: permissions: 'Site administrators for {% data variables.product.prodname_ghe_server %} who are also owners of the connected {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable unified search between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_dotcom_the_website %}.' versions: enterprise-server: '*' +topics: + - enterprise --- When you enable unified search, users can view search results from public and private content on {% data variables.product.prodname_dotcom_the_website %} when searching from {% data variables.product.product_location_enterprise %}. diff --git a/content/admin/configuration/index.md b/content/admin/configuration/index.md index ee042551f25e..1cfa0079a803 100644 --- a/content/admin/configuration/index.md +++ b/content/admin/configuration/index.md @@ -1,12 +1,14 @@ --- title: Configuring GitHub Enterprise shortTitle: Configuring GitHub Enterprise -intro: "You can configure your enterprise to suit your organization's needs." +intro: You can configure your enterprise to suit your organization's needs. redirect_from: - /enterprise/admin/configuration versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if currentVersion ver_gt "enterprise-server@2.21" %} diff --git a/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md b/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md index 63e4e25bee0e..1fd17e838ec0 100644 --- a/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md +++ b/content/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud.md @@ -11,5 +11,7 @@ redirect_from: - /enterprise/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md index 66de92b8f4d4..fb7b3fe2dc6b 100644 --- a/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md +++ b/content/admin/configuration/managing-github-for-mobile-for-your-enterprise.md @@ -1,9 +1,11 @@ --- title: Managing GitHub for mobile for your enterprise -intro: You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}. -permissions: Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}. +intro: 'You can decide whether authenticated users can connect to {% data variables.product.product_location %} with {% data variables.product.prodname_mobile %}.' +permissions: 'Enterprise owners can manage {% data variables.product.prodname_mobile %} for an enterprise on {% data variables.product.product_name %}.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/configuration/network-ports.md b/content/admin/configuration/network-ports.md index 9a4688b5f2db..22f578d8d347 100644 --- a/content/admin/configuration/network-ports.md +++ b/content/admin/configuration/network-ports.md @@ -10,6 +10,8 @@ redirect_from: intro: 'Open network ports selectively based on the network services you need to expose for administrators, end users, and email support.' versions: enterprise-server: '*' +topics: + - enterprise --- ### Administrative ports diff --git a/content/admin/configuration/site-admin-dashboard.md b/content/admin/configuration/site-admin-dashboard.md index da953a8cd384..df0c32529228 100644 --- a/content/admin/configuration/site-admin-dashboard.md +++ b/content/admin/configuration/site-admin-dashboard.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/site-admin-dashboard versions: enterprise-server: '*' +topics: + - enterprise --- To access the dashboard, in the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. diff --git a/content/admin/configuration/troubleshooting-ssl-errors.md b/content/admin/configuration/troubleshooting-ssl-errors.md index 61c4bb3ce97a..8271cc47b2ce 100644 --- a/content/admin/configuration/troubleshooting-ssl-errors.md +++ b/content/admin/configuration/troubleshooting-ssl-errors.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/configuration/troubleshooting-ssl-errors versions: enterprise-server: '*' +topics: + - enterprise --- ### Removing the passphrase from your key file diff --git a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md index 539b679d7354..869cc35ff04c 100644 --- a/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md +++ b/content/admin/configuration/using-github-enterprise-server-with-a-load-balancer.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/configuration/using-github-enterprise-server-with-a-load-balancer versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.load_balancer_intro %} diff --git a/content/admin/configuration/validating-your-domain-settings.md b/content/admin/configuration/validating-your-domain-settings.md index 1c731a310c8a..581679b205db 100644 --- a/content/admin/configuration/validating-your-domain-settings.md +++ b/content/admin/configuration/validating-your-domain-settings.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/configuration/validating-your-domain-settings versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} diff --git a/content/admin/enterprise-management/about-cluster-nodes.md b/content/admin/enterprise-management/about-cluster-nodes.md index 74a1a75fe313..463b8781a0c5 100644 --- a/content/admin/enterprise-management/about-cluster-nodes.md +++ b/content/admin/enterprise-management/about-cluster-nodes.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-cluster-nodes versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.clustering-requires-https %} diff --git a/content/admin/enterprise-management/about-clustering.md b/content/admin/enterprise-management/about-clustering.md index 8b3345da8547..1a1157bb0d43 100644 --- a/content/admin/enterprise-management/about-clustering.md +++ b/content/admin/enterprise-management/about-clustering.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-clustering versions: enterprise-server: '*' +topics: + - enterprise --- ### Clustering architecture diff --git a/content/admin/enterprise-management/about-geo-replication.md b/content/admin/enterprise-management/about-geo-replication.md index dfa868e556a8..b72945375ba8 100644 --- a/content/admin/enterprise-management/about-geo-replication.md +++ b/content/admin/enterprise-management/about-geo-replication.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-geo-replication versions: enterprise-server: '*' +topics: + - enterprise --- Multiple active replicas can provide a shorter distance to the nearest replica. For example, an organization with offices in San Francisco, New York, and London could run the primary appliance in a datacenter near New York and two replicas in datacenters near San Francisco and London. Using geolocation-aware DNS, users can be directed to the closest server available and access repository data faster. Designating the appliance near New York as the primary helps reduce the latency between the hosts, compared to the appliance near San Francisco being the primary which has a higher latency to London. diff --git a/content/admin/enterprise-management/about-high-availability-configuration.md b/content/admin/enterprise-management/about-high-availability-configuration.md index 724be83b78a7..19b544937193 100644 --- a/content/admin/enterprise-management/about-high-availability-configuration.md +++ b/content/admin/enterprise-management/about-high-availability-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/about-high-availability-configuration versions: enterprise-server: '*' +topics: + - enterprise --- When you configure high availability, there is an automated setup of one-way, asynchronous replication of all datastores (Git repositories, MySQL, Redis, and Elasticsearch) from the primary to the replica appliance. diff --git a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md index a83ec1d35979..b7182b0edf1d 100644 --- a/content/admin/enterprise-management/accessing-the-monitor-dashboard.md +++ b/content/admin/enterprise-management/accessing-the-monitor-dashboard.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/accessing-the-monitor-dashboard versions: enterprise-server: '*' +topics: + - enterprise --- ### Accessing the monitor dashboard diff --git a/content/admin/enterprise-management/cluster-network-configuration.md b/content/admin/enterprise-management/cluster-network-configuration.md index b11cc7bb1fd5..80f91507d721 100644 --- a/content/admin/enterprise-management/cluster-network-configuration.md +++ b/content/admin/enterprise-management/cluster-network-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/cluster-network-configuration versions: enterprise-server: '*' +topics: + - enterprise --- ### Network considerations diff --git a/content/admin/enterprise-management/configuring-clustering.md b/content/admin/enterprise-management/configuring-clustering.md index 6fc9f34af1ac..6752ddf050c8 100644 --- a/content/admin/enterprise-management/configuring-clustering.md +++ b/content/admin/enterprise-management/configuring-clustering.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/configuring-collectd.md b/content/admin/enterprise-management/configuring-collectd.md index 4196beb841db..7ce2e846c811 100644 --- a/content/admin/enterprise-management/configuring-collectd.md +++ b/content/admin/enterprise-management/configuring-collectd.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-collectd versions: enterprise-server: '*' +topics: + - enterprise --- ### Set up an external `collectd` server diff --git a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md index 9cf229f15455..deb7ebbf601b 100644 --- a/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md +++ b/content/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster versions: enterprise-server: '>2.21' +topics: + - enterprise --- ### About high availability replication for clusters diff --git a/content/admin/enterprise-management/configuring-high-availability.md b/content/admin/enterprise-management/configuring-high-availability.md index 84b7b0ae9f98..bd994c784885 100644 --- a/content/admin/enterprise-management/configuring-high-availability.md +++ b/content/admin/enterprise-management/configuring-high-availability.md @@ -10,5 +10,7 @@ intro: '{% data variables.product.prodname_ghe_server %} supports a high availab mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/creating-a-high-availability-replica.md b/content/admin/enterprise-management/creating-a-high-availability-replica.md index 9c124a1eb876..8a032953fbdf 100644 --- a/content/admin/enterprise-management/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/creating-a-high-availability-replica.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/creating-a-high-availability-replica versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating a high availability replica diff --git a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md index 9ac3ba2f73fb..59d4847dd947 100644 --- a/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md +++ b/content/admin/enterprise-management/differences-between-clustering-and-high-availability-ha.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha versions: enterprise-server: '*' +topics: + - enterprise --- ### Failure scenarios diff --git a/content/admin/enterprise-management/enabling-automatic-update-checks.md b/content/admin/enterprise-management/enabling-automatic-update-checks.md index 07f741e1bc61..3c53bfa0a555 100644 --- a/content/admin/enterprise-management/enabling-automatic-update-checks.md +++ b/content/admin/enterprise-management/enabling-automatic-update-checks.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/enabling-automatic-update-checks versions: enterprise-server: '*' +topics: + - enterprise --- When an upgrade package is automatically downloaded for {% data variables.product.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.product.product_location %}. For more information, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/enterprise/{{ currentVersion }}/admin/guides/installation/upgrading-github-enterprise-server)." diff --git a/content/admin/enterprise-management/evacuating-a-cluster-node.md b/content/admin/enterprise-management/evacuating-a-cluster-node.md index c429e9270723..a93e152668b8 100644 --- a/content/admin/enterprise-management/evacuating-a-cluster-node.md +++ b/content/admin/enterprise-management/evacuating-a-cluster-node.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/evacuating-a-cluster-node versions: enterprise-server: '*' +topics: + - enterprise --- If you only have three nodes in your data services cluster, you can't evacuate the nodes, because `ghe-spokes` doesn’t have another place to make a copy. If you have four or more, `ghe-spokes` will move all the repositories off of the evacuated node. diff --git a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md index 70ad38778a38..ce3e4a1acd48 100644 --- a/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md +++ b/content/admin/enterprise-management/increasing-cpu-or-memory-resources.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/increasing-storage-capacity.md b/content/admin/enterprise-management/increasing-storage-capacity.md index 2c893b226eb9..1db820873166 100644 --- a/content/admin/enterprise-management/increasing-storage-capacity.md +++ b/content/admin/enterprise-management/increasing-storage-capacity.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/increasing-storage-capacity versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_installation.warning-on-upgrading-physical-resources %} diff --git a/content/admin/enterprise-management/index.md b/content/admin/enterprise-management/index.md index faaf069973dc..cc6f503d0af2 100644 --- a/content/admin/enterprise-management/index.md +++ b/content/admin/enterprise-management/index.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-management versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/initializing-the-cluster.md b/content/admin/enterprise-management/initializing-the-cluster.md index 1fc88c484a53..4ada1342843e 100644 --- a/content/admin/enterprise-management/initializing-the-cluster.md +++ b/content/admin/enterprise-management/initializing-the-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initializing-the-cluster versions: enterprise-server: '*' +topics: + - enterprise --- {% data reusables.enterprise_clustering.clustering-requires-https %} diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md index 208fe0e10db3..7a9d0c47f595 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance versions: enterprise-server: '*' +topics: + - enterprise --- The time required to failover depends on how long it takes to manually promote the replica and redirect traffic. The average time ranges between 2-10 minutes. diff --git a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md index 2b0406038c92..baa4b482d36d 100644 --- a/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md +++ b/content/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster versions: enterprise-server: '>2.21' +topics: + - enterprise --- ### About failover to your replica cluster diff --git a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md index 536933512434..f28668eb3a9d 100644 --- a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md @@ -12,6 +12,8 @@ redirect_from: intro: 'To migrate from {% data variables.product.prodname_enterprise %} 11.10.x to 2.1.23, you''ll need to set up a new appliance instance and migrate data from the previous instance.' versions: enterprise-server: '*' +topics: + - enterprise --- Migrations from {% data variables.product.prodname_enterprise %} 11.10.348 and later are supported. Migrating from {% data variables.product.prodname_enterprise %} 11.10.348 and earlier is not supported. You must first upgrade to 11.10.348 in several upgrades. For more information, see the 11.10.348 upgrading procedure, "[Upgrading to the latest release](/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)." diff --git a/content/admin/enterprise-management/monitoring-cluster-nodes.md b/content/admin/enterprise-management/monitoring-cluster-nodes.md index da5fcdd1c91b..4916df38ad20 100644 --- a/content/admin/enterprise-management/monitoring-cluster-nodes.md +++ b/content/admin/enterprise-management/monitoring-cluster-nodes.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-cluster-nodes versions: enterprise-server: '*' +topics: + - enterprise --- ### Manually checking cluster status diff --git a/content/admin/enterprise-management/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-using-snmp.md index 2ef67fbbef09..bcc5821b39f8 100644 --- a/content/admin/enterprise-management/monitoring-using-snmp.md +++ b/content/admin/enterprise-management/monitoring-using-snmp.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/monitoring-using-snmp versions: enterprise-server: '*' +topics: + - enterprise --- SNMP is a common standard for monitoring devices over a network. We strongly recommend enabling SNMP so you can monitor the health of {% data variables.product.product_location %} and know when to add more memory, storage, or processor power to the host machine. diff --git a/content/admin/enterprise-management/monitoring-your-appliance.md b/content/admin/enterprise-management/monitoring-your-appliance.md index e8adac6a1100..a73f9c02e380 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance.md +++ b/content/admin/enterprise-management/monitoring-your-appliance.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/recommended-alert-thresholds.md b/content/admin/enterprise-management/recommended-alert-thresholds.md index ceae6ab760aa..3898e09a0b7d 100644 --- a/content/admin/enterprise-management/recommended-alert-thresholds.md +++ b/content/admin/enterprise-management/recommended-alert-thresholds.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-management/recommended-alert-thresholds versions: enterprise-server: '*' +topics: + - enterprise --- ### Monitoring storage diff --git a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md index 879390f39009..cc9cd0027eb8 100644 --- a/content/admin/enterprise-management/recovering-a-high-availability-configuration.md +++ b/content/admin/enterprise-management/recovering-a-high-availability-configuration.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/recovering-a-high-availability-configuration versions: enterprise-server: '*' +topics: + - enterprise --- You can use the former primary appliance as the new replica appliance if the failover was planned or was not related to the health of the appliance. If the failover was related to an issue with the primary appliance, you may prefer to create a new replica appliance. For more information, see "[Creating a high availability replica](/enterprise/{{ currentVersion }}/admin/guides/installation/creating-a-high-availability-replica/)." diff --git a/content/admin/enterprise-management/removing-a-high-availability-replica.md b/content/admin/enterprise-management/removing-a-high-availability-replica.md index 6002b89d1bb4..7f3ab841b7aa 100644 --- a/content/admin/enterprise-management/removing-a-high-availability-replica.md +++ b/content/admin/enterprise-management/removing-a-high-availability-replica.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/removing-a-high-availability-replica versions: enterprise-server: '*' +topics: + - enterprise --- ### Stopping replication temporarily diff --git a/content/admin/enterprise-management/replacing-a-cluster-node.md b/content/admin/enterprise-management/replacing-a-cluster-node.md index 4dde19d03866..2f96afbd7d58 100644 --- a/content/admin/enterprise-management/replacing-a-cluster-node.md +++ b/content/admin/enterprise-management/replacing-a-cluster-node.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/replacing-a-cluster-node versions: enterprise-server: '*' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/enterprise-management/setting-up-external-monitoring.md b/content/admin/enterprise-management/setting-up-external-monitoring.md index f0163ff946e8..21031f8d8f89 100644 --- a/content/admin/enterprise-management/setting-up-external-monitoring.md +++ b/content/admin/enterprise-management/setting-up-external-monitoring.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/setting-up-external-monitoring versions: enterprise-server: '*' +topics: + - enterprise --- ### About SNMP diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md index 3c590160d033..b40afca279f0 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources.md @@ -9,5 +9,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/enterprise-management/upgrade-requirements.md b/content/admin/enterprise-management/upgrade-requirements.md index 60da0b3d304e..c06792a75158 100644 --- a/content/admin/enterprise-management/upgrade-requirements.md +++ b/content/admin/enterprise-management/upgrade-requirements.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrade-requirements versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-management/upgrading-a-cluster.md b/content/admin/enterprise-management/upgrading-a-cluster.md index 1be8e7d8b5cc..19fd10ebcd78 100644 --- a/content/admin/enterprise-management/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/upgrading-a-cluster.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-a-cluster versions: enterprise-server: '*' +topics: + - enterprise --- ### Upgrading with a hotpatch {% data reusables.enterprise_installation.hotpatching-explanation %} The hotpatch installation script installs the hotpatch on every node in the cluster and restarts the services in their proper sequence to avoid downtime. diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md index daefc6db50fb..a839c0341094 100644 --- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md @@ -15,6 +15,8 @@ redirect_from: - /enterprise/admin/enterprise-management/upgrading-github-enterprise-server versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing to upgrade @@ -251,4 +253,4 @@ To roll back from a feature release, restore from a VM snapshot to ensure that r ### Further reading - "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/enterprise-support/about-github-enterprise-support.md b/content/admin/enterprise-support/about-github-enterprise-support.md index 696ce3441c65..f731cfec522d 100644 --- a/content/admin/enterprise-support/about-github-enterprise-support.md +++ b/content/admin/enterprise-support/about-github-enterprise-support.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md index ecdcf023223f..de2131bec7ae 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise-server versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md index b55487a008e0..8553ddf3dac4 100644 --- a/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md +++ b/content/admin/enterprise-support/about-github-premium-support-for-github-enterprise.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-github-premium-support-for-github-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/about-support-for-advanced-security.md b/content/admin/enterprise-support/about-support-for-advanced-security.md index f1eadede3a1e..d9f8d78ef9d1 100644 --- a/content/admin/enterprise-support/about-support-for-advanced-security.md +++ b/content/admin/enterprise-support/about-support-for-advanced-security.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/enterprise-support/about-support-for-advanced-security versions: enterprise-server: '*' +topics: + - enterprise --- {% note %} diff --git a/content/admin/enterprise-support/index.md b/content/admin/enterprise-support/index.md index d6f1ed919145..1393d3bc8194 100644 --- a/content/admin/enterprise-support/index.md +++ b/content/admin/enterprise-support/index.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Table of Contents diff --git a/content/admin/enterprise-support/overview.md b/content/admin/enterprise-support/overview.md index 67f3ad9d93fd..ce8e4498c5e8 100644 --- a/content/admin/enterprise-support/overview.md +++ b/content/admin/enterprise-support/overview.md @@ -7,4 +7,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md index 9c70a25abf5e..4f0ebdb6d5f4 100644 --- a/content/admin/enterprise-support/preparing-to-submit-a-ticket.md +++ b/content/admin/enterprise-support/preparing-to-submit-a-ticket.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Before submitting a ticket, you should: @@ -24,4 +26,4 @@ Especially for tickets with {% data variables.product.support_ticket_priority_ur - Be knowledgeable in your internal systems, tools, policies, and practices. - Be a proficient user of {% data variables.product.product_name %}. - Have full access and permissions to any services that are required to troubleshoot the issue. - - Be authorized to make the recommended changes to your network and any applicable products. \ No newline at end of file + - Be authorized to make the recommended changes to your network and any applicable products. diff --git a/content/admin/enterprise-support/providing-data-to-github-support.md b/content/admin/enterprise-support/providing-data-to-github-support.md index 2bb07afaab08..3ea698137236 100644 --- a/content/admin/enterprise-support/providing-data-to-github-support.md +++ b/content/admin/enterprise-support/providing-data-to-github-support.md @@ -8,6 +8,8 @@ redirect_from: - /enterprise/admin/enterprise-support/providing-data-to-github-support versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating and sharing diagnostic files diff --git a/content/admin/enterprise-support/reaching-github-support.md b/content/admin/enterprise-support/reaching-github-support.md index 7cf256ce5605..51d55999d7dd 100644 --- a/content/admin/enterprise-support/reaching-github-support.md +++ b/content/admin/enterprise-support/reaching-github-support.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/enterprise-support/reaching-github-support versions: enterprise-server: '*' +topics: + - enterprise --- ### Using automated ticketing systems diff --git a/content/admin/enterprise-support/receiving-help-from-github-support.md b/content/admin/enterprise-support/receiving-help-from-github-support.md index 98b3cd0eeaf2..c700ae6897bb 100644 --- a/content/admin/enterprise-support/receiving-help-from-github-support.md +++ b/content/admin/enterprise-support/receiving-help-from-github-support.md @@ -8,4 +8,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/enterprise-support/submitting-a-ticket.md b/content/admin/enterprise-support/submitting-a-ticket.md index 5f396e34caac..cb1682372894 100644 --- a/content/admin/enterprise-support/submitting-a-ticket.md +++ b/content/admin/enterprise-support/submitting-a-ticket.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About submitting a ticket diff --git a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md b/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md index 3b3b6da7eb2e..e87d29f61ffe 100644 --- a/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md +++ b/content/admin/github-actions/about-using-actions-on-github-enterprise-server.md @@ -6,6 +6,8 @@ redirect_from: - /admin/github-actions/about-using-githubcom-actions-on-github-enterprise-server versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/advanced-configuration-and-troubleshooting.md b/content/admin/github-actions/advanced-configuration-and-troubleshooting.md index fa3f0a4aa74d..609640ef9957 100644 --- a/content/admin/github-actions/advanced-configuration-and-troubleshooting.md +++ b/content/admin/github-actions/advanced-configuration-and-troubleshooting.md @@ -4,4 +4,7 @@ intro: 'Configure high availability for {% data variables.product.prodname_actio mapTopic: true versions: enterprise-server: '>=3.0' +topics: + - enterprise --- + diff --git a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md index a2556020e8d7..1a687f2e87bf 100644 --- a/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md +++ b/content/admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled.md @@ -4,6 +4,8 @@ shortTitle: Backing up and restoring intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% data reusables.actions.enterprise-storage-ha-backups %} diff --git a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md index 5be939738461..8235057e0215 100644 --- a/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md +++ b/content/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md index 886b40a7865d..1ab36ce2a1e5 100644 --- a/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/enabling-github-actions-for-github-enterprise-server.md @@ -4,4 +4,7 @@ intro: 'Learn how to configure storage and enable {% data variables.product.prod mapTopic: true versions: enterprise-server: '>=2.22' +topics: + - enterprise --- + diff --git a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md index 1e94369d9869..f545d4949420 100644 --- a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md b/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md index a9b21f3001d6..12451374388b 100644 --- a/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-azure-blob-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md index d86f1a64b58b..ba2c6c47ab3d 100644 --- a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -4,6 +4,8 @@ intro: 'You can enable {% data variables.product.prodname_actions %} on {% data permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md index 82df246b4335..b9f5e4fcf280 100644 --- a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md +++ b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '>=2.22' github-ae: '*' +topics: + - enterprise --- {% data reusables.actions.ae-beta %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md index 534f37520e13..4cba468196c4 100644 --- a/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md @@ -7,6 +7,8 @@ redirect_from: - /admin/github-actions/enabling-github-actions-and-configuring-storage versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/high-availability-for-github-actions.md b/content/admin/github-actions/high-availability-for-github-actions.md index 26ccc90fba59..c893e6c059ac 100644 --- a/content/admin/github-actions/high-availability-for-github-actions.md +++ b/content/admin/github-actions/high-availability-for-github-actions.md @@ -3,6 +3,8 @@ title: High availability for GitHub Actions intro: 'There are some special considerations for administering {% data variables.product.prodname_actions %} in a high availability configuration.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Replication or redundancy of your {% data variables.product.prodname_actions %} data diff --git a/content/admin/github-actions/index.md b/content/admin/github-actions/index.md index e95b18f98a29..6caf9cf8e216 100644 --- a/content/admin/github-actions/index.md +++ b/content/admin/github-actions/index.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '>=2.22' github-ae: '*' +topics: + - enterprise --- {% data reusables.actions.ae-beta %} diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md index 51d601c89f2e..78e01a4ca39d 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom.md @@ -6,5 +6,7 @@ redirect_from: - /enterprise/admin/github-actions/managing-access-to-actions-from-githubcom versions: enterprise-server: '>=2.22' +topics: + - enterprise --- diff --git a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md index f36947c4bc9c..3f8f07e6ba8a 100644 --- a/content/admin/github-actions/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/manually-syncing-actions-from-githubcom.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/github-actions/manually-syncing-actions-from-githubcom versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md index dfc57ac64bc3..a380a9961e6c 100644 --- a/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md +++ b/content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.actions.enterprise-beta %} diff --git a/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md b/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md index df08b0d047c9..5ef91e72d9ed 100644 --- a/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md +++ b/content/admin/github-actions/troubleshooting-github-actions-for-your-enterprise.md @@ -4,6 +4,8 @@ intro: 'Troubleshooting common issues that occur when using {% data variables.pr permissions: 'Site administrators can troubleshoot {% data variables.product.prodname_actions %} issues and modify {% data variables.product.prodname_ghe_server %} configurations.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- ### Configuring self-hosted runners when using a self-signed certificate for {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/github-actions/using-a-staging-environment.md b/content/admin/github-actions/using-a-staging-environment.md index f2d387de55b0..d463c8a01cd8 100644 --- a/content/admin/github-actions/using-a-staging-environment.md +++ b/content/admin/github-actions/using-a-staging-environment.md @@ -3,6 +3,8 @@ title: Using a staging environment intro: 'Learn about using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_ghe_server %} staging environments.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- It can be useful to have a staging or testing environment for {% data variables.product.product_location %}, so that you can test updates or new features before implementing them in your production environment. diff --git a/content/admin/installation/index.md b/content/admin/installation/index.md index ca489927cc7f..582246e33e86 100644 --- a/content/admin/installation/index.md +++ b/content/admin/installation/index.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/installation versions: enterprise-server: '*' +topics: + - enterprise --- For more information, or to purchase {% data variables.product.prodname_enterprise %}, see [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). diff --git a/content/admin/installation/installing-github-enterprise-server-on-aws.md b/content/admin/installation/installing-github-enterprise-server-on-aws.md index 50d3baa627cf..f6de6fe0ee42 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-aws.md +++ b/content/admin/installation/installing-github-enterprise-server-on-aws.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-aws versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-azure.md b/content/admin/installation/installing-github-enterprise-server-on-azure.md index be1006b3f79a..008413e67ecc 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-azure.md +++ b/content/admin/installation/installing-github-enterprise-server-on-azure.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-azure versions: enterprise-server: '*' +topics: + - enterprise --- You can deploy {% data variables.product.prodname_ghe_server %} on global Azure or Azure Government. diff --git a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md index e21838d06a78..6f8015897179 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md +++ b/content/admin/installation/installing-github-enterprise-server-on-google-cloud-platform.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-google-cloud-platform versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md index 42a146e2f9e0..eded2b581a73 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md +++ b/content/admin/installation/installing-github-enterprise-server-on-hyper-v.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-hyper-v versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md index 2695c4d61259..79453ba7f6f9 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md +++ b/content/admin/installation/installing-github-enterprise-server-on-openstack-kvm.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-openstack-kvm versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-vmware.md b/content/admin/installation/installing-github-enterprise-server-on-vmware.md index ce4f58e9bb3c..0646a0cdeafe 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-vmware.md +++ b/content/admin/installation/installing-github-enterprise-server-on-vmware.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-vmware versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/installing-github-enterprise-server-on-xenserver.md b/content/admin/installation/installing-github-enterprise-server-on-xenserver.md index fb0341074dbd..7b871086612d 100644 --- a/content/admin/installation/installing-github-enterprise-server-on-xenserver.md +++ b/content/admin/installation/installing-github-enterprise-server-on-xenserver.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/installation/installing-github-enterprise-server-on-xenserver versions: enterprise-server: '*' +topics: + - enterprise --- ### Prerequisites diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance.md index 92a5f510c953..865536adbe56 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance.md @@ -10,5 +10,7 @@ redirect_from: mapTopic: true versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/installation/setting-up-a-staging-instance.md b/content/admin/installation/setting-up-a-staging-instance.md index 972f5439d395..082e71f7fe55 100644 --- a/content/admin/installation/setting-up-a-staging-instance.md +++ b/content/admin/installation/setting-up-a-staging-instance.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/installation/setting-up-a-staging-instance versions: enterprise-server: '*' +topics: + - enterprise --- {% tip %} @@ -28,4 +30,4 @@ To thoroughly test a {% data variables.product.prodname_ghe_server %} appliance ### Further reading - "[About upgrades to new releases](/admin/overview/about-upgrades-to-new-releases)" -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/overview/about-enterprise-accounts.md b/content/admin/overview/about-enterprise-accounts.md index 4c37b9eed58f..42352b9ac151 100644 --- a/content/admin/overview/about-enterprise-accounts.md +++ b/content/admin/overview/about-enterprise-accounts.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '>=2.20' github-ae: '*' +topics: + - enterprise --- ### About enterprise accounts on {% data variables.product.product_name %} diff --git a/content/admin/overview/about-the-github-enterprise-api.md b/content/admin/overview/about-the-github-enterprise-api.md index 8f75a39a0715..d79b6c703a25 100644 --- a/content/admin/overview/about-the-github-enterprise-api.md +++ b/content/admin/overview/about-the-github-enterprise-api.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- With the APIs, you can automate many administrative tasks. Some examples include: diff --git a/content/admin/overview/about-upgrades-to-new-releases.md b/content/admin/overview/about-upgrades-to-new-releases.md index f25eeb31ca24..475fea0e5fd0 100644 --- a/content/admin/overview/about-upgrades-to-new-releases.md +++ b/content/admin/overview/about-upgrades-to-new-releases.md @@ -5,6 +5,8 @@ intro: '{% if currentVersion == "github-ae@latest" %}Your {% data variables.prod versions: enterprise-server: '>=3.0' github-ae: '*' +topics: + - enterprise --- {% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %} is a fully managed service, so {% data variables.product.company_short %} completes the upgrade process for your enterprise.{% endif %} diff --git a/content/admin/overview/managing-billing-for-your-enterprise.md b/content/admin/overview/managing-billing-for-your-enterprise.md index 97c0ba8c0346..8b8000cdc4d2 100644 --- a/content/admin/overview/managing-billing-for-your-enterprise.md +++ b/content/admin/overview/managing-billing-for-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing billing for your enterprise -intro: 'You can view billing information for your enterprise.' +intro: You can view billing information for your enterprise. product: '{% data reusables.gated-features.enterprise-accounts %}' redirect_from: - /enterprise/admin/installation/managing-billing-for-github-enterprise @@ -9,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/overview/managing-your-github-enterprise-license.md b/content/admin/overview/managing-your-github-enterprise-license.md index b5c69a8999af..5318d5ca0820 100644 --- a/content/admin/overview/managing-your-github-enterprise-license.md +++ b/content/admin/overview/managing-your-github-enterprise-license.md @@ -14,6 +14,8 @@ redirect_from: - /enterprise/admin/overview/managing-your-github-enterprise-license versions: enterprise-server: '*' +topics: + - enterprise --- ### About {% data variables.product.prodname_enterprise %} licenses diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index c86afe795a13..a84cc7b275c4 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/overview/system-overview versions: enterprise-server: '*' +topics: + - enterprise --- ### Storage architecture diff --git a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md index 1f15dc49c27f..b544920183a0 100644 --- a/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md +++ b/content/admin/packages/configuring-package-ecosystem-support-for-your-enterprise.md @@ -6,6 +6,8 @@ redirect_from: - /admin/packages/configuring-packages-support-for-your-enterprise versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/packages/enabling-github-packages-with-aws.md b/content/admin/packages/enabling-github-packages-with-aws.md index 4cfb1b01231b..d1ac35a26000 100644 --- a/content/admin/packages/enabling-github-packages-with-aws.md +++ b/content/admin/packages/enabling-github-packages-with-aws.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with AWS intro: 'Set up {% data variables.product.prodname_registry %} with AWS as your external storage.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md b/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md index 65fd3656219c..913cfba14ce8 100644 --- a/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md +++ b/content/admin/packages/enabling-github-packages-with-azure-blob-storage.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with Azure Blob Storage intro: 'Set up {% data variables.product.prodname_registry %} with Azure Blob Storage as your external storage.' versions: enterprise-server: '>=3.0' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/enabling-github-packages-with-minio.md b/content/admin/packages/enabling-github-packages-with-minio.md index b0cec33688e6..9123b05147ad 100644 --- a/content/admin/packages/enabling-github-packages-with-minio.md +++ b/content/admin/packages/enabling-github-packages-with-minio.md @@ -3,6 +3,8 @@ title: Enabling GitHub Packages with MinIO intro: 'Set up {% data variables.product.prodname_registry %} with MinIO as your external storage.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% warning %} diff --git a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 9f92df1f8777..16aae55c86ce 100644 --- a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -6,6 +6,8 @@ redirect_from: - /admin/packages/enabling-github-packages-for-your-enterprise versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% if currentVersion == "enterprise-server@2.22" %} diff --git a/content/admin/packages/index.md b/content/admin/packages/index.md index 9808ef3fde91..b4f90820e7a9 100644 --- a/content/admin/packages/index.md +++ b/content/admin/packages/index.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/packages versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index 646d1454a26c..fc418b26e2f5 100644 --- a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -3,6 +3,8 @@ title: Quickstart for configuring your MinIO storage bucket for GitHub Packages intro: 'Configure your custom MinIO storage bucket for use with {% data variables.product.prodname_registry %}.' versions: enterprise-server: '>=2.22' +topics: + - enterprise --- {% data reusables.package_registry.packages-ghes-release-stage %} diff --git a/content/admin/policies/about-pre-receive-hooks.md b/content/admin/policies/about-pre-receive-hooks.md index ec699e2ccff9..effb31b1b4fc 100644 --- a/content/admin/policies/about-pre-receive-hooks.md +++ b/content/admin/policies/about-pre-receive-hooks.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/about-pre-receive-hooks versions: enterprise-server: '*' +topics: + - enterprise --- When a push occurs, each script runs in an isolated environment and can perform checks on the content of the push. The scripts will cause the push to be accepted if the exit status is 0, or rejected if the exit status is non-zero. diff --git a/content/admin/policies/creating-a-pre-receive-hook-environment.md b/content/admin/policies/creating-a-pre-receive-hook-environment.md index 64ab4099fcfb..f79812973383 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-environment.md +++ b/content/admin/policies/creating-a-pre-receive-hook-environment.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-environment versions: enterprise-server: '*' +topics: + - enterprise --- A pre-receive environment for {% data variables.product.prodname_ghe_server %} is a Linux [`chroot`](https://en.wikipedia.org/wiki/Chroot) environment. Because pre-receive hooks execute on every push event, they should be fast and lightweight. The environment needed for such checks will typically be minimal. diff --git a/content/admin/policies/creating-a-pre-receive-hook-script.md b/content/admin/policies/creating-a-pre-receive-hook-script.md index c501d76e583f..71f3a8e9716f 100644 --- a/content/admin/policies/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/creating-a-pre-receive-hook-script.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/policies/creating-a-pre-receive-hook-script versions: enterprise-server: '*' +topics: + - enterprise --- You can see examples of pre-receive hooks for {% data variables.product.prodname_ghe_server %} in the [`github/platform-samples` repository](https://github.com/github/platform-samples/tree/master/pre-receive-hooks). diff --git a/content/admin/policies/enforcing-policies-for-your-enterprise.md b/content/admin/policies/enforcing-policies-for-your-enterprise.md index b3673275fc59..c5583b723d56 100644 --- a/content/admin/policies/enforcing-policies-for-your-enterprise.md +++ b/content/admin/policies/enforcing-policies-for-your-enterprise.md @@ -6,5 +6,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md index 49c8daec918b..62f4721a650e 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks.md @@ -7,5 +7,7 @@ redirect_from: - /enterprise/admin/policies/enforcing-policy-with-pre-receive-hooks versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md index de657754d33a..adb7c0bf5099 100644 --- a/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/policies/enforcing-repository-management-policies-in-your-enterprise.md @@ -28,6 +28,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Configuring the default visibility of new repositories in your enterprise @@ -242,4 +244,4 @@ If necessary, you can prevent repository administrators from changing anonymous ![Enforcement checkbox](/assets/images/help/business-accounts/default-branch-name-enforce.png) 5. Click **Update**. ![Update button](/assets/images/help/business-accounts/default-branch-name-update.png) -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/policies/index.md b/content/admin/policies/index.md index 9c665ea89426..2588b9ba09aa 100644 --- a/content/admin/policies/index.md +++ b/content/admin/policies/index.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md index 806dd27df9c5..78a8dbb31f01 100644 --- a/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md +++ b/content/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance.md @@ -7,6 +7,8 @@ redirect_from: - /enterprise/admin/policies/managing-pre-receive-hooks-on-the-github-enterprise-server-appliance versions: enterprise-server: '*' +topics: + - enterprise --- ### Creating pre-receive hooks diff --git a/content/admin/release-notes.md b/content/admin/release-notes.md index 4010feb87963..3608580c91c5 100644 --- a/content/admin/release-notes.md +++ b/content/admin/release-notes.md @@ -1,7 +1,10 @@ --- title: Release notes -intro: The release notes for {{ allVersions[currentVersion].versionTitle }}. +intro: 'The release notes for {{ allVersions[currentVersion].versionTitle }}.' layout: release-notes versions: enterprise-server: '*' +topics: + - enterprise --- + diff --git a/content/admin/user-management/about-migrations.md b/content/admin/user-management/about-migrations.md index e04bdf4f4a50..4761a7756131 100644 --- a/content/admin/user-management/about-migrations.md +++ b/content/admin/user-management/about-migrations.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/about-migrations versions: enterprise-server: '*' +topics: + - enterprise --- ### Types of migrations diff --git a/content/admin/user-management/activity-dashboard.md b/content/admin/user-management/activity-dashboard.md index 5fb4fce0d924..36572f7c9092 100644 --- a/content/admin/user-management/activity-dashboard.md +++ b/content/admin/user-management/activity-dashboard.md @@ -1,6 +1,6 @@ --- title: Activity dashboard -intro: 'The Activity dashboard gives you an overview of all the activity in your enterprise.' +intro: The Activity dashboard gives you an overview of all the activity in your enterprise. redirect_from: - /enterprise/admin/articles/activity-dashboard/ - /enterprise/admin/installation/activity-dashboard @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- The Activity dashboard provides weekly, monthly, and yearly graphs of the number of: diff --git a/content/admin/user-management/adding-people-to-teams.md b/content/admin/user-management/adding-people-to-teams.md index 0a94dea0aa6e..cae2ec54c94a 100644 --- a/content/admin/user-management/adding-people-to-teams.md +++ b/content/admin/user-management/adding-people-to-teams.md @@ -8,6 +8,8 @@ redirect_from: intro: 'Once a team has been created, organization admins can add users from {% data variables.product.product_location %} to the team and determine which repositories they have access to.' versions: enterprise-server: '*' +topics: + - enterprise --- Each team has its own individually defined [access permissions for repositories owned by your organization](/articles/permission-levels-for-an-organization). diff --git a/content/admin/user-management/audit-logging.md b/content/admin/user-management/audit-logging.md index 8a8da98e14bd..d4eb94ca047d 100644 --- a/content/admin/user-management/audit-logging.md +++ b/content/admin/user-management/audit-logging.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- For a full list, see "[Audited actions](/admin/user-management/audited-actions)." For more information on finding a particular action, see "[Searching the audit log](/admin/user-management/searching-the-audit-log)." @@ -38,4 +40,4 @@ This example shows that commits were pushed to a repository. ``` Oct 26 02:19:31 github-ent github_audit: { "pid":22860, "ppid":22859, "program":"receive-pack", "git_dir":"/data/repositories/some-user/some-repository.git", "hostname":"github-ent", "pusher":"some-user", "real_ip":"10.0.0.51", "user_agent":"git/1.7.10.4", "repo_id":1, "repo_name":"some-user/some-repository", "transaction_id":"b031b7dc7043c87323a75f7a92092ef1456e5fbaef995c68", "frontend_ppid":1, "repo_public":true, "user_name":"some-user", "user_login":"some-user", "frontend_pid":18238, "frontend":"github-ent", "user_email":"some-user@github.example.com", "user_id":2, "pgroup":"github-ent_22860", "status":"post_receive_hook", "features":" report-status side-band-64k", "received_objects":3, "receive_pack_size":243, "non_fast_forward":false, "current_ref":"refs/heads/main" } ``` -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/admin/user-management/audited-actions.md b/content/admin/user-management/audited-actions.md index 57ed82a23046..eaf820e04b87 100644 --- a/content/admin/user-management/audited-actions.md +++ b/content/admin/user-management/audited-actions.md @@ -9,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- #### Authentication diff --git a/content/admin/user-management/auditing-ssh-keys.md b/content/admin/user-management/auditing-ssh-keys.md index fca0dbe5be6b..fa8aee9730d2 100644 --- a/content/admin/user-management/auditing-ssh-keys.md +++ b/content/admin/user-management/auditing-ssh-keys.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Once initiated, the audit disables all existing SSH keys and forces users to approve or reject them before they're able to clone, pull, or push to any repositories. An audit is useful in situations where an employee or contractor leaves the company and you need to ensure that all keys are verified. diff --git a/content/admin/user-management/auditing-users-across-your-enterprise.md b/content/admin/user-management/auditing-users-across-your-enterprise.md index 015fe8c7a20d..d644c7cbeb89 100644 --- a/content/admin/user-management/auditing-users-across-your-enterprise.md +++ b/content/admin/user-management/auditing-users-across-your-enterprise.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Accessing the audit log diff --git a/content/admin/user-management/best-practices-for-user-security.md b/content/admin/user-management/best-practices-for-user-security.md index beae6174be88..a0de18848f31 100644 --- a/content/admin/user-management/best-practices-for-user-security.md +++ b/content/admin/user-management/best-practices-for-user-security.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md index e51686cb1fbb..bd222612722f 100644 --- a/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/user-management/configuring-git-large-file-storage-for-your-enterprise.md @@ -15,6 +15,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About {% data variables.large_files.product_name_long %} diff --git a/content/admin/user-management/configuring-visibility-for-organization-membership.md b/content/admin/user-management/configuring-visibility-for-organization-membership.md index 6551ad31f8f0..4b051cbd69d7 100644 --- a/content/admin/user-management/configuring-visibility-for-organization-membership.md +++ b/content/admin/user-management/configuring-visibility-for-organization-membership.md @@ -6,6 +6,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% if enterpriseServerVersions contains currentVersion %} diff --git a/content/admin/user-management/continuous-integration-using-jenkins.md b/content/admin/user-management/continuous-integration-using-jenkins.md index 8f1ebe6bdabd..74cc0fc96400 100644 --- a/content/admin/user-management/continuous-integration-using-jenkins.md +++ b/content/admin/user-management/continuous-integration-using-jenkins.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/continuous-integration-using-jenkins versions: enterprise-server: '*' +topics: + - enterprise --- ### Requirements diff --git a/content/admin/user-management/creating-teams.md b/content/admin/user-management/creating-teams.md index 96c25bbb5a35..73de8300827b 100644 --- a/content/admin/user-management/creating-teams.md +++ b/content/admin/user-management/creating-teams.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/creating-teams versions: enterprise-server: '*' +topics: + - enterprise --- Teams are central to many of {% data variables.product.prodname_dotcom %}'s collaborative features, such as team @mentions to notify appropriate parties that you'd like to request their input or attention. For more information, see "[Permission levels for an organization repository](/enterprise/{{ currentVersion }}/user/articles/repository-permission-levels-for-an-organization/)". diff --git a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md index 8d20c8a7ad12..fb040c543b88 100644 --- a/content/admin/user-management/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/user-management/customizing-user-messages-for-your-enterprise.md @@ -8,6 +8,8 @@ intro: 'You can create custom messages that users will see on {% data variables. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About user messages diff --git a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md index 1578faba94f5..ed0284421ee8 100644 --- a/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md +++ b/content/admin/user-management/disabling-git-ssh-access-on-your-enterprise.md @@ -13,10 +13,12 @@ redirect_from: - /enterprise/admin/installation/disabling-git-ssh-access-on-github-enterprise-server - /enterprise/admin/user-management/disabling-git-ssh-access-on-github-enterprise-server - /admin/user-management/disabling-git-ssh-access-on-github-enterprise-server -intro: 'You can prevent people from using Git over SSH for certain or all repositories on your enterprise.' +intro: You can prevent people from using Git over SSH for certain or all repositories on your enterprise. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Disabling Git SSH access to a specific repository diff --git a/content/admin/user-management/exporting-migration-data-from-githubcom.md b/content/admin/user-management/exporting-migration-data-from-githubcom.md index 7856792cb08b..6112f4c241b8 100644 --- a/content/admin/user-management/exporting-migration-data-from-githubcom.md +++ b/content/admin/user-management/exporting-migration-data-from-githubcom.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-githubcom versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the source organization on {% data variables.product.prodname_dotcom %} diff --git a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md index da606dbe919c..a777e740e35e 100644 --- a/content/admin/user-management/exporting-migration-data-from-your-enterprise.md +++ b/content/admin/user-management/exporting-migration-data-from-your-enterprise.md @@ -11,6 +11,8 @@ redirect_from: - /enterprise/admin/user-management/exporting-migration-data-from-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the {% data variables.product.prodname_ghe_server %} source instance diff --git a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md index 8a81872d82e7..4fce02539d21 100644 --- a/content/admin/user-management/importing-data-from-third-party-version-control-systems.md +++ b/content/admin/user-management/importing-data-from-third-party-version-control-systems.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/importing-data-from-third-party-version-control-systems versions: enterprise-server: '*' +topics: + - enterprise --- ### Importing projects from Mercurial diff --git a/content/admin/user-management/index.md b/content/admin/user-management/index.md index 73f06725687e..6bbed26d46a8 100644 --- a/content/admin/user-management/index.md +++ b/content/admin/user-management/index.md @@ -11,6 +11,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/log-forwarding.md b/content/admin/user-management/log-forwarding.md index 00ad4741f35e..c30299376ffa 100644 --- a/content/admin/user-management/log-forwarding.md +++ b/content/admin/user-management/log-forwarding.md @@ -9,6 +9,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Any log collection system that supports syslog-style log streams is supported (e.g., [Logstash](http://logstash.net/) and [Splunk](http://docs.splunk.com/Documentation/Splunk/latest/Data/Monitornetworkports)). diff --git a/content/admin/user-management/managing-dormant-users.md b/content/admin/user-management/managing-dormant-users.md index 9aaaccfb90aa..99c8980a2c84 100644 --- a/content/admin/user-management/managing-dormant-users.md +++ b/content/admin/user-management/managing-dormant-users.md @@ -5,10 +5,12 @@ redirect_from: - /enterprise/admin/articles/viewing-dormant-users/ - /enterprise/admin/articles/determining-whether-a-user-account-is-dormant/ - /enterprise/admin/user-management/managing-dormant-users -intro: A user account is considered to be dormant if it has not been active for at least a month.{% if enterpriseServerVersions contains currentVersion %} You may choose to suspend dormant users to free up user licenses.{% endif %} +intro: 'A user account is considered to be dormant if it has not been active for at least a month.{% if enterpriseServerVersions contains currentVersion %} You may choose to suspend dormant users to free up user licenses.{% endif %}' versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- "Activity" includes, but is not limited to: diff --git a/content/admin/user-management/managing-global-webhooks.md b/content/admin/user-management/managing-global-webhooks.md index e34217f4ca5e..8dfcaa45e9da 100644 --- a/content/admin/user-management/managing-global-webhooks.md +++ b/content/admin/user-management/managing-global-webhooks.md @@ -7,6 +7,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### About global webhooks diff --git a/content/admin/user-management/managing-organizations-in-your-enterprise.md b/content/admin/user-management/managing-organizations-in-your-enterprise.md index 08415450a9a5..0fddb06a87c6 100644 --- a/content/admin/user-management/managing-organizations-in-your-enterprise.md +++ b/content/admin/user-management/managing-organizations-in-your-enterprise.md @@ -10,4 +10,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- + diff --git a/content/admin/user-management/managing-projects-using-jira.md b/content/admin/user-management/managing-projects-using-jira.md index fb919a17696a..c6ea376e2257 100644 --- a/content/admin/user-management/managing-projects-using-jira.md +++ b/content/admin/user-management/managing-projects-using-jira.md @@ -9,6 +9,8 @@ redirect_from: - /enterprise/admin/user-management/managing-projects-using-jira versions: enterprise-server: '*' +topics: + - enterprise --- ### Connecting JIRA to a {% data variables.product.prodname_enterprise %} organization diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise.md b/content/admin/user-management/managing-repositories-in-your-enterprise.md index 4da07ed3b7a1..bf4eb99cac54 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing repositories in your enterprise -intro: 'You can manage the settings available to repository administrators in your enterprise.' +intro: You can manage the settings available to repository administrators in your enterprise. redirect_from: - /enterprise/admin/user-management/repositories - /enterprise/admin/user-management/managing-repositories-in-your-enterprise @@ -8,5 +8,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/managing-users-in-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise.md index 63a373005fbd..f5ee73f94a4c 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise.md @@ -1,6 +1,6 @@ --- title: Managing users in your enterprise -intro: 'You can audit user activity and manage user settings.' +intro: You can audit user activity and manage user settings. redirect_from: - /enterprise/admin/guides/user-management/enabling-avatars-and-identicons/ - /enterprise/admin/user-management/basic-account-settings @@ -10,5 +10,7 @@ mapTopic: true versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md index a3df463ac39c..216d8e3aa4b6 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise.md @@ -9,5 +9,7 @@ redirect_from: - /enterprise/admin/user-management/migrating-data-to-and-from-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-your-enterprise.md index e1a120ba63e2..47abddf047f4 100644 --- a/content/admin/user-management/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-your-enterprise.md @@ -13,6 +13,8 @@ redirect_from: - /enterprise/admin/user-management/migrating-data-to-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Applying the imported data on {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md index 509a9e1a1197..c3abc3d40b72 100644 --- a/content/admin/user-management/migrating-to-internal-repositories.md +++ b/content/admin/user-management/migrating-to-internal-repositories.md @@ -7,6 +7,8 @@ redirect_from: permissions: Site administrators can migrate to internal repositories. versions: enterprise-server: '>=2.20' +topics: + - enterprise --- ### About internal repositories diff --git a/content/admin/user-management/monitoring-activity-in-your-enterprise.md b/content/admin/user-management/monitoring-activity-in-your-enterprise.md index a72fde4deb4f..4c8ae9bd38c2 100644 --- a/content/admin/user-management/monitoring-activity-in-your-enterprise.md +++ b/content/admin/user-management/monitoring-activity-in-your-enterprise.md @@ -7,5 +7,7 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- diff --git a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md index 20a81d080e50..881f91d4b996 100644 --- a/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md +++ b/content/admin/user-management/placing-a-legal-hold-on-a-user-or-organization.md @@ -1,11 +1,13 @@ --- title: Placing a legal hold on a user or organization -intro: 'You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from your enterprise.' +intro: You can place a legal hold on a user or organization to ensure that repositories they own cannot be permanently removed from your enterprise. redirect_from: - /enterprise/admin/user-management/placing-a-legal-hold-on-a-user-or-organization versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Usually, if someone deletes a repository, it will be available on disk for 90 days and can be restored via the site admin dashboard. After 90 days the repository is purged and deleted forever. If you place a legal hold on a user or organization, repositories they own are available for restore indefinitely. diff --git a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md index c6e85b46cc27..b0b294e4cecd 100644 --- a/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md +++ b/content/admin/user-management/preparing-to-migrate-data-to-your-enterprise.md @@ -10,6 +10,8 @@ redirect_from: - /enterprise/admin/user-management/preparing-to-migrate-data-to-your-enterprise versions: enterprise-server: '*' +topics: + - enterprise --- ### Preparing the migrated data for import to {% data variables.product.prodname_ghe_server %} diff --git a/content/admin/user-management/preventing-users-from-creating-organizations.md b/content/admin/user-management/preventing-users-from-creating-organizations.md index 1a1f09c7768e..41355830c4cd 100644 --- a/content/admin/user-management/preventing-users-from-creating-organizations.md +++ b/content/admin/user-management/preventing-users-from-creating-organizations.md @@ -4,10 +4,12 @@ redirect_from: - /enterprise/admin/articles/preventing-users-from-creating-organizations/ - /enterprise/admin/hidden/preventing-users-from-creating-organizations/ - /enterprise/admin/user-management/preventing-users-from-creating-organizations -intro: 'You can prevent users from creating organizations in your enterprise.' +intro: You can prevent users from creating organizations in your enterprise. versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md index 8370cad87091..225c8efd4b36 100644 --- a/content/admin/user-management/promoting-or-demoting-a-site-administrator.md +++ b/content/admin/user-management/promoting-or-demoting-a-site-administrator.md @@ -7,6 +7,8 @@ redirect_from: intro: 'Site administrators can promote any normal user account to a site administrator, as well as demote other site administrators to regular users.' versions: enterprise-server: '*' +topics: + - enterprise --- {% tip %} @@ -52,4 +54,4 @@ For information about promoting a user to an organization owner, see the `ghe-or 2. Run [ghe-user-demote](/enterprise/{{ currentVersion }}/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell $ ghe-user-demote username - ``` \ No newline at end of file + ``` diff --git a/content/admin/user-management/rebuilding-contributions-data.md b/content/admin/user-management/rebuilding-contributions-data.md index 12b6e32f2895..8ad18007f07f 100644 --- a/content/admin/user-management/rebuilding-contributions-data.md +++ b/content/admin/user-management/rebuilding-contributions-data.md @@ -6,6 +6,8 @@ redirect_from: - /enterprise/admin/user-management/rebuilding-contributions-data versions: enterprise-server: '*' +topics: + - enterprise --- Whenever a commit is pushed to {% data variables.product.prodname_enterprise %}, it is linked to a user account if they are both associated with the same email address. However, existing commits are *not* retroactively linked when a user registers a new email address or creates a new account. diff --git a/content/admin/user-management/removing-users-from-teams-and-organizations.md b/content/admin/user-management/removing-users-from-teams-and-organizations.md index 3887587f9060..2d4d6eace68d 100644 --- a/content/admin/user-management/removing-users-from-teams-and-organizations.md +++ b/content/admin/user-management/removing-users-from-teams-and-organizations.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/removing-users-from-teams-and-organizations versions: enterprise-server: '*' +topics: + - enterprise --- Only owners or team admins can remove organization members. When a user is removed from a team or organization, their issues, pull requests, and comments in the organization's repositories remain intact and are still attributed to the user. diff --git a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md index 32cff3f262c0..a60123ce08d8 100644 --- a/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md +++ b/content/admin/user-management/requiring-two-factor-authentication-for-an-organization.md @@ -5,6 +5,8 @@ redirect_from: - /enterprise/admin/user-management/requiring-two-factor-authentication-for-an-organization versions: enterprise-server: '*' +topics: + - enterprise --- When using LDAP or built-in authentication, two-factor authentication is supported on {% data variables.product.product_location %}. Organization administrators can require members to have two-factor authentication enabled. diff --git a/content/admin/user-management/searching-the-audit-log.md b/content/admin/user-management/searching-the-audit-log.md index 9495d0dc5c9c..aa9caf2db5fd 100644 --- a/content/admin/user-management/searching-the-audit-log.md +++ b/content/admin/user-management/searching-the-audit-log.md @@ -1,6 +1,6 @@ --- title: Searching the audit log -intro: 'Site administrators can search an extensive list of audited actions on the enterprise.' +intro: Site administrators can search an extensive list of audited actions on the enterprise. redirect_from: - /enterprise/admin/articles/searching-the-audit-log/ - /enterprise/admin/installation/searching-the-audit-log @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Search query syntax diff --git a/content/admin/user-management/suspending-and-unsuspending-users.md b/content/admin/user-management/suspending-and-unsuspending-users.md index ce82b3bb93fe..ba313b6765be 100644 --- a/content/admin/user-management/suspending-and-unsuspending-users.md +++ b/content/admin/user-management/suspending-and-unsuspending-users.md @@ -10,6 +10,8 @@ redirect_from: intro: 'If a user leaves or moves to a different part of the company, you should remove or modify their ability to access {% data variables.product.product_location %}.' versions: enterprise-server: '*' +topics: + - enterprise --- If employees leave the company, you can suspend their {% data variables.product.prodname_ghe_server %} accounts to open up user licenses in your {% data variables.product.prodname_enterprise %} license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code. @@ -92,4 +94,4 @@ You can create a custom message that suspended users will see when attempting to ``` ### Further reading -- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" \ No newline at end of file +- "[Suspend a user](/rest/reference/enterprise-admin#suspend-a-user)" diff --git a/content/admin/user-management/troubleshooting-service-hooks.md b/content/admin/user-management/troubleshooting-service-hooks.md index 3ae71bf8105e..f7e8ea77c0c5 100644 --- a/content/admin/user-management/troubleshooting-service-hooks.md +++ b/content/admin/user-management/troubleshooting-service-hooks.md @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- ### Getting information on deliveries diff --git a/content/admin/user-management/viewing-push-logs.md b/content/admin/user-management/viewing-push-logs.md index 19fb57249315..3481540a90ac 100644 --- a/content/admin/user-management/viewing-push-logs.md +++ b/content/admin/user-management/viewing-push-logs.md @@ -1,6 +1,6 @@ --- title: Viewing push logs -intro: 'Site administrators can view a list of Git push operations for any repository on the enterprise.' +intro: Site administrators can view a list of Git push operations for any repository on the enterprise. redirect_from: - /enterprise/admin/articles/viewing-push-logs/ - /enterprise/admin/installation/viewing-push-logs @@ -8,6 +8,8 @@ redirect_from: versions: enterprise-server: '*' github-ae: '*' +topics: + - enterprise --- Push log entries show: @@ -38,4 +40,4 @@ Push log entries show: ```shell ghe-repo owner/repository -c "less audit_log" ``` -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/developers/apps/about-apps.md b/content/developers/apps/about-apps.md index fff85efbab0d..e1c19c1da530 100644 --- a/content/developers/apps/about-apps.md +++ b/content/developers/apps/about-apps.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- Apps on {% data variables.product.prodname_dotcom %} allow you to automate and improve your workflow. You can build apps to improve your workflow.{% if currentVersion == "free-pro-team@latest" %} You can also share or sell apps in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace). To learn how to list an app on {% data variables.product.prodname_marketplace %}, see "[Getting started with GitHub Marketplace](/marketplace/getting-started/)."{% endif %} diff --git a/content/developers/apps/activating-optional-features-for-apps.md b/content/developers/apps/activating-optional-features-for-apps.md index ef5f534d5b0f..79ef3adf879b 100644 --- a/content/developers/apps/activating-optional-features-for-apps.md +++ b/content/developers/apps/activating-optional-features-for-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' github-ae: '*' enterprise-server: '>=2.22' +topics: + - github apps --- {% warning %} diff --git a/content/developers/apps/authenticating-with-github-apps.md b/content/developers/apps/authenticating-with-github-apps.md index c4d09073ff59..46ab929b327b 100644 --- a/content/developers/apps/authenticating-with-github-apps.md +++ b/content/developers/apps/authenticating-with-github-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %} diff --git a/content/developers/apps/authorizing-oauth-apps.md b/content/developers/apps/authorizing-oauth-apps.md index 4a9ab098cc4a..cbf94e9baeba 100644 --- a/content/developers/apps/authorizing-oauth-apps.md +++ b/content/developers/apps/authorizing-oauth-apps.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data variables.product.product_name %}'s OAuth implementation supports the standard [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} and the OAuth 2.0 [Device Authorization Grant](https://tools.ietf.org/html/rfc8628) for apps that don't have access to a web browser{% endif %}. diff --git a/content/developers/apps/building-github-apps.md b/content/developers/apps/building-github-apps.md index 91bb4479af95..8c79f0099541 100644 --- a/content/developers/apps/building-github-apps.md +++ b/content/developers/apps/building-github-apps.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/building-oauth-apps.md b/content/developers/apps/building-oauth-apps.md index ccedbd626704..16fbbbf52332 100644 --- a/content/developers/apps/building-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps.md @@ -9,5 +9,6 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- - diff --git a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md index c39b720c268f..2f26017f1c6e 100644 --- a/content/developers/apps/creating-a-custom-badge-for-your-github-app.md +++ b/content/developers/apps/creating-a-custom-badge-for-your-github-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- By default, a new GitHub App will have an automatically generated [identicon](https://github.com/blog/1586-identicons). diff --git a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md index 9945833d00fc..f39207563edb 100644 --- a/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md +++ b/content/developers/apps/creating-a-custom-badge-for-your-oauth-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- By default, a new OAuth App will have an automatically generated [identicon](https://github.com/blog/1586-identicons). diff --git a/content/developers/apps/creating-a-github-app-from-a-manifest.md b/content/developers/apps/creating-a-github-app-from-a-manifest.md index 7c18a8b460cc..22c65eacfa26 100644 --- a/content/developers/apps/creating-a-github-app-from-a-manifest.md +++ b/content/developers/apps/creating-a-github-app-from-a-manifest.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/creating-a-github-app-using-url-parameters.md b/content/developers/apps/creating-a-github-app-using-url-parameters.md index 99d0f03a93da..a4794039eab7 100644 --- a/content/developers/apps/creating-a-github-app-using-url-parameters.md +++ b/content/developers/apps/creating-a-github-app-using-url-parameters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/creating-a-github-app.md b/content/developers/apps/creating-a-github-app.md index cae49a410a84..63b95c7eaeee 100644 --- a/content/developers/apps/creating-a-github-app.md +++ b/content/developers/apps/creating-a-github-app.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% if currentVersion == "free-pro-team@latest" %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %} diff --git a/content/developers/apps/creating-an-oauth-app.md b/content/developers/apps/creating-an-oauth-app.md index c885dc21341f..0340b236ef86 100644 --- a/content/developers/apps/creating-an-oauth-app.md +++ b/content/developers/apps/creating-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/developers/apps/creating-ci-tests-with-the-checks-api.md b/content/developers/apps/creating-ci-tests-with-the-checks-api.md index e964e7b0550e..8d8bd1e520ff 100644 --- a/content/developers/apps/creating-ci-tests-with-the-checks-api.md +++ b/content/developers/apps/creating-ci-tests-with-the-checks-api.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/deleting-a-github-app.md b/content/developers/apps/deleting-a-github-app.md index 6c32b8f7f9fd..7c40c0b61d69 100644 --- a/content/developers/apps/deleting-a-github-app.md +++ b/content/developers/apps/deleting-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/deleting-an-oauth-app.md b/content/developers/apps/deleting-an-oauth-app.md index cdf87e56e0f1..75eb74ad1a97 100644 --- a/content/developers/apps/deleting-an-oauth-app.md +++ b/content/developers/apps/deleting-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md index 091642a8f791..c1c8b1c125a2 100644 --- a/content/developers/apps/differences-between-github-apps-and-oauth-apps.md +++ b/content/developers/apps/differences-between-github-apps-and-oauth-apps.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps + - oauth apps --- ### Who can install GitHub Apps and authorize OAuth Apps? diff --git a/content/developers/apps/editing-a-github-apps-permissions.md b/content/developers/apps/editing-a-github-apps-permissions.md index d57db219a1e6..62ec4ae5c0c5 100644 --- a/content/developers/apps/editing-a-github-apps-permissions.md +++ b/content/developers/apps/editing-a-github-apps-permissions.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% note %} diff --git a/content/developers/apps/getting-started-with-apps.md b/content/developers/apps/getting-started-with-apps.md index d6bc3d7a0f13..46aa599b97b7 100644 --- a/content/developers/apps/getting-started-with-apps.md +++ b/content/developers/apps/getting-started-with-apps.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/guides.md b/content/developers/apps/guides.md index 1e90f02406a7..125c0f5c42ca 100644 --- a/content/developers/apps/guides.md +++ b/content/developers/apps/guides.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md index 0c27bda88388..6f235d3ca06e 100644 --- a/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md +++ b/content/developers/apps/identifying-and-authorizing-users-for-github-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/index.md b/content/developers/apps/index.md index e384433f901b..5dab758c53fb 100644 --- a/content/developers/apps/index.md +++ b/content/developers/apps/index.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% topic_link_in_list /getting-started-with-apps %} diff --git a/content/developers/apps/installing-github-apps.md b/content/developers/apps/installing-github-apps.md index c997ded78ac8..59215beea0a4 100644 --- a/content/developers/apps/installing-github-apps.md +++ b/content/developers/apps/installing-github-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% note %} diff --git a/content/developers/apps/making-a-github-app-public-or-private.md b/content/developers/apps/making-a-github-app-public-or-private.md index 036d3d589dfa..37f0bee15c58 100644 --- a/content/developers/apps/making-a-github-app-public-or-private.md +++ b/content/developers/apps/making-a-github-app-public-or-private.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- For authentication information, see "[Authenticating with GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." diff --git a/content/developers/apps/managing-github-apps.md b/content/developers/apps/managing-github-apps.md index fb3b9c3934b7..0bab3a14a562 100644 --- a/content/developers/apps/managing-github-apps.md +++ b/content/developers/apps/managing-github-apps.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/managing-oauth-apps.md b/content/developers/apps/managing-oauth-apps.md index e1bf769dedc6..18cb006f9119 100644 --- a/content/developers/apps/managing-oauth-apps.md +++ b/content/developers/apps/managing-oauth-apps.md @@ -9,5 +9,6 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- - diff --git a/content/developers/apps/migrating-oauth-apps-to-github-apps.md b/content/developers/apps/migrating-oauth-apps-to-github-apps.md index 21fbe532f286..eedbac7a4c33 100644 --- a/content/developers/apps/migrating-oauth-apps-to-github-apps.md +++ b/content/developers/apps/migrating-oauth-apps-to-github-apps.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/modifying-a-github-app.md b/content/developers/apps/modifying-a-github-app.md index 47392e13f0d8..39278961f90d 100644 --- a/content/developers/apps/modifying-a-github-app.md +++ b/content/developers/apps/modifying-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/modifying-an-oauth-app.md b/content/developers/apps/modifying-an-oauth-app.md index 73beec333732..7b15a86e19f9 100644 --- a/content/developers/apps/modifying-an-oauth-app.md +++ b/content/developers/apps/modifying-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/rate-limits-for-github-apps.md b/content/developers/apps/rate-limits-for-github-apps.md index 31607e2e14bb..2451916675d5 100644 --- a/content/developers/apps/rate-limits-for-github-apps.md +++ b/content/developers/apps/rate-limits-for-github-apps.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- ### Server-to-server requests diff --git a/content/developers/apps/refreshing-user-to-server-access-tokens.md b/content/developers/apps/refreshing-user-to-server-access-tokens.md index 3a21601f34cd..ca66b82b31bd 100644 --- a/content/developers/apps/refreshing-user-to-server-access-tokens.md +++ b/content/developers/apps/refreshing-user-to-server-access-tokens.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/scopes-for-oauth-apps.md b/content/developers/apps/scopes-for-oauth-apps.md index 366efeb18ba2..db6e24564976 100644 --- a/content/developers/apps/scopes-for-oauth-apps.md +++ b/content/developers/apps/scopes-for-oauth-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- When setting up an OAuth App on GitHub, requested scopes are displayed to the user on the authorization form. diff --git a/content/developers/apps/setting-permissions-for-github-apps.md b/content/developers/apps/setting-permissions-for-github-apps.md index 547f4457581c..4d9c1fb5572d 100644 --- a/content/developers/apps/setting-permissions-for-github-apps.md +++ b/content/developers/apps/setting-permissions-for-github-apps.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)." diff --git a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md index 3a35ecc6da70..6e4d57a59744 100644 --- a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md +++ b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/apps/suspending-a-github-app-installation.md b/content/developers/apps/suspending-a-github-app-installation.md index 8ec4ca2e0635..a619a278102b 100644 --- a/content/developers/apps/suspending-a-github-app-installation.md +++ b/content/developers/apps/suspending-a-github-app-installation.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - github apps --- ### Suspending a GitHub App diff --git a/content/developers/apps/transferring-ownership-of-a-github-app.md b/content/developers/apps/transferring-ownership-of-a-github-app.md index 118908599d38..0d9f093edf21 100644 --- a/content/developers/apps/transferring-ownership-of-a-github-app.md +++ b/content/developers/apps/transferring-ownership-of-a-github-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/transferring-ownership-of-an-oauth-app.md b/content/developers/apps/transferring-ownership-of-an-oauth-app.md index 59d1b1adc382..023d8477dd5e 100644 --- a/content/developers/apps/transferring-ownership-of-an-oauth-app.md +++ b/content/developers/apps/transferring-ownership-of-an-oauth-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% data reusables.user-settings.access_settings %} diff --git a/content/developers/apps/troubleshooting-authorization-request-errors.md b/content/developers/apps/troubleshooting-authorization-request-errors.md index 4620a4aa352b..aed485cc2bed 100644 --- a/content/developers/apps/troubleshooting-authorization-request-errors.md +++ b/content/developers/apps/troubleshooting-authorization-request-errors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- ### Application suspended diff --git a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md index c6b54ed2b21b..af14d423072a 100644 --- a/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md +++ b/content/developers/apps/troubleshooting-oauth-app-access-token-request-errors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - oauth apps --- {% note %} diff --git a/content/developers/apps/using-content-attachments.md b/content/developers/apps/using-content-attachments.md index ed9e9fde07dc..8fc92254359a 100644 --- a/content/developers/apps/using-content-attachments.md +++ b/content/developers/apps/using-content-attachments.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- {% data reusables.pre-release-program.content-attachments-public-beta %} diff --git a/content/developers/apps/using-the-github-api-in-your-app.md b/content/developers/apps/using-the-github-api-in-your-app.md index ebd8e6ed7151..d12842949950 100644 --- a/content/developers/apps/using-the-github-api-in-your-app.md +++ b/content/developers/apps/using-the-github-api-in-your-app.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - github apps --- diff --git a/content/developers/github-marketplace/about-github-marketplace.md b/content/developers/github-marketplace/about-github-marketplace.md index a5566fb0121e..cc3ca5561e2b 100644 --- a/content/developers/github-marketplace/about-github-marketplace.md +++ b/content/developers/github-marketplace/about-github-marketplace.md @@ -6,6 +6,8 @@ redirect_from: - /marketplace/getting-started versions: free-pro-team: '*' +topics: + - marketplace --- [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace) connects you to developers who want to extend and improve their {% data variables.product.prodname_dotcom %} workflows. You can list free and paid tools for developers to use in {% data variables.product.prodname_marketplace %}. {% data variables.product.prodname_marketplace %} offers developers two types of tools: {% data variables.product.prodname_actions %} and Apps, and each tool requires different steps for adding it to {% data variables.product.prodname_marketplace %}. diff --git a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md index 8919eee16ef6..f6c6257f9d79 100644 --- a/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md +++ b/content/developers/github-marketplace/applying-for-publisher-verification-for-your-organization.md @@ -3,6 +3,8 @@ title: Applying for publisher verification for your organization intro: 'To offer paid plans for your app or to include a marketplace badge in your app listing, you must complete the publisher verification process for your organization.' versions: free-pro-team: '*' +topics: + - marketplace --- Publisher verification ensures that {% data variables.product.prodname_dotcom %} has a way to contact you, that you've enabled two-factor authentication for your organization, and that your organization's domain has been verified. diff --git a/content/developers/github-marketplace/billing-customers.md b/content/developers/github-marketplace/billing-customers.md index ed6701d67117..2e578e145869 100644 --- a/content/developers/github-marketplace/billing-customers.md +++ b/content/developers/github-marketplace/billing-customers.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/selling-your-app/billing-customers-in-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md b/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md index 6ed97feecdb9..00e34854f16b 100644 --- a/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md +++ b/content/developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes.md @@ -9,6 +9,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/creating-apps-for-github-marketplace.md b/content/developers/github-marketplace/creating-apps-for-github-marketplace.md index 342754e94dfb..1db26ad8f208 100644 --- a/content/developers/github-marketplace/creating-apps-for-github-marketplace.md +++ b/content/developers/github-marketplace/creating-apps-for-github-marketplace.md @@ -4,5 +4,7 @@ intro: 'You can list free and paid tools for developers to use in {% data variab mapTopic: true versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md b/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md index 4107fa4427f4..b739663a7dad 100644 --- a/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md +++ b/content/developers/github-marketplace/customer-experience-best-practices-for-apps.md @@ -1,9 +1,11 @@ --- title: Customer experience best practices for apps -intro: 'Guidelines for creating an app that will be easy to use and understand.' +intro: Guidelines for creating an app that will be easy to use and understand. shortTitle: Customer experience best practice versions: free-pro-team: '*' +topics: + - marketplace --- If you follow these best practices it will help you to provide a good customer experience. diff --git a/content/developers/github-marketplace/drafting-a-listing-for-your-app.md b/content/developers/github-marketplace/drafting-a-listing-for-your-app.md index c495928b43cf..85fcb55cc2fa 100644 --- a/content/developers/github-marketplace/drafting-a-listing-for-your-app.md +++ b/content/developers/github-marketplace/drafting-a-listing-for-your-app.md @@ -14,6 +14,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md b/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md index 94b29c63ff7a..0809b8196c49 100644 --- a/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md +++ b/content/developers/github-marketplace/handling-new-purchases-and-free-trials.md @@ -8,6 +8,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-plan-cancellations.md b/content/developers/github-marketplace/handling-plan-cancellations.md index ed287efb5efd..2334e0fe9a57 100644 --- a/content/developers/github-marketplace/handling-plan-cancellations.md +++ b/content/developers/github-marketplace/handling-plan-cancellations.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/handling-plan-changes.md b/content/developers/github-marketplace/handling-plan-changes.md index 7fb64dd96c03..a567ed24d957 100644 --- a/content/developers/github-marketplace/handling-plan-changes.md +++ b/content/developers/github-marketplace/handling-plan-changes.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/index.md b/content/developers/github-marketplace/index.md index 9d018cfe810f..96571894ae00 100644 --- a/content/developers/github-marketplace/index.md +++ b/content/developers/github-marketplace/index.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace versions: free-pro-team: '*' +topics: + - marketplace --- {% topic_link_in_list /github-marketplace-overview %} diff --git a/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md b/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md index 58924a15d0ef..cfe604c53ed6 100644 --- a/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md +++ b/content/developers/github-marketplace/listing-an-app-on-github-marketplace.md @@ -13,5 +13,7 @@ redirect_from: - /marketplace/listing-on-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md b/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md index 8e765778101b..33e7aeecccc0 100644 --- a/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md +++ b/content/developers/github-marketplace/pricing-plans-for-github-marketplace-apps.md @@ -6,6 +6,8 @@ redirect_from: - /marketplace/selling-your-app/github-marketplace-pricing-plans versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md index 0264e77e2ec2..85bb10404272 100644 --- a/content/developers/github-marketplace/receiving-payment-for-app-purchases.md +++ b/content/developers/github-marketplace/receiving-payment-for-app-purchases.md @@ -9,6 +9,8 @@ redirect_from: - /marketplace/selling-your-app/receiving-payment-for-github-marketplace-listings versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/requirements-for-listing-an-app.md b/content/developers/github-marketplace/requirements-for-listing-an-app.md index 3a2a3d1be37b..05213fa2b8f7 100644 --- a/content/developers/github-marketplace/requirements-for-listing-an-app.md +++ b/content/developers/github-marketplace/requirements-for-listing-an-app.md @@ -10,6 +10,8 @@ redirect_from: - /marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md index db3482b99240..09ae762f8873 100644 --- a/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md +++ b/content/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/security-best-practices-for-apps.md b/content/developers/github-marketplace/security-best-practices-for-apps.md index fac3d2fcf682..b8be78bbfa6f 100644 --- a/content/developers/github-marketplace/security-best-practices-for-apps.md +++ b/content/developers/github-marketplace/security-best-practices-for-apps.md @@ -8,6 +8,8 @@ redirect_from: shortTitle: Security best practice versions: free-pro-team: '*' +topics: + - marketplace --- If you follow these best practices it will help you to provide a secure user experience. diff --git a/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md b/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md index e468593f58f7..5b643723ff3d 100644 --- a/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md +++ b/content/developers/github-marketplace/selling-your-app-on-github-marketplace.md @@ -11,5 +11,7 @@ redirect_from: - /marketplace/selling-your-app versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md b/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md index 14fb5e0e67ce..7b7f3014d482 100644 --- a/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md +++ b/content/developers/github-marketplace/setting-pricing-plans-for-your-listing.md @@ -15,6 +15,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan versions: free-pro-team: '*' +topics: + - marketplace --- ### About setting pricing plans diff --git a/content/developers/github-marketplace/submitting-your-listing-for-publication.md b/content/developers/github-marketplace/submitting-your-listing-for-publication.md index f56182b6ba7f..eba474e22eb6 100644 --- a/content/developers/github-marketplace/submitting-your-listing-for-publication.md +++ b/content/developers/github-marketplace/submitting-your-listing-for-publication.md @@ -6,6 +6,8 @@ redirect_from: - /developers/github-marketplace/submitting-your-listing-for-review versions: free-pro-team: '*' +topics: + - marketplace --- Once your app listing meets the {% data variables.product.prodname_marketplace %} requirements, you can submit your app. For an overview of the app listing requirements, see "[Requirements for listing an app](/developers/github-marketplace/requirements-for-listing-an-app)." diff --git a/content/developers/github-marketplace/testing-your-app.md b/content/developers/github-marketplace/testing-your-app.md index 577b6d624a35..e587a94908e4 100644 --- a/content/developers/github-marketplace/testing-your-app.md +++ b/content/developers/github-marketplace/testing-your-app.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md b/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md index 79b8ccfe4321..684636305145 100644 --- a/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md +++ b/content/developers/github-marketplace/using-the-github-marketplace-api-in-your-app.md @@ -8,5 +8,7 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/viewing-metrics-for-your-listing.md b/content/developers/github-marketplace/viewing-metrics-for-your-listing.md index de4918046671..3621b2e7b8aa 100644 --- a/content/developers/github-marketplace/viewing-metrics-for-your-listing.md +++ b/content/developers/github-marketplace/viewing-metrics-for-your-listing.md @@ -8,6 +8,8 @@ redirect_from: - /marketplace/github-marketplace-insights versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md index b0c801eaa06a..60f69eafb425 100644 --- a/content/developers/github-marketplace/viewing-transactions-for-your-listing.md +++ b/content/developers/github-marketplace/viewing-transactions-for-your-listing.md @@ -5,6 +5,8 @@ redirect_from: - /marketplace/github-marketplace-transactions versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md b/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md index 96594bbc6146..71772c127c22 100644 --- a/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md +++ b/content/developers/github-marketplace/webhook-events-for-the-github-marketplace-api.md @@ -7,6 +7,8 @@ redirect_from: - /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md index 7dabc220bbe3..50544a871f99 100644 --- a/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md +++ b/content/developers/github-marketplace/writing-a-listing-description-for-your-app.md @@ -12,6 +12,8 @@ redirect_from: - /marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions versions: free-pro-team: '*' +topics: + - marketplace --- diff --git a/content/developers/overview/about-githubs-apis.md b/content/developers/overview/about-githubs-apis.md index e60baa72e325..7141a1ac7455 100644 --- a/content/developers/overview/about-githubs-apis.md +++ b/content/developers/overview/about-githubs-apis.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- There are two stable versions of the GitHub API: the [REST API](/rest) and the [GraphQL API](/graphql). When using the REST API, we encourage you to [request v3 via the `Accept` header](/v3/media/#request-specific-version). For information on using the GraphQL API, see the [v4 docs](/graphql). diff --git a/content/developers/overview/github-developer-program.md b/content/developers/overview/github-developer-program.md index 343241fd6fcc..947b290ce3e4 100644 --- a/content/developers/overview/github-developer-program.md +++ b/content/developers/overview/github-developer-program.md @@ -5,6 +5,8 @@ redirect_from: - /program versions: free-pro-team: '*' +topics: + - api --- Building an application that integrates with GitHub? Register for our Developer Program! The possibilities are endless, and you enjoy the kudos. [Register now](https://github.com/developer/register) diff --git a/content/developers/overview/managing-deploy-keys.md b/content/developers/overview/managing-deploy-keys.md index d97cec639142..ad419e871707 100644 --- a/content/developers/overview/managing-deploy-keys.md +++ b/content/developers/overview/managing-deploy-keys.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/developers/overview/replacing-github-services.md b/content/developers/overview/replacing-github-services.md index 878a316bd5b2..05f75c507968 100644 --- a/content/developers/overview/replacing-github-services.md +++ b/content/developers/overview/replacing-github-services.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - api --- diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning.md index 278f89e67288..9c2d39bf94f0 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning.md @@ -7,6 +7,8 @@ redirect_from: - /partnerships/secret-scanning versions: free-pro-team: '*' +topics: + - api --- {% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories, and can be enabled on private repositories by repository administrators or organization owners. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. diff --git a/content/developers/overview/using-ssh-agent-forwarding.md b/content/developers/overview/using-ssh-agent-forwarding.md index 81b5ffbd5f04..dfa6e0efc483 100644 --- a/content/developers/overview/using-ssh-agent-forwarding.md +++ b/content/developers/overview/using-ssh-agent-forwarding.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- diff --git a/content/developers/overview/viewing-deployment-history.md b/content/developers/overview/viewing-deployment-history.md index 05d8099b7812..5d9f72158188 100644 --- a/content/developers/overview/viewing-deployment-history.md +++ b/content/developers/overview/viewing-deployment-history.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - api --- {% data reusables.actions.environments-beta %} diff --git a/content/developers/webhooks-and-events/about-webhooks.md b/content/developers/webhooks-and-events/about-webhooks.md index 3123eb318316..1c4708f577e0 100644 --- a/content/developers/webhooks-and-events/about-webhooks.md +++ b/content/developers/webhooks-and-events/about-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md index c4787dcc97ce..42464d48efa3 100644 --- a/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md +++ b/content/developers/webhooks-and-events/configuring-your-server-to-receive-payloads.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/creating-webhooks.md b/content/developers/webhooks-and-events/creating-webhooks.md index 17d3ac7a2450..ab6e95e7bb98 100644 --- a/content/developers/webhooks-and-events/creating-webhooks.md +++ b/content/developers/webhooks-and-events/creating-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/events.md b/content/developers/webhooks-and-events/events.md index 6fead511c2a3..761e6b24722d 100644 --- a/content/developers/webhooks-and-events/events.md +++ b/content/developers/webhooks-and-events/events.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- diff --git a/content/developers/webhooks-and-events/github-event-types.md b/content/developers/webhooks-and-events/github-event-types.md index 72098b42fa5d..74579398db1a 100644 --- a/content/developers/webhooks-and-events/github-event-types.md +++ b/content/developers/webhooks-and-events/github-event-types.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- diff --git a/content/developers/webhooks-and-events/index.md b/content/developers/webhooks-and-events/index.md index 8fe5ba3cd8d9..e433da040333 100644 --- a/content/developers/webhooks-and-events/index.md +++ b/content/developers/webhooks-and-events/index.md @@ -5,6 +5,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks + - events --- ### Table of Contents diff --git a/content/developers/webhooks-and-events/issue-event-types.md b/content/developers/webhooks-and-events/issue-event-types.md index 9da44234bd73..41380543d17d 100644 --- a/content/developers/webhooks-and-events/issue-event-types.md +++ b/content/developers/webhooks-and-events/issue-event-types.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - events --- diff --git a/content/developers/webhooks-and-events/securing-your-webhooks.md b/content/developers/webhooks-and-events/securing-your-webhooks.md index c32343b777a2..cfdf4c9a1ed1 100644 --- a/content/developers/webhooks-and-events/securing-your-webhooks.md +++ b/content/developers/webhooks-and-events/securing-your-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/testing-webhooks.md b/content/developers/webhooks-and-events/testing-webhooks.md index 37357733633b..ba40fe2cb43b 100644 --- a/content/developers/webhooks-and-events/testing-webhooks.md +++ b/content/developers/webhooks-and-events/testing-webhooks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index 2336205b8530..1ceeba193987 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/developers/webhooks-and-events/webhooks.md b/content/developers/webhooks-and-events/webhooks.md index ce6641349041..9a1347c894be 100644 --- a/content/developers/webhooks-and-events/webhooks.md +++ b/content/developers/webhooks-and-events/webhooks.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - webhooks --- diff --git a/content/discussions/guides/best-practices-for-community-conversations-on-github.md b/content/discussions/guides/best-practices-for-community-conversations-on-github.md index e4cc2321b6c6..6631fd4d3ccc 100644 --- a/content/discussions/guides/best-practices-for-community-conversations-on-github.md +++ b/content/discussions/guides/best-practices-for-community-conversations-on-github.md @@ -29,7 +29,7 @@ You can use {% data variables.product.prodname_discussions %} to discuss big pic Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." ### Following contributing guidelines diff --git a/content/github/administering-a-repository/about-dependabot-version-updates.md b/content/github/administering-a-repository/about-dependabot-version-updates.md index 11f5a21c948e..d96a8719f3eb 100644 --- a/content/github/administering-a-repository/about-dependabot-version-updates.md +++ b/content/github/administering-a-repository/about-dependabot-version-updates.md @@ -5,9 +5,10 @@ redirect_from: - /github/administering-a-repository/about-dependabot - /github/administering-a-repository/about-github-dependabot - /github/administering-a-repository/about-github-dependabot-version-updates - versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} @@ -40,7 +41,9 @@ You can configure version updates for repositories that contain a dependency man {% note %} -{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below. +{% data reusables.dependabot.private-dependencies-note %} + +{% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below. {% endnote %} diff --git a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md index 792bfec4bcf3..88b8fbb6d77e 100644 --- a/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md +++ b/content/github/administering-a-repository/about-email-notifications-for-pushes-to-your-repository.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.notifications.outbound_email_tip %} diff --git a/content/github/administering-a-repository/about-merge-methods-on-github.md b/content/github/administering-a-repository/about-merge-methods-on-github.md index d8928317a6d9..6533a3ec45c7 100644 --- a/content/github/administering-a-repository/about-merge-methods-on-github.md +++ b/content/github/administering-a-repository/about-merge-methods-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} You can enforce one type of merge method, such as commit squashing or rebasing, by only enabling the desired method for your repository. diff --git a/content/github/administering-a-repository/about-protected-branches.md b/content/github/administering-a-repository/about-protected-branches.md index c842929a11b3..1dc9ce75c336 100644 --- a/content/github/administering-a-repository/about-protected-branches.md +++ b/content/github/administering-a-repository/about-protected-branches.md @@ -19,6 +19,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About branch protection rules diff --git a/content/github/administering-a-repository/about-releases.md b/content/github/administering-a-repository/about-releases.md index 81ade4c4b07f..fc0699c303e2 100644 --- a/content/github/administering-a-repository/about-releases.md +++ b/content/github/administering-a-repository/about-releases.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About releases diff --git a/content/github/administering-a-repository/about-secret-scanning.md b/content/github/administering-a-repository/about-secret-scanning.md index 8835b2c460b4..38696dfe50df 100644 --- a/content/github/administering-a-repository/about-secret-scanning.md +++ b/content/github/administering-a-repository/about-secret-scanning.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} diff --git a/content/github/administering-a-repository/about-securing-your-repository.md b/content/github/administering-a-repository/about-securing-your-repository.md index e383cbb71e69..a98f29f30471 100644 --- a/content/github/administering-a-repository/about-securing-your-repository.md +++ b/content/github/administering-a-repository/about-securing-your-repository.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- ### Setting up your repository securely diff --git a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md index a24e1145b917..10e4011e888f 100644 --- a/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md +++ b/content/github/administering-a-repository/automation-for-release-forms-with-query-parameters.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Query parameters are optional parts of a URL you can customize to share a specific web page view, such as search filter results, an issue template, or the release form page on {% data variables.product.prodname_dotcom %}. To create your own query parameters, you must match the key and value pair. diff --git a/content/github/administering-a-repository/changing-the-default-branch.md b/content/github/administering-a-repository/changing-the-default-branch.md index cefd27c27174..f1f0f892bd79 100644 --- a/content/github/administering-a-repository/changing-the-default-branch.md +++ b/content/github/administering-a-repository/changing-the-default-branch.md @@ -9,6 +9,8 @@ versions: redirect_from: - /github/administering-a-repository/setting-the-default-branch - /articles/setting-the-default-branch +topics: + - repositories --- ### About changing the default branch diff --git a/content/github/administering-a-repository/classifying-your-repository-with-topics.md b/content/github/administering-a-repository/classifying-your-repository-with-topics.md index a187c9313d94..8918184c6ba3 100644 --- a/content/github/administering-a-repository/classifying-your-repository-with-topics.md +++ b/content/github/administering-a-repository/classifying-your-repository-with-topics.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About topics diff --git a/content/github/administering-a-repository/comparing-releases.md b/content/github/administering-a-repository/comparing-releases.md index 7e57598c486d..ae83a329db25 100644 --- a/content/github/administering-a-repository/comparing-releases.md +++ b/content/github/administering-a-repository/comparing-releases.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.21' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md index efb5609671d9..bae978220c04 100644 --- a/content/github/administering-a-repository/configuration-options-for-dependency-updates.md +++ b/content/github/administering-a-repository/configuration-options-for-dependency-updates.md @@ -2,8 +2,11 @@ title: Configuration options for dependency updates intro: 'Detailed information for all the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories.' permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.' +miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} @@ -14,9 +17,11 @@ The {% data variables.product.prodname_dependabot %} configuration file, *depend You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Enabling and disabling version updates](/github/administering-a-repository/enabling-and-disabling-version-updates)" and "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/configuring-dependabot-security-updates)." -### Configuration options for *dependabot.yml* +The *dependabot.yml* file has two mandatory top-level keys: `version`, and `updates`. You can, optionally, include a top-level `registries` key. The file must start with `version: 2`. -The *dependabot.yml* file must start with `version: 2` followed by an array of `updates`. +### Configuration options for updates + +The top-level `updates` key is mandatory. You use it to configure how {% data variables.product.prodname_dependabot %} updates the versions or your project's dependencies. Each entry configures the update settings for a particular package manager. You can use the following options. | Option | Required | Description | |:---|:---:|:---| @@ -27,11 +32,13 @@ The *dependabot.yml* file must start with `version: 2` followed by an array of ` | [`assignees`](#assignees) | | Assignees to set on pull requests | | [`commit-message`](#commit-message) | | Commit message preferences | | [`ignore`](#ignore) | | Ignore certain dependencies or versions | +| [`insecure-external-code-execution`](#insecure-external-code-execution) | | Allow or deny code execution in manifest files | | [`labels`](#labels) | | Labels to set on pull requests | | [`milestone`](#milestone) | | Milestone to set on pull requests | | [`open-pull-requests-limit`](#open-pull-requests-limit) | | Limit number of open pull requests for version updates| | [`pull-request-branch-name.separator`](#pull-request-branch-nameseparator) | | Change separator for pull request branch names | | [`rebase-strategy`](#rebase-strategy) | | Disable automatic rebasing | +| [`registries`](#registries) | | Private registries that {% data variables.product.prodname_dependabot %} can access| | [`reviewers`](#reviewers) | | Reviewers to set on pull requests | | [`schedule.day`](#scheduleday) | | Day of week to check for updates | | [`schedule.time`](#scheduletime) | | Time of day to check for updates (hh:mm) | @@ -60,9 +67,9 @@ In general, security updates use any configuration options that affect pull requ {% endnote %} -### `package-ecosystem` +#### `package-ecosystem` -**Required** You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below. +**Required**. You add one `package-ecosystem` element for each package manager that you want {% data variables.product.prodname_dependabot %} to monitor for new versions. The repository must also contain a dependency manifest or lock file for each of these package managers. If you want to enable vendoring for a package manager that supports it, the vendored dependencies must be located in the required directory. For more information, see [`vendor`](#vendor) below. {% data reusables.dependabot.supported-package-managers %} @@ -91,9 +98,9 @@ updates: interval: "daily" ``` -### `directory` +#### `directory` -**Required** You must define the location of the package manifests for each package manager (for example, the *package.json* or *Gemfile*). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. +**Required**. You must define the location of the package manifests for each package manager (for example, the *package.json* or *Gemfile*). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. ```yaml # Specify location of manifest files for each package manager @@ -120,9 +127,9 @@ updates: interval: "daily" ``` -### `schedule.interval` +#### `schedule.interval` -**Required** You must define how often to check for new versions for each package manager. By default, this is at 5am UTC. To modify this, use [`schedule.time`](#scheduletime) and [`schedule.timezone`](#scheduletimezone). +**Required**. You must define how often to check for new versions for each package manager. By default, this is at 5am UTC. To modify this, use [`schedule.time`](#scheduletime) and [`schedule.timezone`](#scheduletimezone). - `daily`—runs on every weekday, Monday to Friday. - `weekly`—runs once each week. By default, this is on Monday. To modify this, use [`schedule.day`](#scheduleday). @@ -153,7 +160,7 @@ updates: {% endnote %} -### `allow` +#### `allow` {% data reusables.dependabot.default-dependencies-allow-ignore %} @@ -171,7 +178,7 @@ Use the `allow` option to customize which dependencies are updated. This has no | `development`| `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` | Only dependencies in the "Development dependency group". | ```yaml -# Customizing the dependencies to maintain with `allow` +# Use `allow` to specify which dependencies to maintain version: 2 updates: @@ -207,7 +214,7 @@ updates: dependency-type: "production" ``` -### `assignees` +#### `assignees` Use `assignees` to specify individual assignees for all pull requests raised for a package manager. @@ -227,7 +234,7 @@ updates: - "octocat" ``` -### `commit-message` +#### `commit-message` By default, {% data variables.product.prodname_dependabot %} attempts to detect your commit message preferences and use similar patterns. Use the `commit-message` option to specify your preferences explicitly. @@ -240,7 +247,7 @@ Supported options {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Customizing commit messages +# Customize commit messages version: 2 updates: @@ -274,17 +281,17 @@ updates: include: "scope" ``` -### `ignore` +#### `ignore` {% data reusables.dependabot.warning-ignore-option %} -#### Checking for existing ignore preferences +##### Checking for existing ignore preferences Before you add an `ignore` option to the configuration file, check whether you've previously used any of the `@dependabot ignore` commands on a security update or version update pull request. {% data variables.product.prodname_dependabot %} stores these preferences for each package manager centrally and this information is overwritten by the `ignore` option. For more information about the `@dependabot ignore` commands, see "[Managing pull requests for dependency updates](/github/administering-a-repository/managing-pull-requests-for-dependency-updates)." You can check whether a repository has stored preferences by searching the repository for `"@dependabot ignore" in:comments`. If you review any pull requests in the results, you can decide whether or not to specify those ignored dependencies or versions in the configuration file. -#### Specifying dependencies and versions to ignore +##### Specifying dependencies and versions to ignore {% data reusables.dependabot.default-dependencies-allow-ignore %} @@ -296,7 +303,7 @@ You can use the `ignore` option to customize which dependencies are updated. The {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Customizing the dependencies to maintain with `ignore` +# Use `ignore` to specify dependencies that should not be updated version: 2 updates: @@ -314,12 +321,38 @@ updates: {% note %} -**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." +**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-dependencies)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)." {% endnote %} -### `labels` +#### `insecure-external-code-execution` + +Package managers with the `package-ecosystem` values `bundler`, `mix`, and `pip` may execute external code in the manifest as part of the version update process. This might allow a compromised package to steal credentials or gain access to configured registries. When you add a [`registries`](#registries) setting within an `updates` configuration, {% data variables.product.prodname_dependabot %} automatically prevents external code execution, in which case the version update may fail. You can choose to override this behavior and allow external code execution for `bundler`, `mix`, and `pip` package managers by setting `insecure-external-code-execution` to `allow`. + +You can explicitly deny external code execution, irrespective of whether there is a `registries` setting for this update configuration, by setting `insecure-external-code-execution` to `deny`. + +{% raw %} +```yaml +# Allow external code execution when updating dependencies from private registries + +version: 2 +registries: + ruby-github: + type: rubygems-server + url: https://rubygems.pkg.github.com/octocat/github_api + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +updates: + - package-ecosystem: "bundler" + directory: "/rubygems-server" + insecure-external-code-execution: allow + registries: "*" + schedule: + interval: "monthly" +``` +{% endraw %} + +#### `labels` {% data reusables.dependabot.default-labels %} @@ -343,7 +376,7 @@ updates: - "dependencies" ``` -### `milestone` +#### `milestone` Use `milestone` to associate all pull requests raised for a package manager with a milestone. You need to specify the numeric identifier of the milestone and not its label. If you view a milestone, the final part of the page URL, after `milestone`, is the identifier. For example: `https://github.com///milestone/3`. @@ -362,14 +395,14 @@ updates: milestone: 4 ``` -### `open-pull-requests-limit` +#### `open-pull-requests-limit` By default, {% data variables.product.prodname_dependabot %} opens a maximum of five pull requests for version updates. Once there are five open pull requests, new requests are blocked until you merge or close some of the open requests, after which new pull requests can be opened on subsequent updates. Use `open-pull-requests-limit` to change this limit. This also provides a simple way to temporarily disable version updates for a package manager. This option has no impact on security updates, which have a separate, internal limit of ten open pull requests. ```yaml -# Changing the number of open pull requests allowed +# Specify the number of open pull requests allowed version: 2 updates: @@ -388,7 +421,7 @@ updates: open-pull-requests-limit: 10 ``` -### `pull-request-branch-name.separator` +#### `pull-request-branch-name.separator` {% data variables.product.prodname_dependabot %} generates a branch for each pull request. Each branch name includes `dependabot`, and the package manager and dependency that are updated. By default, these parts are separated by a `/` symbol, for example: `dependabot/npm_and_yarn/next_js/acorn-6.4.1`. @@ -397,7 +430,7 @@ Use `pull-request-branch-name.separator` to specify a different separator. This {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Specifying a different separator for branch names +# Specify a different separator for branch names version: 2 updates: @@ -411,7 +444,7 @@ updates: separator: "-" ``` -### `rebase-strategy` +#### `rebase-strategy` By default, {% data variables.product.prodname_dependabot %} automatically rebases open pull requests when it detects conflicts. Use `rebase-strategy` to disable this behavior. @@ -423,7 +456,7 @@ Available rebase strategies {% data reusables.dependabot.option-affects-security-updates %} ```yaml -# Disabling automatic rebasing +# Disable automatic rebasing version: 2 updates: @@ -435,7 +468,39 @@ updates: rebase-strategy: "disabled" ``` -### `reviewers` +#### `registries` + +To allow {% data variables.product.prodname_dependabot %} to access a private package registry when performing a version update, you must include a `registries` setting within the relevant `updates` configuration. You can allow all of the defined registries to be used by setting `registries` to `"*"`. Alternatively, you can list the registries that the update can use. To do this, use the name of the registry as defined in the top-level `registries` section of the _dependabot.yml_ file. + +To allow {% data variables.product.prodname_dependabot %} to use `bundler`, `mix`, and `pip` package managers to update dependencies in private registries, you can choose to allow external code execution. For more information, see [`insecure-external-code-execution`](#insecure-external-code-execution). + +{% raw %} +```yaml +# Allow {% data variables.product.prodname_dependabot %} to use one of the two defined private registries +# when updating dependency versions for this ecosystem + +version: 2 +registries: + maven-github: + type: maven-repository + url: https://maven.pkg.github.com/octocat + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} + npm-npmjs: + type: npm-registry + url: https://registry.npmjs.org + username: octocat + password: ${{secrets.MY_NPM_PASSWORD}} +updates: + - package-ecosystem: "gitsubmodule" + directory: "/" + registries: + - maven-github + schedule: + interval: "monthly" +``` +{% endraw %} + +#### `reviewers` Use `reviewers` to specify individual reviewers or teams of reviewers for all pull requests raised for a package manager. You must use the full team name, including the organization, as if you were @mentioning the team. @@ -457,7 +522,7 @@ updates: - "my-org/python-team" ``` -### `schedule.day` +#### `schedule.day` When you set a `weekly` update schedule, by default, {% data variables.product.prodname_dependabot %} checks for new versions on Monday at 05:00 UTC. Use `schedule.day` to specify an alternative day to check for updates. @@ -484,7 +549,7 @@ updates: day: "sunday" ``` -### `schedule.time` +#### `schedule.time` By default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. Use `schedule.time` to specify an alternative time of day to check for updates (format: `hh:mm`). @@ -500,7 +565,7 @@ updates: time: "09:00" ``` -### `schedule.timezone` +#### `schedule.timezone` By default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. Use `schedule.timezone` to specify an alternative time zone. The time zone identifier must be from the Time Zone database maintained by [iana](https://www.iana.org/time-zones). For more information, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). @@ -518,7 +583,7 @@ updates: timezone: "Asia/Tokyo" ``` -### `target-branch` +#### `target-branch` By default, {% data variables.product.prodname_dependabot %} checks for manifest files on the default branch and raises pull requests for version updates against this branch. Use `target-branch` to specify a different branch for manifest files and for pull requests. When you use this option, the settings for this package manager will no longer affect any pull requests raised for security updates. @@ -549,7 +614,7 @@ updates: - "npm dependencies" ``` -### `vendor` +#### `vendor` Use the `vendor` option to tell {% data variables.product.prodname_dependabot %} to vendor dependencies when updating them. Don't use this option if you're using `gomod` as {% data variables.product.prodname_dependabot %} automatically detects vendoring for this tool. @@ -574,7 +639,7 @@ updates: | `gomod` | No path requirement (dependencies are usually located in the _vendor_ directory) | [`go mod vendor` documentation](https://golang.org/ref/mod#go-mod-vendor) | -### `versioning-strategy` +#### `versioning-strategy` When {% data variables.product.prodname_dependabot %} edits a manifest file to update a version, it uses the following overall strategies: @@ -596,7 +661,7 @@ Available update strategies | `increase-if-necessary` | `bundler`, `composer`, `npm` | Increase the version requirement only when required by the new version. | ```yaml -# Customizing the manifest version strategy +# Customize the manifest version strategy version: 2 updates: @@ -624,3 +689,222 @@ updates: # ignore any version updates that affect the manifest versioning-strategy: lockfile-only ``` + +### Configuration options for private registries + +The top-level `registries` key is optional. It allows you to specify authentication details that {% data variables.product.prodname_dependabot %} can use to access private package registries. + +{% note %} + +**Note:** Private registries behind firewalls on private networks are not supported. + +{% endnote %} + +The value of the `registries` key is an associative array, each element of which consists of a key that identifies a particular registry and a value which is an associative array that specifies the settings required to access that registry. The following *dependabot.yml* file, configures a registry identified as `dockerhub` in the `registries` section of the file and then references this in the `updates` section of the file. + +{% raw %} +```yaml +# Minimal settings to update dependencies in one private registry + +version: 2 +registries: + dockerhub: # Define access for a private registry + type: docker-registry + url: registry.hub.docker.com + username: octocat + password: ${{secrets.DOCKERHUB_PASSWORD}} +updates: + - package-ecosystem: "docker" + directory: "/docker-registry/dockerhub" + registries: + - dockerhub # Allow version updates for dependencies in this registry + schedule: + interval: "monthly" +``` +{% endraw %} + +You use the following options to specify access settings. Registry settings must contain a `type` and a `url`, and typically either a `username` and `password` combination or a `token`. + +| Option                 | Description | +|:---|:---| +| `type` | Identifies the type of registry. See the full list of types below. | +| `url` | The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, `https://` is assumed. {% data variables.product.prodname_dependabot %} adds or ignores trailing slashes as required. | +| `username` | The username that {% data variables.product.prodname_dependabot %} uses to access the registry. | +| `password` | A reference to a {% data variables.product.prodname_dependabot %} secret containing the password for the specified user. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | +| `token` | A reference to a {% data variables.product.prodname_dependabot %} secret containing an access token for this registry. For more information, see "[Managing encrypted secrets for Dependabot](/github/administering-a-repository/managing-encrypted-secrets-for-dependabot)." | +| `replaces-base` | For registries with `type: python-index`, if the boolean value is `true`, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default `https://pypi.org/simple`). | + + +Each configuration `type` requires you to provide particular settings. Some types allow more than one way to connect. The following sections provide details of the settings you should use for each `type`. + +#### `composer-repository` + +The `composer-repository` type supports username and password. + +{% raw %} +```yaml +registries: + composer: + type: composer-repository + url: https://repo.packagist.com/example-company/ + username: octocat + password: ${{secrets.MY_PACKAGIST_PASSWORD}} +``` +{% endraw %} + +#### `docker-registry` + +The `docker-registry` type supports username and password. + +{% raw %} +```yaml +registries: + dockerhub: + type: docker-registry + url: https://registry.hub.docker.com + username: octocat + password: ${{secrets.MY_DOCKERHUB_PASSWORD}} +``` +{% endraw %} + +#### `git` + +The `git` type supports username and password. + +{% raw %} +```yaml +registries: + github-octocat: + type: git + url: https://github.com + username: x-access-token + password: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `maven-repository` + +The `maven-repository` type supports username and password, or token. + +{% raw %} +```yaml +registries: + maven-artifactory: + type: maven-repository + url: https://artifactory.example.com + username: octocat + password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + maven-github: + type: maven-repository + url: https://maven.pkg.github.com/octocat + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `npm-registry` + +The `npm-registry` type supports username and password, or token. + +{% raw %} +```yaml +registries: + npm-npmjs: + type: npm-registry + url: https://registry.npmjs.org + username: octocat + password: ${{secrets.MY_NPM_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + npm-github: + type: npm-registry + url: https://npm.pkg.github.com + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} + +#### `nuget-feed` + +The `nuget-feed` type supports username and password, or token. + +{% raw %} +```yaml +registries: + nuget-example: + type: nuget-feed + url: https://nuget.example.com/v3/index.json + username: octocat@example.com + password: ${{secrets.MY_NUGET_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + nuget-azure-devops: + type: nuget-feed + url: https://pkgs.dev.azure.com/.../_packaging/My_Feed/nuget/v3/index.json + token: ${{secrets.MY_AZURE_DEVOPS_TOKEN}} +``` +{% endraw %} + +#### `python-index` + +The `python-index` type supports username and password, or token. + +{% raw %} +```yaml +registries: + python-example: + type: python-index + url: https://example.com/_packaging/my-feed/pypi/example + username: octocat + password: ${{secrets.MY_BASIC_AUTH_PASSWORD}} + replaces-base: true +``` +{% endraw %} + +{% raw %} +```yaml +registries: + python-azure: + type: python-index + url: https://pkgs.dev.azure.com/octocat/_packaging/my-feed/pypi/example + token: ${{secrets.MY_AZURE_DEVOPS_TOKEN}} + replaces-base: true +``` +{% endraw %} + +#### `rubygems-server` + +The `rubygems-server` type supports username and password, or token. + +{% raw %} +```yaml +registries: + ruby-example: + type: rubygems-server + url: https://rubygems.example.com + username: octocat@example.com + password: ${{secrets.MY_RUBYGEMS_PASSWORD}} +``` +{% endraw %} + +{% raw %} +```yaml +registries: + ruby-github: + type: rubygems-server + url: https://rubygems.pkg.github.com/octocat/github_api + token: ${{secrets.MY_GITHUB_PERSONAL_TOKEN}} +``` +{% endraw %} \ No newline at end of file diff --git a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md index dafdd7d9e58c..023771cbe11c 100644 --- a/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md +++ b/content/github/administering-a-repository/configuring-autolinks-to-reference-external-resources.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Anyone with admin permissions to a repository can configure autolink references to link issues, pull requests,{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} commit messages, and release descriptions{% else %} and commit messages{% endif %} to external third-party services. diff --git a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md index eb2944629f7c..2a8e4a235be4 100644 --- a/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md +++ b/content/github/administering-a-repository/configuring-commit-rebasing-for-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} diff --git a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md index 8a3a1cde8cd8..010fbbcb586e 100644 --- a/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md +++ b/content/github/administering-a-repository/configuring-commit-squashing-for-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.pull_requests.configure_pull_request_merges_intro %} diff --git a/content/github/administering-a-repository/configuring-pull-request-merges.md b/content/github/administering-a-repository/configuring-pull-request-merges.md index f42c9d2a9a30..4f05c5af5ae3 100644 --- a/content/github/administering-a-repository/configuring-pull-request-merges.md +++ b/content/github/administering-a-repository/configuring-pull-request-merges.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md index 27105cdd2f2a..1060d920096a 100644 --- a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md +++ b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} diff --git a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md index 8c100e064bce..309dca088f9f 100644 --- a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md +++ b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.23' github-ae: '*' +topics: + - repositories --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/administering-a-repository/customizing-dependency-updates.md b/content/github/administering-a-repository/customizing-dependency-updates.md index 95340f31d2d8..8d078b68fc26 100644 --- a/content/github/administering-a-repository/customizing-dependency-updates.md +++ b/content/github/administering-a-repository/customizing-dependency-updates.md @@ -4,6 +4,8 @@ intro: 'You can customize how {% data variables.product.prodname_dependabot %} m permissions: 'People with write permissions to a repository can configure {% data variables.product.prodname_dependabot %} for the repository.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md index 77d1e3d332f3..1e5e81df5b9e 100644 --- a/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md +++ b/content/github/administering-a-repository/customizing-how-changed-files-appear-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Use a *.gitattributes* file to mark files that match a given "pattern" with the specified attributes. A *.gitattributes* file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation. diff --git a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md index 10a7cc56547a..beb609f0db98 100644 --- a/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md +++ b/content/github/administering-a-repository/customizing-your-repositorys-social-media-preview.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Until you add an image, repository links expand to show basic information about the repository and the owner's avatar. Adding an image to your repository can help identify your project across various social platforms. diff --git a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md index ddf52fc18cef..584181f842dd 100644 --- a/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md +++ b/content/github/administering-a-repository/defining-the-mergeability-of-pull-requests.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/deleting-a-repository.md b/content/github/administering-a-repository/deleting-a-repository.md index 87e00bcbfc63..51abc910fb93 100644 --- a/content/github/administering-a-repository/deleting-a-repository.md +++ b/content/github/administering-a-repository/deleting-a-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.organizations.owners-and-admins-can %} delete an organization repository. If **Allow members to delete or transfer repositories for this organization** has been disabled, only organization owners can delete organization repositories. {% data reusables.organizations.new-repo-permissions-more-info %} diff --git a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md index 69b1689383e3..ea22b7c9f465 100644 --- a/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md +++ b/content/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### Deleting a branch used for a pull request diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md index 4027f7cfc16e..d7afb49e3005 100644 --- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - repositories --- {% data reusables.actions.enterprise-beta %} diff --git a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md index 4edba4ddedd8..e665938671d7 100644 --- a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md @@ -6,6 +6,8 @@ redirect_from: - /articles/displaying-a-sponsor-button-in-your-repository versions: free-pro-team: '*' +topics: + - repositories --- ### About FUNDING files diff --git a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md index 04f8ec9a6109..e84fe4da5c24 100644 --- a/content/github/administering-a-repository/enabling-and-disabling-version-updates.md +++ b/content/github/administering-a-repository/enabling-and-disabling-version-updates.md @@ -4,6 +4,8 @@ intro: 'You can configure your repository so that {% data variables.product.prod permissions: 'People with write permissions to a repository can enable or disable {% data variables.product.prodname_dependabot_version_updates %} for the repository.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note-no-link %} @@ -18,9 +20,12 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c ### Enabling {% data variables.product.prodname_dependabot_version_updates %} -{% data reusables.dependabot.create-dependabot-yml %} -1. Use `package-ecosystem` to specify the package managers to monitor. +{% data reusables.dependabot.create-dependabot-yml %} For information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates)." +1. Add a `version`. +1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details. +1. Add an `updates` section, with an entry for each package manager you want {% data variables.product.prodname_dependabot %} to monitor. 1. For each package manager, use: + - `package-ecosystem` to specify the package manager. - `directory` to specify the location of the manifest or other definition files. - `schedule.interval` to specify how often to check for new versions. {% data reusables.dependabot.check-in-dependabot-yml %} diff --git a/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md b/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md index 9937e192414f..0ec0ad3282bf 100644 --- a/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md +++ b/content/github/administering-a-repository/enabling-or-disabling-github-discussions-for-a-repository.md @@ -5,6 +5,8 @@ product: '{% data reusables.gated-features.discussions %}' permissions: People with admin permissions to a repository can enable discussions for the repository. versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.discussions.beta %} diff --git a/content/github/administering-a-repository/index.md b/content/github/administering-a-repository/index.md index 5ed179703c13..6c1ae358079c 100644 --- a/content/github/administering-a-repository/index.md +++ b/content/github/administering-a-repository/index.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- @@ -64,6 +66,7 @@ versions: {% link_in_list /enabling-and-disabling-version-updates %} {% link_in_list /listing-dependencies-configured-for-version-updates %} {% link_in_list /managing-pull-requests-for-dependency-updates %} + {% link_in_list /managing-encrypted-secrets-for-dependabot %} {% link_in_list /customizing-dependency-updates %} {% link_in_list /configuration-options-for-dependency-updates %} {% link_in_list /keeping-your-actions-up-to-date-with-dependabot %} diff --git a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md index 4e6c7b54b8ef..212bf528ddf0 100644 --- a/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot.md @@ -5,6 +5,8 @@ redirect_from: - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md b/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md index 3c6c79af15ab..5b7076daa1b4 100644 --- a/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md +++ b/content/github/administering-a-repository/keeping-your-dependencies-updated-automatically.md @@ -4,5 +4,7 @@ intro: '{% data variables.product.prodname_dependabot %} can maintain your repos mapTopic: true versions: free-pro-team: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/linking-to-releases.md b/content/github/administering-a-repository/linking-to-releases.md index 8d87615b86cc..b6cb7bbcba23 100644 --- a/content/github/administering-a-repository/linking-to-releases.md +++ b/content/github/administering-a-repository/linking-to-releases.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md index 19a0c93aee15..5fb3ca1c6715 100644 --- a/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md +++ b/content/github/administering-a-repository/listing-dependencies-configured-for-version-updates.md @@ -3,6 +3,8 @@ title: Listing dependencies configured for version updates intro: 'You can view the dependencies that {% data variables.product.prodname_dependabot %} monitors for updates.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/managing-a-branch-protection-rule.md b/content/github/administering-a-repository/managing-a-branch-protection-rule.md index 06a6d484d769..38384638d713 100644 --- a/content/github/administering-a-repository/managing-a-branch-protection-rule.md +++ b/content/github/administering-a-repository/managing-a-branch-protection-rule.md @@ -21,6 +21,8 @@ versions: enterprise-server: '*' github-ae: '*' permissions: People with admin permissions to a repository can manage branch protection rules. +topics: + - repositories --- ### About branch protection rules diff --git a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md index d6c7398e9837..e4495dda3460 100644 --- a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md +++ b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md @@ -6,6 +6,8 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- {% data reusables.secret-scanning.beta %} diff --git a/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md b/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md index 8773a1704dca..0e7cb11f0f0e 100644 --- a/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md +++ b/content/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository.md @@ -1,12 +1,14 @@ --- title: Managing auto-merge for pull requests in your repository -intro: "You can allow or disallow auto-merge for pull requests in your repository." +intro: You can allow or disallow auto-merge for pull requests in your repository. product: '{% data reusables.gated-features.auto-merge %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' github-ae: '*' permissions: People with maintainer permissions can manage auto-merge for pull requests in a repository. +topics: + - repositories --- If you allow auto-merge for pull requests in your repository, people can configure individual pull requests in the repository to merge automatically when all merge requirements are met. For more information, see "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)." diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository.md b/content/github/administering-a-repository/managing-branches-in-your-repository.md index 2688f35f9e52..c59c70f2b284 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository.md +++ b/content/github/administering-a-repository/managing-branches-in-your-repository.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md b/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md new file mode 100644 index 000000000000..1362ff78668d --- /dev/null +++ b/content/github/administering-a-repository/managing-encrypted-secrets-for-dependabot.md @@ -0,0 +1,72 @@ +--- +title: Managing encrypted secrets for Dependabot +intro: You can store sensitive information, like passwords and access tokens, as encrypted secrets and then reference these in the {% data variables.product.prodname_dependabot %} configuration file. +versions: + free-pro-team: '*' +--- + +### About encrypted secrets for {% data variables.product.prodname_dependabot %} + +{% data variables.product.prodname_dependabot %} secrets are encrypted credentials that you create at either the organization level or the repository level. +When you add a secret at the organization level, you can specify which repositories can access the secret. You can use secrets to allow {% data variables.product.prodname_dependabot %} to update dependencies located in private package registries. When you add a secret it's encrypted before it reaches {% data variables.product.prodname_dotcom %} and it remains encrypted until it's used by {% data variables.product.prodname_dependabot %} to access a private package registry. + +After you add a {% data variables.product.prodname_dependabot %} secret, you can reference it in the _dependabot.yml_ configuration file like this: {% raw %}`${{secrets.NAME}}`{% endraw %}, where "NAME" is the name you chose for the secret. For example: + +{% raw %} +```yaml +password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} +``` +{% endraw %} + +For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#configuration-options-for-private-registries)." + +#### Naming your secrets + +The name of a {% data variables.product.prodname_dependabot %} secret: +* Can only contain alphanumeric characters (`[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. If you enter lowercase letters these are changed to uppercase. +* Must not start with the `GITHUB_` prefix. +* Must not start with a number. + +### Adding a repository secret for {% data variables.product.prodname_dependabot %} + +{% data reusables.github-actions.permissions-statement-secrets-repository %} + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +{% data reusables.github-actions.sidebar-secret %} +{% data reusables.dependabot.dependabot-secrets-button %} +1. Click **New repository secret**. +1. Type a name for your secret in the **Name** input box. +1. Enter the value for your secret. +1. Click **Add secret**. + + The name of the secret is listed on the Dependabot secrets page. You can click **Update** to change the secret value. You can click **Remove** to delete the secret. + + ![Update or remove a repository secret](/assets/images/help/dependabot/update-remove-repo-secret.png) + +### Adding an organization secret for {% data variables.product.prodname_dependabot %} + +When creating a secret in an organization, you can use a policy to limit which repositories can access that secret. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories. + +{% data reusables.github-actions.permissions-statement-secrets-organization %} + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.github-actions.sidebar-secret %} +{% data reusables.dependabot.dependabot-secrets-button %} +1. Click **New organization secret**. +1. Type a name for your secret in the **Name** input box. +1. Enter the **Value** for your secret. +1. From the **Repository access** dropdown list, choose an access policy. +1. If you chose **Selected repositories**: + + * Click {% octicon "gear" aria-label="The Gear icon" %}. + * Choose the repositories that can access this secret. + ![Select repositories for this secret](/assets/images/help/dependabot/secret-repository-access.png) + * Click **Update selection**. + +1. Click **Add secret**. + + The name of the secret is listed on the Dependabot secrets page. You can click **Update** to change the secret value or its access policy. You can click **Remove** to delete the secret. + + ![Update or remove an organization secret](/assets/images/help/dependabot/update-remove-repo-secret.png) diff --git a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md index a4bb51ee209c..f8f65c1c8014 100644 --- a/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>3.0' github-ae: '*' +topics: + - repositories --- ### About {% data variables.large_files.product_name_short %} objects in archives diff --git a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md index ebe089535a7f..ed3277df69d4 100644 --- a/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md +++ b/content/github/administering-a-repository/managing-pull-requests-for-dependency-updates.md @@ -3,6 +3,8 @@ title: Managing pull requests for dependency updates intro: 'You manage pull requests raised by {% data variables.product.prodname_dependabot %} in much the same way as other pull requests, but there are some extra options.' versions: free-pro-team: '*' +topics: + - repositories --- {% data reusables.dependabot.beta-note %} diff --git a/content/github/administering-a-repository/managing-releases-in-a-repository.md b/content/github/administering-a-repository/managing-releases-in-a-repository.md index fb779d9e7c55..0998c7252e32 100644 --- a/content/github/administering-a-repository/managing-releases-in-a-repository.md +++ b/content/github/administering-a-repository/managing-releases-in-a-repository.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion ver_gt "github-ae@latest" %} diff --git a/content/github/administering-a-repository/managing-repository-settings.md b/content/github/administering-a-repository/managing-repository-settings.md index fe7f46cdc3ec..d62b9d82b2e6 100644 --- a/content/github/administering-a-repository/managing-repository-settings.md +++ b/content/github/administering-a-repository/managing-repository-settings.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md index f652543a23b1..4eed68ffc836 100644 --- a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} @@ -27,7 +29,7 @@ You can manage a subset of security and analysis features for public repositorie ### Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %} -You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If your organization or enterprise has a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %}{% endif %} +You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If your organization belongs to an enterprise with a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %}{% endif %} {% data reusables.security.security-and-analysis-features-enable-read-only %} diff --git a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md index 9e38d3ccecc9..fc4dac076643 100644 --- a/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md +++ b/content/github/administering-a-repository/managing-teams-and-people-with-access-to-your-repository.md @@ -6,6 +6,8 @@ redirect_from: - /github/administering-a-repository/managing-people-and-teams-with-access-to-your-repository versions: free-pro-team: '*' +topics: + - repositories --- ### About managing access to your repository diff --git a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md index f165dc498635..ffa5b30e4a2e 100644 --- a/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md +++ b/content/github/administering-a-repository/managing-the-automatic-deletion-of-branches.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Anyone with admin permissions to a repository can enable or disable the automatic deletion of branches. diff --git a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md index 94e4afbdf937..6d6be04cd204 100644 --- a/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md +++ b/content/github/administering-a-repository/managing-the-forking-policy-for-your-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- An organization owner must allow forks of private{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} and internal{% endif %} repositories on the organization level before you can allow or disallow forks for a specific repository. For more information, see "[Managing the forking policy for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-the-forking-policy-for-your-organization)." diff --git a/content/github/administering-a-repository/releasing-projects-on-github.md b/content/github/administering-a-repository/releasing-projects-on-github.md index 372ed4cafcba..0ee087417a64 100644 --- a/content/github/administering-a-repository/releasing-projects-on-github.md +++ b/content/github/administering-a-repository/releasing-projects-on-github.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/renaming-a-branch.md b/content/github/administering-a-repository/renaming-a-branch.md index 7b23d9d5d5a4..2386a1195483 100644 --- a/content/github/administering-a-repository/renaming-a-branch.md +++ b/content/github/administering-a-repository/renaming-a-branch.md @@ -5,6 +5,8 @@ permissions: People with write permissions to a repository can rename a branch i versions: free-pro-team: '*' enterprise-server: '>=3.1' +topics: + - repositories --- ### About renaming branches diff --git a/content/github/administering-a-repository/renaming-a-repository.md b/content/github/administering-a-repository/renaming-a-repository.md index 49b2a1bb3015..57638a77a7d8 100644 --- a/content/github/administering-a-repository/renaming-a-repository.md +++ b/content/github/administering-a-repository/renaming-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including: diff --git a/content/github/administering-a-repository/restoring-a-deleted-repository.md b/content/github/administering-a-repository/restoring-a-deleted-repository.md index 7f8ac645e7a3..52e4b9e21ead 100644 --- a/content/github/administering-a-repository/restoring-a-deleted-repository.md +++ b/content/github/administering-a-repository/restoring-a-deleted-repository.md @@ -5,6 +5,8 @@ redirect_from: - /articles/restoring-a-deleted-repository versions: free-pro-team: '*' +topics: + - repositories --- Anyone can restore deleted repositories that were owned by their own user account. Organization owners can restore deleted repositories that were owned by the organization. diff --git a/content/github/administering-a-repository/securing-your-repository.md b/content/github/administering-a-repository/securing-your-repository.md index 73f4af51ea0a..357d9148e6fe 100644 --- a/content/github/administering-a-repository/securing-your-repository.md +++ b/content/github/administering-a-repository/securing-your-repository.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/administering-a-repository/setting-repository-visibility.md b/content/github/administering-a-repository/setting-repository-visibility.md index aacaffa8b605..587bf86a2936 100644 --- a/content/github/administering-a-repository/setting-repository-visibility.md +++ b/content/github/administering-a-repository/setting-repository-visibility.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository visibility changes @@ -25,7 +27,7 @@ We recommend reviewing the following caveats before you change the visibility of * If you're using {% data variables.product.prodname_free_user %} for user accounts or organizations, some features won't be available in the repository after you change the visibility to private. {% data reusables.gated-features.more-info %}{% endif %} * Any published {% data variables.product.prodname_pages %} site will be automatically unpublished.{% if currentVersion == "free-pro-team@latest" %} If you added a custom domain to the {% data variables.product.prodname_pages %} site, you should remove or update your DNS records before making the repository private, to avoid the risk of a domain takeover. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site)."{% endif %}{% if currentVersion == "free-pro-team@latest" %} * {% data variables.product.prodname_dotcom %} will no longer include the repository in the {% data variables.product.prodname_archive %}. For more information, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)."{% endif %}{% if currentVersion == "free-pro-team@latest" %} -* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that has a license for {% data variables.product.prodname_advanced_security %} with sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %} +* {% data variables.product.prodname_GH_advanced_security %} features, such as {% data variables.product.prodname_code_scanning %}, will stop working unless the repository is owned by an organization that is part of an enterprise with a license for {% data variables.product.prodname_advanced_security %} and sufficient spare seats. {% data reusables.advanced-security.more-info-ghas %}{% endif %}{% if enterpriseServerVersions contains currentVersion %} * Anonymous Git read access is no longer available. For more information, see "[Enabling anonymous Git read access for a repository](/enterprise/{{ currentVersion }}/user/articles/enabling-anonymous-git-read-access-for-a-repository)."{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} diff --git a/content/github/administering-a-repository/transferring-a-repository.md b/content/github/administering-a-repository/transferring-a-repository.md index 95343d8a7a69..94388ad8a4ac 100644 --- a/content/github/administering-a-repository/transferring-a-repository.md +++ b/content/github/administering-a-repository/transferring-a-repository.md @@ -16,6 +16,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository transfers diff --git a/content/github/administering-a-repository/troubleshooting-required-status-checks.md b/content/github/administering-a-repository/troubleshooting-required-status-checks.md index d07532b5f407..3424fb27b74d 100644 --- a/content/github/administering-a-repository/troubleshooting-required-status-checks.md +++ b/content/github/administering-a-repository/troubleshooting-required-status-checks.md @@ -1,11 +1,13 @@ --- title: Troubleshooting required status checks -intro: 'You can check for common errors and resolve issues with required status checks.' +intro: You can check for common errors and resolve issues with required status checks. product: '{% data reusables.gated-features.protected-branches %}' versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[Checks](/rest/reference/checks)." diff --git a/content/github/administering-a-repository/viewing-branches-in-your-repository.md b/content/github/administering-a-repository/viewing-branches-in-your-repository.md index ce60dccc84e6..f2c483980662 100644 --- a/content/github/administering-a-repository/viewing-branches-in-your-repository.md +++ b/content/github/administering-a-repository/viewing-branches-in-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-branches %} diff --git a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md index 9c6758f8c145..d551f5f7556e 100644 --- a/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md +++ b/content/github/administering-a-repository/viewing-deployment-activity-for-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% note %} diff --git a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md index e11d111666d8..bc64774ab135 100644 --- a/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md +++ b/content/github/administering-a-repository/viewing-your-repositorys-releases-and-tags.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.19" %} diff --git a/content/github/authenticating-to-github/about-anonymized-image-urls.md b/content/github/authenticating-to-github/about-anonymized-image-urls.md index d36acb1003a1..f1f469fcb051 100644 --- a/content/github/authenticating-to-github/about-anonymized-image-urls.md +++ b/content/github/authenticating-to-github/about-anonymized-image-urls.md @@ -6,6 +6,9 @@ redirect_from: - /articles/about-anonymized-image-urls versions: free-pro-team: '*' +topics: + - identity + - access management --- To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each image which hides your browser details and related information from other users. The URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. diff --git a/content/github/authenticating-to-github/about-authentication-to-github.md b/content/github/authenticating-to-github/about-authentication-to-github.md index c7d1f21a1a11..1f3dad6026f9 100644 --- a/content/github/authenticating-to-github/about-authentication-to-github.md +++ b/content/github/authenticating-to-github/about-authentication-to-github.md @@ -5,6 +5,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### About authentication to {% data variables.product.prodname_dotcom %} diff --git a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md index bb6b3e730460..c7f6ff6491f3 100644 --- a/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/about-authentication-with-saml-single-sign-on.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' github-ae: '*' +topics: + - sso --- ### About authentication with SAML SSO diff --git a/content/github/authenticating-to-github/about-commit-signature-verification.md b/content/github/authenticating-to-github/about-commit-signature-verification.md index 4c518894911a..77a2b528cacd 100644 --- a/content/github/authenticating-to-github/about-commit-signature-verification.md +++ b/content/github/authenticating-to-github/about-commit-signature-verification.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### About commit signature verification diff --git a/content/github/authenticating-to-github/about-githubs-ip-addresses.md b/content/github/authenticating-to-github/about-githubs-ip-addresses.md index 0ffa4bb10aaa..1718f9d21c8c 100644 --- a/content/github/authenticating-to-github/about-githubs-ip-addresses.md +++ b/content/github/authenticating-to-github/about-githubs-ip-addresses.md @@ -10,6 +10,9 @@ redirect_from: - /articles/about-githubs-ip-addresses versions: free-pro-team: '*' +topics: + - identity + - access management --- You can retrieve a list of {% data variables.product.prodname_dotcom %}'s IP addresses from the [meta](https://api.github.com/meta) API endpoint. For more information, see "[Meta](/rest/reference/meta)." diff --git a/content/github/authenticating-to-github/about-ssh.md b/content/github/authenticating-to-github/about-ssh.md index e6d03cbea3ab..2eaef9677c1f 100644 --- a/content/github/authenticating-to-github/about-ssh.md +++ b/content/github/authenticating-to-github/about-ssh.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When you set up SSH, you'll [generate an SSH key and add it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and then [add the key to your {% data variables.product.product_name %} account](/articles/adding-a-new-ssh-key-to-your-github-account). Adding the SSH key to the ssh-agent ensures that your SSH key has an extra layer of security through the use of a passphrase. For more information, see "[Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." diff --git a/content/github/authenticating-to-github/about-two-factor-authentication.md b/content/github/authenticating-to-github/about-two-factor-authentication.md index 478630fc958a..fec3b375c202 100644 --- a/content/github/authenticating-to-github/about-two-factor-authentication.md +++ b/content/github/authenticating-to-github/about-two-factor-authentication.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% if currentVersion == "free-pro-team@latest" %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your {% data variables.product.product_name %} account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone. diff --git a/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md b/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md index 4310af7d7191..0b15769178bc 100644 --- a/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md +++ b/content/github/authenticating-to-github/accessing-github-using-two-factor-authentication.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- With two-factor authentication enabled, you'll need to provide an authentication code when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/about-authentication-to-github)." diff --git a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md index e8c4ba5e23c0..6df4b4b162d3 100644 --- a/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- Before adding a new GPG key to your {% data variables.product.product_name %} account, you should have: diff --git a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md index 668b00c955f6..0638c2432fa5 100644 --- a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- Before adding a new SSH key to your {% data variables.product.product_name %} account, you should have: diff --git a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md index 79bf3d46bf35..895402d67115 100644 --- a/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md +++ b/content/github/authenticating-to-github/associating-an-email-with-your-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% note %} diff --git a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md index e1cc60930123..bd089ba9e756 100644 --- a/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authenticating-with-saml-single-sign-on.md @@ -9,5 +9,7 @@ redirect_from: versions: free-pro-team: '*' github-ae: '*' +topics: + - sso --- diff --git a/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md index 6b52b6665894..f7d73042d11c 100644 --- a/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on.md @@ -6,6 +6,8 @@ redirect_from: - /articles/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - sso --- You can authorize an existing personal access token, or [create a new personal access token](/github/authenticating-to-github/creating-a-personal-access-token) and then authorize it. diff --git a/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md b/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md index ee2b69a4b70c..dd401111ea62 100644 --- a/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md +++ b/content/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on.md @@ -6,6 +6,8 @@ redirect_from: - /articles/authorizing-an-ssh-key-for-use-with-saml-single-sign-on versions: free-pro-team: '*' +topics: + - sso --- You can authorize an existing SSH key, or create a new SSH key and then authorize it. For more information about creating a new SSH key, see "[Generating a new SSH key and adding it to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." diff --git a/content/github/authenticating-to-github/authorizing-oauth-apps.md b/content/github/authenticating-to-github/authorizing-oauth-apps.md index dca4ac4c694c..6c32b4a44466 100644 --- a/content/github/authenticating-to-github/authorizing-oauth-apps.md +++ b/content/github/authenticating-to-github/authorizing-oauth-apps.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- When an {% data variables.product.prodname_oauth_app %} wants to identify you by your {% data variables.product.product_name %} account, you'll see a page with the app's developer contact information and a list of the specific data that's being requested. diff --git a/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md b/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md index c2889d554737..b57c38d604f4 100644 --- a/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md +++ b/content/github/authenticating-to-github/changing-two-factor-authentication-delivery-methods-for-your-mobile-device.md @@ -6,6 +6,8 @@ redirect_from: - /articles/changing-two-factor-authentication-delivery-methods-for-your-mobile-device versions: free-pro-team: '*' +topics: + - 2fa --- {% note %} diff --git a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md index 1ffc22df36a8..0abd12c197ef 100644 --- a/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md +++ b/content/github/authenticating-to-github/checking-for-existing-gpg-keys.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md index 9a95a12d6b61..1131f1f04eac 100644 --- a/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md +++ b/content/github/authenticating-to-github/checking-for-existing-ssh-keys.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- {% data reusables.ssh.dsa-support %} diff --git a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md index 2e7403a50fc8..36d736bca8b4 100644 --- a/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md +++ b/content/github/authenticating-to-github/checking-your-commit-and-tag-signature-verification-status.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Checking your commit signature verification status diff --git a/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md b/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md index 937293a14352..ac377530660f 100644 --- a/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md +++ b/content/github/authenticating-to-github/configuring-two-factor-authentication-recovery-methods.md @@ -11,6 +11,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- In addition to securely storing your two-factor authentication recovery codes, we strongly recommend configuring one or more additional recovery methods. diff --git a/content/github/authenticating-to-github/configuring-two-factor-authentication.md b/content/github/authenticating-to-github/configuring-two-factor-authentication.md index bc352f983e15..3066f68814ff 100644 --- a/content/github/authenticating-to-github/configuring-two-factor-authentication.md +++ b/content/github/authenticating-to-github/configuring-two-factor-authentication.md @@ -9,6 +9,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- You can configure two-factor authentication using a mobile app{% if currentVersion == "free-pro-team@latest" %} or via text message{% endif %}. You can also add a security key. diff --git a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md index 2f82f7db52d3..09ce32816e24 100644 --- a/content/github/authenticating-to-github/connecting-to-github-with-ssh.md +++ b/content/github/authenticating-to-github/connecting-to-github-with-ssh.md @@ -15,5 +15,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- diff --git a/content/github/authenticating-to-github/connecting-with-third-party-applications.md b/content/github/authenticating-to-github/connecting-with-third-party-applications.md index a0e789b8222e..5ffb4b5bf27e 100644 --- a/content/github/authenticating-to-github/connecting-with-third-party-applications.md +++ b/content/github/authenticating-to-github/connecting-with-third-party-applications.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- When a third-party application wants to identify you by your {% data variables.product.product_name %} login, you'll see a page with the developer contact information and a list of the specific data that's being requested. diff --git a/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md b/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md index aa7dc1332f9f..95d39a899a7f 100644 --- a/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md +++ b/content/github/authenticating-to-github/countries-where-sms-authentication-is-supported.md @@ -5,6 +5,8 @@ redirect_from: - /articles/countries-where-sms-authentication-is-supported versions: free-pro-team: '*' +topics: + - 2fa --- If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see "[Configuring two-factor authentication](/articles/configuring-two-factor-authentication)." diff --git a/content/github/authenticating-to-github/creating-a-personal-access-token.md b/content/github/authenticating-to-github/creating-a-personal-access-token.md index eb78e0548668..2340dc543333 100644 --- a/content/github/authenticating-to-github/creating-a-personal-access-token.md +++ b/content/github/authenticating-to-github/creating-a-personal-access-token.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- Personal access tokens (PATs) are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [GitHub API](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens) or the [command line](#using-a-token-on-the-command-line). diff --git a/content/github/authenticating-to-github/creating-a-strong-password.md b/content/github/authenticating-to-github/creating-a-strong-password.md index 754ca8c949ba..db2e968ad7b2 100644 --- a/content/github/authenticating-to-github/creating-a-strong-password.md +++ b/content/github/authenticating-to-github/creating-a-strong-password.md @@ -7,6 +7,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- You must choose or generate a password for your {% data variables.product.product_name %} account that is at least: diff --git a/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md b/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md index a815793bf9cd..2d624157295d 100644 --- a/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md +++ b/content/github/authenticating-to-github/deleted-or-missing-ssh-keys.md @@ -5,6 +5,8 @@ redirect_from: - /articles/deleted-or-missing-ssh-keys versions: free-pro-team: '*' +topics: + - ssh --- {% data variables.product.prodname_dotcom %} automatically deletes inactive SSH keys to help keep accounts safe, such as after someone leaves a job or loses a computer. diff --git a/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md b/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md index 6364fe62383f..334725eabb31 100644 --- a/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md +++ b/content/github/authenticating-to-github/disabling-two-factor-authentication-for-your-personal-account.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- We strongly recommend using two-factor authentication to secure your account. If you need to disable 2FA, we recommend re-enabling it as soon as possible. diff --git a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md index ad63b888c36e..0a0cf75aaf62 100644 --- a/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md +++ b/content/github/authenticating-to-github/error-agent-admitted-failure-to-sign.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When trying to SSH into {% data variables.product.product_location %} on a Linux computer, you may see the following message in your terminal: diff --git a/content/github/authenticating-to-github/error-bad-file-number.md b/content/github/authenticating-to-github/error-bad-file-number.md index af70808b4358..c652063f7423 100644 --- a/content/github/authenticating-to-github/error-bad-file-number.md +++ b/content/github/authenticating-to-github/error-bad-file-number.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When running remote Git commands or SSH, your connection might time out: diff --git a/content/github/authenticating-to-github/error-key-already-in-use.md b/content/github/authenticating-to-github/error-key-already-in-use.md index 2e4c52a8bf33..91003389a05a 100644 --- a/content/github/authenticating-to-github/error-key-already-in-use.md +++ b/content/github/authenticating-to-github/error-key-already-in-use.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- ### Finding where the key has been used diff --git a/content/github/authenticating-to-github/error-permission-denied-publickey.md b/content/github/authenticating-to-github/error-permission-denied-publickey.md index 6057153d6bde..6c57fec292e5 100644 --- a/content/github/authenticating-to-github/error-permission-denied-publickey.md +++ b/content/github/authenticating-to-github/error-permission-denied-publickey.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- ### Should the `sudo` command be used with Git? diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md index f45e846a3edb..51660edaecab 100644 --- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md +++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-other-user.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository. diff --git a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md index dda09ea92a69..818e7dc7176e 100644 --- a/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md +++ b/content/github/authenticating-to-github/error-permission-to-userrepo-denied-to-userother-repo.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- To fix this, remove the deploy key from the repository, and [add the key to your user account](/articles/adding-a-new-ssh-key-to-your-github-account) instead. diff --git a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md index 3d9d3e3fad74..9699bf3bc702 100644 --- a/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md +++ b/content/github/authenticating-to-github/error-ssh-add-illegal-option----k.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- The `-K` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `-K`. diff --git a/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md b/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md index 1c844c383800..1d0e21375079 100644 --- a/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md +++ b/content/github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md @@ -5,6 +5,8 @@ redirect_from: - /articles/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok versions: free-pro-team: '*' +topics: + - ssh --- The error you receive may look like the following: diff --git a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md index 3ca153f2dfba..fadb01e5fd53 100644 --- a/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md +++ b/content/github/authenticating-to-github/error-were-doing-an-ssh-key-audit.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys. diff --git a/content/github/authenticating-to-github/generating-a-new-gpg-key.md b/content/github/authenticating-to-github/generating-a-new-gpg-key.md index b02d4f0cefdd..65069037b2e7 100644 --- a/content/github/authenticating-to-github/generating-a-new-gpg-key.md +++ b/content/github/authenticating-to-github/generating-a-new-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 020d609a12a9..93182ab5064b 100644 --- a/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- If you don't already have an SSH key, you must [generate a new SSH key](#generating-a-new-ssh-key). If you're unsure whether you already have an SSH key, check for [existing keys](/articles/checking-for-existing-ssh-keys). diff --git a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md index 309b4e69c182..6b47b5874f43 100644 --- a/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md +++ b/content/github/authenticating-to-github/githubs-ssh-key-fingerprints.md @@ -7,6 +7,9 @@ redirect_from: - /articles/githubs-ssh-key-fingerprints versions: free-pro-team: '*' +topics: + - identity + - access management --- These are {% data variables.product.prodname_dotcom %}'s public key fingerprints: diff --git a/content/github/authenticating-to-github/index.md b/content/github/authenticating-to-github/index.md index 30e51c708783..d59e1b78c4d9 100644 --- a/content/github/authenticating-to-github/index.md +++ b/content/github/authenticating-to-github/index.md @@ -17,6 +17,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - 2fa + - identity + - access management + - usernames + - device verification --- diff --git a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md index 183fecb7f34f..f2cceaccef79 100644 --- a/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md +++ b/content/github/authenticating-to-github/keeping-your-account-and-data-secure.md @@ -8,5 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/managing-commit-signature-verification.md b/content/github/authenticating-to-github/managing-commit-signature-verification.md index da61d7119659..1402793ca0f9 100644 --- a/content/github/authenticating-to-github/managing-commit-signature-verification.md +++ b/content/github/authenticating-to-github/managing-commit-signature-verification.md @@ -10,5 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/preventing-unauthorized-access.md b/content/github/authenticating-to-github/preventing-unauthorized-access.md index 79c9518fac9f..80cf7fc05628 100644 --- a/content/github/authenticating-to-github/preventing-unauthorized-access.md +++ b/content/github/authenticating-to-github/preventing-unauthorized-access.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- {% data variables.product.product_name %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members. diff --git a/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md index e3259b0eff4c..f6fad1ddb207 100644 --- a/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/github/authenticating-to-github/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -8,6 +8,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md index fc251cc1e1b6..e5bc1c00c689 100644 --- a/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md +++ b/content/github/authenticating-to-github/recovering-your-ssh-key-passphrase.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- {% mac %} diff --git a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md index 55bd3a3601ca..95e6b04666d4 100644 --- a/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md +++ b/content/github/authenticating-to-github/removing-sensitive-data-from-a-repository.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- The `git filter-branch` command and the BFG Repo-Cleaner rewrite your repository's history, which changes the SHAs for existing commits that you alter and any dependent commits. Changed commit SHAs may affect open pull requests in your repository. We recommend merging or closing all open pull requests before removing files from your repository. diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md index ce1fd85a5736..81cd79e7ff3d 100644 --- a/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md +++ b/content/github/authenticating-to-github/reviewing-your-authorized-applications-oauth.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md index 6bbe5801e191..6423bac6f8ab 100644 --- a/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md +++ b/content/github/authenticating-to-github/reviewing-your-authorized-integrations.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Reviewing your authorized {% data variables.product.prodname_oauth_app %}s diff --git a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md index 85eba969b973..f6b160dfd099 100644 --- a/content/github/authenticating-to-github/reviewing-your-deploy-keys.md +++ b/content/github/authenticating-to-github/reviewing-your-deploy-keys.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 01aa0036e47e..466c990e1c88 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- ### Accessing your security log diff --git a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md index ba3e70593d86..2aec1117d359 100644 --- a/content/github/authenticating-to-github/reviewing-your-ssh-keys.md +++ b/content/github/authenticating-to-github/reviewing-your-ssh-keys.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid. diff --git a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md index 597dc2ed9677..5dc2e4fc18f6 100644 --- a/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md +++ b/content/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa.md @@ -9,5 +9,7 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '*' +topics: + - 2fa --- diff --git a/content/github/authenticating-to-github/signing-commits.md b/content/github/authenticating-to-github/signing-commits.md index fe4fefa5cb8a..247301e527b5 100644 --- a/content/github/authenticating-to-github/signing-commits.md +++ b/content/github/authenticating-to-github/signing-commits.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/github/authenticating-to-github/signing-tags.md b/content/github/authenticating-to-github/signing-tags.md index 79240214457f..08026ad479d3 100644 --- a/content/github/authenticating-to-github/signing-tags.md +++ b/content/github/authenticating-to-github/signing-tags.md @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/github/authenticating-to-github/sudo-mode.md b/content/github/authenticating-to-github/sudo-mode.md index 065f2c0582ba..a20303dd82d3 100644 --- a/content/github/authenticating-to-github/sudo-mode.md +++ b/content/github/authenticating-to-github/sudo-mode.md @@ -6,6 +6,9 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - identity + - access management --- After you've performed a sudo-protected action, you'll only be asked to re-authenticate again after a few hours of inactivity. Every sudo-protected action resets this timer. diff --git a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md index 70780cac456c..5fab6b7ab93c 100644 --- a/content/github/authenticating-to-github/telling-git-about-your-signing-key.md +++ b/content/github/authenticating-to-github/telling-git-about-your-signing-key.md @@ -1,6 +1,6 @@ --- title: Telling Git about your signing key -intro: "To sign commits locally, you need to inform Git that there's a GPG or X.509 key you'd like to use." +intro: 'To sign commits locally, you need to inform Git that there''s a GPG or X.509 key you''d like to use.' redirect_from: - /articles/telling-git-about-your-gpg-key/ - /articles/telling-git-about-your-signing-key @@ -8,6 +8,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% mac %} diff --git a/content/github/authenticating-to-github/testing-your-ssh-connection.md b/content/github/authenticating-to-github/testing-your-ssh-connection.md index 14137184345d..167a477bb5ba 100644 --- a/content/github/authenticating-to-github/testing-your-ssh-connection.md +++ b/content/github/authenticating-to-github/testing-your-ssh-connection.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- Before testing your SSH connection, you should have: diff --git a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md index eaf728188e2b..ae4ef0099ed5 100644 --- a/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md +++ b/content/github/authenticating-to-github/troubleshooting-commit-signature-verification.md @@ -9,5 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- diff --git a/content/github/authenticating-to-github/troubleshooting-ssh.md b/content/github/authenticating-to-github/troubleshooting-ssh.md index 6e0edc68220e..a7d35a006ebb 100644 --- a/content/github/authenticating-to-github/troubleshooting-ssh.md +++ b/content/github/authenticating-to-github/troubleshooting-ssh.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- diff --git a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md index 15a8a860a3c4..0d76efd0fca6 100644 --- a/content/github/authenticating-to-github/updating-an-expired-gpg-key.md +++ b/content/github/authenticating-to-github/updating-an-expired-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- If your key is expired, you must [update the expiration](https://www.gnupg.org/gph/en/manual/c235.html#AEN328), export the new key, delete the expired key in your GitHub account, and [upload the new key to GitHub](/articles/adding-a-new-gpg-key-to-your-github-account/). Your previous commits and tags will show as verified, as long as the key meets all other verification requirements. diff --git a/content/github/authenticating-to-github/updating-your-github-access-credentials.md b/content/github/authenticating-to-github/updating-your-github-access-credentials.md index 75214d3ae805..121deadaebc3 100644 --- a/content/github/authenticating-to-github/updating-your-github-access-credentials.md +++ b/content/github/authenticating-to-github/updating-your-github-access-credentials.md @@ -9,6 +9,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% if currentVersion != "github-ae@latest" %} diff --git a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md index e215b0d4b566..f072a89dab7c 100644 --- a/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md +++ b/content/github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key.md @@ -7,6 +7,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - identity + - access management --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md index ba712f9d7389..05f7043e7878 100644 --- a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md +++ b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md @@ -5,6 +5,8 @@ redirect_from: - /articles/using-ssh-over-the-https-port versions: free-pro-team: '*' +topics: + - ssh --- {% tip %} diff --git a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md index 4b3d9b9288ef..ce7b47ed3bca 100644 --- a/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md +++ b/content/github/authenticating-to-github/viewing-and-managing-your-active-saml-sessions.md @@ -5,6 +5,8 @@ redirect_from: - /articles/viewing-and-managing-your-active-saml-sessions versions: free-pro-team: '*' +topics: + - sso --- {% data reusables.user_settings.access_settings %} @@ -24,4 +26,4 @@ versions: ### Further reading -- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" \ No newline at end of file +- "[About authentication with SAML SSO](/github/authenticating-to-github/about-authentication-with-saml-single-sign-on)" diff --git a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md index 81917a1cc175..859778b9ebb7 100644 --- a/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md +++ b/content/github/authenticating-to-github/working-with-ssh-key-passphrases.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - ssh --- With SSH keys, if someone gains access to your computer, they also gain access to every system that uses that key. To add an extra layer of security, you can add a passphrase to your SSH key. You can use `ssh-agent` to securely save your passphrase so you don't have to reenter it. diff --git a/content/github/building-a-strong-community/about-community-management-and-moderation.md b/content/github/building-a-strong-community/about-community-management-and-moderation.md index 1e693282d9ad..f4a26afaa93f 100644 --- a/content/github/building-a-strong-community/about-community-management-and-moderation.md +++ b/content/github/building-a-strong-community/about-community-management-and-moderation.md @@ -3,6 +3,8 @@ title: About community management and moderation intro: '{% data variables.product.prodname_dotcom %} offers tools that help repository maintainers establish and enforce standards of behavior in their communities on {% data variables.product.prodname_dotcom_the_website %}.' versions: free-pro-team: '*' +topics: + - community --- ### About community management and moderation diff --git a/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md b/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md index 5e1f3a28efdb..5876ae99d693 100644 --- a/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md +++ b/content/github/building-a-strong-community/about-community-profiles-for-public-repositories.md @@ -6,6 +6,8 @@ redirect_from: - /articles/about-community-profiles-for-public-repositories versions: free-pro-team: '*' +topics: + - community --- The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "[Accessing a project's community profile](/articles/accessing-a-project-s-community-profile)." diff --git a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md index 8d8c0a7b0e5b..7f3ecabf3e67 100644 --- a/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md +++ b/content/github/building-a-strong-community/about-issue-and-pull-request-templates.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- After you create issue and pull request templates in your repository, contributors can use the templates to open issues or describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information about adding contributing guidelines to a repository, see "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)." diff --git a/content/github/building-a-strong-community/about-wikis.md b/content/github/building-a-strong-community/about-wikis.md index 6e0beec462d1..39ebce9237a2 100644 --- a/content/github/building-a-strong-community/about-wikis.md +++ b/content/github/building-a-strong-community/about-wikis.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- Every {% data variables.product.product_name %} repository comes equipped with a section for hosting documentation, called a wiki. You can use your repository's wiki to share long-form content about your project, such as how to use it, how you designed it, or its core principles. A README file quickly tells what your project can do, while you can use a wiki to provide additional documentation. For more information, see "[About READMEs](/articles/about-readmes)." diff --git a/content/github/building-a-strong-community/accessing-a-projects-community-profile.md b/content/github/building-a-strong-community/accessing-a-projects-community-profile.md index d145d7dd8311..2b20b15381a5 100644 --- a/content/github/building-a-strong-community/accessing-a-projects-community-profile.md +++ b/content/github/building-a-strong-community/accessing-a-projects-community-profile.md @@ -6,6 +6,8 @@ redirect_from: - /articles/accessing-a-projects-community-profile versions: free-pro-team: '*' +topics: + - community --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md index aa7d99e071b6..c83fcd680496 100644 --- a/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md +++ b/content/github/building-a-strong-community/adding-a-code-of-conduct-to-your-project.md @@ -5,6 +5,8 @@ redirect_from: - /articles/adding-a-code-of-conduct-to-your-project versions: free-pro-team: '*' +topics: + - community --- A *code of conduct* defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for how to engage in a community, see the [Open Source Guide](https://opensource.guide/code-of-conduct/). diff --git a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md index 05d1c8941362..b69cd607cd25 100644 --- a/content/github/building-a-strong-community/adding-a-license-to-a-repository.md +++ b/content/github/building-a-strong-community/adding-a-license-to-a-repository.md @@ -6,6 +6,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - community --- If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name. diff --git a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md index 62ae60514647..738e36f1ac99 100644 --- a/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md +++ b/content/github/building-a-strong-community/adding-or-editing-wiki-pages.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Adding wiki pages diff --git a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md index 7fb6d5701374..c16e886001ed 100644 --- a/content/github/building-a-strong-community/adding-support-resources-to-your-project.md +++ b/content/github/building-a-strong-community/adding-support-resources-to-your-project.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- To direct people to specific support resources, you can add a SUPPORT file to your repository's root, `docs`, or `.github` folder. When someone creates an issue in your repository, they will see a link to your project's SUPPORT file. diff --git a/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md b/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md index 855f81f77799..7a4a51f99923 100644 --- a/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md +++ b/content/github/building-a-strong-community/blocking-a-user-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/blocking-a-user-from-your-organization versions: free-pro-team: '*' +topics: + - community --- You can block a user from within your organization's settings or from a specific comment made by the user. When you block a user in a comment, you can choose to send the user a notification explaining that they were blocked and why. Otherwise, the user is not directly notified that you've blocked them. Blocked users can still delete their existing content. diff --git a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md index 77ef77338a93..c2dc55ccef5f 100644 --- a/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md +++ b/content/github/building-a-strong-community/blocking-a-user-from-your-personal-account.md @@ -5,6 +5,8 @@ redirect_from: - /articles/blocking-a-user-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- ### About blocking users diff --git a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md index 3cd1846dba09..f8cc461171e9 100644 --- a/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md +++ b/content/github/building-a-strong-community/changing-access-permissions-for-wikis.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.repositories.navigate-to-repo %} diff --git a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md index 13df72ab2737..d8686332e6b7 100644 --- a/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md +++ b/content/github/building-a-strong-community/configuring-issue-templates-for-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} diff --git a/content/github/building-a-strong-community/creating-a-default-community-health-file.md b/content/github/building-a-strong-community/creating-a-default-community-health-file.md index c4157ac34c3f..373b288d0e45 100644 --- a/content/github/building-a-strong-community/creating-a-default-community-health-file.md +++ b/content/github/building-a-strong-community/creating-a-default-community-health-file.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - community --- ### About default community health files diff --git a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md index 5e725a84aa9e..81a9895472f8 100644 --- a/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md +++ b/content/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Creating a footer diff --git a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md index 29ff88826283..a0098f30585f 100644 --- a/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md +++ b/content/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." diff --git a/content/github/building-a-strong-community/disabling-wikis.md b/content/github/building-a-strong-community/disabling-wikis.md index 1dc9587157ea..400b502f0e00 100644 --- a/content/github/building-a-strong-community/disabling-wikis.md +++ b/content/github/building-a-strong-community/disabling-wikis.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- When you turn off a wiki, the content is hidden, but not erased. If you choose to re-enable wikis later, your previous pages will be restored. diff --git a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md index db5793db24a8..b65315103845 100644 --- a/content/github/building-a-strong-community/documenting-your-project-with-wikis.md +++ b/content/github/building-a-strong-community/documenting-your-project-with-wikis.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/editing-wiki-content.md b/content/github/building-a-strong-community/editing-wiki-content.md index d592597dd6bf..57e1e83f5e01 100644 --- a/content/github/building-a-strong-community/editing-wiki-content.md +++ b/content/github/building-a-strong-community/editing-wiki-content.md @@ -15,6 +15,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Adding links diff --git a/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md b/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md index 95c92f2edeaa..54e3f5c09ac4 100644 --- a/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md +++ b/content/github/building-a-strong-community/encouraging-helpful-contributions-to-your-project-with-labels.md @@ -6,6 +6,8 @@ redirect_from: - /articles/helping-new-contributors-find-your-project-with-labels versions: free-pro-team: '*' +topics: + - community --- You can apply the `good first issue` label to issues in your public repository so that people can find them when searching by labels. For more information about searching by labels, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests/#search-by-label)." diff --git a/content/github/building-a-strong-community/index.md b/content/github/building-a-strong-community/index.md index 70d3a13506b8..96db2f19240a 100644 --- a/content/github/building-a-strong-community/index.md +++ b/content/github/building-a-strong-community/index.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- @@ -52,8 +54,3 @@ versions: {% link_in_list /viewing-a-wikis-history-of-changes %} {% link_in_list /changing-access-permissions-for-wikis %} {% link_in_list /disabling-wikis %} -{% topic_link_in_list /collaborating-with-your-team %} - {% link_in_list /about-team-discussions %} - {% link_in_list /creating-a-team-discussion %} - {% link_in_list /editing-or-deleting-a-team-discussion %} - {% link_in_list /pinning-a-team-discussion %} diff --git a/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md index 6c01ed2e084a..b04377b01c3b 100644 --- a/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md +++ b/content/github/building-a-strong-community/limiting-interactions-for-your-user-account.md @@ -1,9 +1,11 @@ --- title: Limiting interactions for your user account -intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account.' +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account. versions: free-pro-team: '*' permissions: Anyone can limit interactions for their own user account. +topics: + - community --- ### About temporary interaction limits @@ -24,4 +26,4 @@ You can also block users. For more information, see "[Blocking a user from your 1. In your user settings sidebar, under "Moderation settings", click **Interaction limits**. !["Interaction limits" tab in the user settings sidebar](/assets/images/help/settings/settings-sidebar-interaction-limits.png) {% data reusables.community.set-interaction-limit %} - ![Temporary interaction limit options](/assets/images/help/settings/user-account-temporary-interaction-limits-options.png) \ No newline at end of file + ![Temporary interaction limit options](/assets/images/help/settings/user-account-temporary-interaction-limits-options.png) diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md index 8c96c2630243..d43d4be7307b 100644 --- a/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md +++ b/content/github/building-a-strong-community/limiting-interactions-in-your-organization.md @@ -1,12 +1,14 @@ --- title: Limiting interactions in your organization -intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization.' +intro: You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization. redirect_from: - /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization - /articles/limiting-interactions-in-your-organization versions: free-pro-team: '*' permissions: Organization owners can limit interactions in an organization. +topics: + - community --- ### About temporary interaction limits diff --git a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md index da85594b43ba..3b7219a4c1bd 100644 --- a/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md +++ b/content/github/building-a-strong-community/limiting-interactions-in-your-repository.md @@ -1,12 +1,14 @@ --- title: Limiting interactions in your repository -intro: 'You can temporarily enforce a period of limited activity for certain users on a public repository.' +intro: You can temporarily enforce a period of limited activity for certain users on a public repository. redirect_from: - /articles/limiting-interactions-with-your-repository/ - /articles/limiting-interactions-in-your-repository versions: free-pro-team: '*' permissions: People with admin permissions to a repository can temporarily limit interactions in that repository. +topics: + - community --- ### About temporary interaction limits diff --git a/content/github/building-a-strong-community/locking-conversations.md b/content/github/building-a-strong-community/locking-conversations.md index 7f384471b5fa..2035ce49d211 100644 --- a/content/github/building-a-strong-community/locking-conversations.md +++ b/content/github/building-a-strong-community/locking-conversations.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- It's appropriate to lock a conversation when the entire conversation is not constructive or violates your community's code of conduct{% if currentVersion == "free-pro-team@latest" %} or GitHub's [Community Guidelines](/articles/github.amrom.workers.devmunity-guidelines){% endif %}. When you lock a conversation, you can also specify a reason, which is publicly visible. diff --git a/content/github/building-a-strong-community/maintaining-your-safety-on-github.md b/content/github/building-a-strong-community/maintaining-your-safety-on-github.md index 5ace72549291..72e9dbb00a91 100644 --- a/content/github/building-a-strong-community/maintaining-your-safety-on-github.md +++ b/content/github/building-a-strong-community/maintaining-your-safety-on-github.md @@ -9,5 +9,7 @@ redirect_from: - /articles/encouraging-positive-contributions-to-your-project versions: free-pro-team: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/managing-disruptive-comments.md b/content/github/building-a-strong-community/managing-disruptive-comments.md index 16acb1360ccb..9b41dd1009a7 100644 --- a/content/github/building-a-strong-community/managing-disruptive-comments.md +++ b/content/github/building-a-strong-community/managing-disruptive-comments.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Hiding a comment diff --git a/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md b/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md index de50df47daa0..2bbba1c9fe58 100644 --- a/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md +++ b/content/github/building-a-strong-community/managing-how-contributors-report-abuse-in-your-organizations-repository.md @@ -3,6 +3,8 @@ title: Managing how contributors report abuse in your organization's repository intro: You can allow contributors to report disruptive behavior directly to repository maintainers. versions: free-pro-team: '*' +topics: + - community --- Anyone with admin permissions to a repository can manage how contributors report abuse in the repository. diff --git a/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md b/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md index 4dc421624336..790af089e248 100644 --- a/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md +++ b/content/github/building-a-strong-community/managing-reported-content-in-your-organizations-repository.md @@ -3,6 +3,8 @@ title: Managing reported content in your organization's repository intro: 'After a contributor reports disruptive content in a repository, repository maintainers can view and manage the report.' versions: free-pro-team: '*' +topics: + - community --- Anyone with admin permissions to a repository can view and manage reported content for the repository. diff --git a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md index 8cb5adf5ce55..3a22ec0bd17b 100644 --- a/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md +++ b/content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- {% data reusables.repositories.legacy-issue-template-tip %} diff --git a/content/github/building-a-strong-community/moderating-comments-and-conversations.md b/content/github/building-a-strong-community/moderating-comments-and-conversations.md index 6b02dc83f3b8..68955777c35f 100644 --- a/content/github/building-a-strong-community/moderating-comments-and-conversations.md +++ b/content/github/building-a-strong-community/moderating-comments-and-conversations.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/reporting-abuse-or-spam.md b/content/github/building-a-strong-community/reporting-abuse-or-spam.md index e33cd7be4c1b..55703398796c 100644 --- a/content/github/building-a-strong-community/reporting-abuse-or-spam.md +++ b/content/github/building-a-strong-community/reporting-abuse-or-spam.md @@ -5,6 +5,8 @@ redirect_from: - /articles/reporting-abuse-or-spam versions: free-pro-team: '*' +topics: + - community --- Owners, collaborators, prior contributors, and people with write access can report issues, pull requests, and comments on issues, pull requests, and commits. Anyone can report apps in {% data variables.product.prodname_marketplace %}. diff --git a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md index aca5e9c2ff24..c529f52f845a 100644 --- a/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md +++ b/content/github/building-a-strong-community/setting-guidelines-for-repository-contributors.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. diff --git a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md index 4779c2e8c9f6..bab3c8d57f48 100644 --- a/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md +++ b/content/github/building-a-strong-community/setting-up-your-project-for-healthy-contributions.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md index 0af05d43554d..9ddaa0094d72 100644 --- a/content/github/building-a-strong-community/tracking-changes-in-a-comment.md +++ b/content/github/building-a-strong-community/tracking-changes-in-a-comment.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Viewing a comment's edit history details diff --git a/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md b/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md index 616b7024246b..f0b25a83de8b 100644 --- a/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md +++ b/content/github/building-a-strong-community/unblocking-a-user-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/unblocking-a-user-from-your-organization versions: free-pro-team: '*' +topics: + - community --- After unblocking a user from your organization, they'll be able to contribute to your organization's repositories. diff --git a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md index f62dd1c2acbb..49e348174936 100644 --- a/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md +++ b/content/github/building-a-strong-community/unblocking-a-user-from-your-personal-account.md @@ -5,6 +5,8 @@ redirect_from: - /articles/unblocking-a-user-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- When you unblock a user, they'll be able to invite you to be a collaborator to their repositories. If they [@mention you](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) anywhere on GitHub, you'll receive notifications. diff --git a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md index 3435c8fa32ac..65848c631a4e 100644 --- a/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md +++ b/content/github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- diff --git a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md index caaad4013d08..8af76dfd85ac 100644 --- a/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md +++ b/content/github/building-a-strong-community/viewing-a-wikis-history-of-changes.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - community --- ### Viewing wiki history diff --git a/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md b/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md index 047ea789cc3f..27efafed8f6a 100644 --- a/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md +++ b/content/github/building-a-strong-community/viewing-users-who-are-blocked-from-your-organization.md @@ -5,6 +5,8 @@ redirect_from: - /articles/viewing-users-who-are-blocked-from-your-organization versions: free-pro-team: '*' +topics: + - community --- {% data reusables.profile.access_profile %} diff --git a/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md b/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md index 0f3bae172f3b..a5866bc295ae 100644 --- a/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md +++ b/content/github/building-a-strong-community/viewing-users-youve-blocked-from-your-personal-account.md @@ -6,6 +6,8 @@ redirect_from: - /articles/viewing-users-youve-blocked-from-your-personal-account versions: free-pro-team: '*' +topics: + - community --- {% data reusables.user_settings.access_settings %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md index 14595a111af2..016cc6cc7ace 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-branches.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-branches.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md index 732530448233..f9cec4d87c58 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-collaborative-development-models.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- There are two main types of development models with which you'd use pull requests. In the *fork and pull model*, anyone can fork an existing repository and push changes to their personal fork. You do not need permission to the source repository to push to a user-owned fork. The changes can be pulled into the source repository by the project maintainer. When you open a pull request proposing changes from your user-owned fork to a branch in the source (upstream) repository, you can allow anyone with push access to the upstream repository to make changes to your pull request. This model is popular with open source projects as it reduces the amount of friction for new contributors and allows people to work independently without upfront coordination. diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md index 7e07ded2be3b..10c3ea747512 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-comparing-branches-in-pull-requests.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md index 8e21b6d214cf..c88963f9b016 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Discussions on {% data variables.product.product_name %} @@ -16,7 +18,7 @@ You can create and participate in issues, pull requests, and team discussions, d Issues are useful for discussing specific details of a project such as bug reports and planned improvements. For more information, see "[About issues](/articles/about-issues)." Pull requests allow you to comment directly on proposed changes. For more information, see "[About pull requests](/articles/about-pull-requests)" and "[Commenting on a pull request](/articles/commenting-on-a-pull-request)." -{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/articles/about-team-discussions)." +{% data reusables.organizations.team-discussions-purpose %} For more information, see "[About team discussions](/github/setting-up-and-managing-organizations-and-teams/about-team-discussions)." ### Reacting to ideas in comments diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md index c7acbb201e03..a98a7988d345 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-forks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-forks.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Forking a repository is similar to copying a repository, with two major differences: diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md index 8e10ed8b964c..620828529ab0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-merge-conflicts.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Git can often resolve differences between branches and merge them automatically. Usually, the changes are on different lines, or even in different files, which makes the merge simple for computers to understand. However, sometimes there are competing changes that Git can't resolve without your help. Often, merge conflicts happen when people make different changes to the same line of the same file, or when one person edits a file and another person deletes the same file. diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md index 140097bc99b6..7c0a21518074 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-merges.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.pull_requests.default_merge_option %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md index cd9d14482481..93a6a0374d24 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request reviews diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md index ffba2f58cfda..e157d032a519 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull requests diff --git a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md index 4723d04971af..cf4fb304a9ec 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/about-status-checks.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request. diff --git a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md index 496b92edd073..bc9829b98f01 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md +++ b/content/github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md index e84de9cf65e9..45d42c07a0eb 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Only pull request authors can give upstream repository maintainers, or those with push access to the upstream repository, permission to make commits to their pull request's compare branch in a user-owned fork. To learn more about upstream repositories, see "[About forks](/articles/about-forks)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md index a6854818c402..04caa5fe3649 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md +++ b/content/github/collaborating-with-issues-and-pull-requests/approving-a-pull-request-with-required-reviews.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- For more information about required reviews, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md index 3cfba312473c..12d2eb2b926e 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request.md @@ -1,11 +1,13 @@ --- title: Automatically merging a pull request -intro: 'You can increase development velocity by enabling auto-merge for a pull request so that the pull request will merge automatically when all merge requirements are met.' +intro: You can increase development velocity by enabling auto-merge for a pull request so that the pull request will merge automatically when all merge requirements are met. product: '{% data reusables.gated-features.auto-merge %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' github-ae: '*' +topics: + - pull requests --- ### About auto-merge diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md index 2e5cf86f52c8..dc5773a4dd92 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-base-branch-of-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% warning %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md index c8c46903c489..5684ef55c057 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Marking a pull request as ready for review diff --git a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md index 4ed1a97a601a..edb7dbdb90a2 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md +++ b/content/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md index a6acb76c97dd..cfb5b3c97248 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/closing-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% tip %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md index e185d0a0cf41..1d4bdbd22315 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md +++ b/content/github/collaborating-with-issues-and-pull-requests/collaborating-on-repositories-with-code-quality-features.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md index 2f109a79d619..d40da420da68 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request comments diff --git a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 0f38fb1a00cf..fe0ffb4d7a43 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can only make commits on pull request branches that: diff --git a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md index 357da89aedba..8808971cdc1e 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.command_line.open_the_multi_os_terminal %} 2. List the current configured remote repository for your fork. diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md index 0aebcf7f57e3..a6de47b3487d 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can also give the upstream repository's maintainers permission to push commits to a user-owned fork. If your pull request compares your topic branch with a branch in the upstream repository as the base branch, then your topic branch is also called the compare branch of the pull request. For more information about pull request branches, including examples, see "[Creating a pull request](/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md index 501339a84f64..15326fe298e0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Anyone with read permissions to a repository can create a pull request, but you must have write permissions to create a branch. If you want to create a new branch for your pull request and don't have write permissions to the repository, you can fork the repository first. For more information, see "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)" and "[About forks](/articles/about-forks)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md index 4f0c487c12a8..c7618f35075b 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md +++ b/content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Creating a branch diff --git a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md index 0f52e396f71b..9a7a0aacc579 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/dismissing-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.pull_requests.dismiss_review %} @@ -26,4 +28,4 @@ This changes the status of the review to a review comment. When you dismiss a re - "[About pull request reviews](/articles/about-pull-request-reviews)" - "[Reviewing proposed changes in a pull request](/articles/reviewing-proposed-changes-in-a-pull-request)" -- "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)" \ No newline at end of file +- "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)" diff --git a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md index 8abfc72cb184..0f50ae18a7db 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can filter files in a pull request by file extension type, such as `.html` or `.js`, lack of an extension, code ownership, or dotfiles. diff --git a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md index 5b1ea925dc15..4fe786ab065b 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Anyone with read access to a repository can see a summary list of the functions and methods changes in certain files of a pull request. diff --git a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md index b94297ab4418..9aceb77d6c04 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/github-flow.md +++ b/content/github/collaborating-with-issues-and-pull-requests/github-flow.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Following the GitHub flow diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md index 0caba244c67b..d6d564c40990 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-changes-from-a-pull-request.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md index 68bcb96e4a6a..b8db6db125ae 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### Applying suggested changes diff --git a/content/github/collaborating-with-issues-and-pull-requests/index.md b/content/github/collaborating-with-issues-and-pull-requests/index.md index 1e666ca019af..51e6d1548537 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/index.md +++ b/content/github/collaborating-with-issues-and-pull-requests/index.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md index 876784f7cffb..ffac83495b20 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/merging-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About pull request merges diff --git a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md index 4463aa1477b9..d74e66d01cf0 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.command_line.open_the_multi_os_terminal %} 2. Change the current working directory to your local project. diff --git a/content/github/collaborating-with-issues-and-pull-requests/overview.md b/content/github/collaborating-with-issues-and-pull-requests/overview.md index 816072556fd1..be470cec0bc8 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/overview.md +++ b/content/github/collaborating-with-issues-and-pull-requests/overview.md @@ -6,5 +6,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md index 913990858c73..efe90d1598ce 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md index 65ebb3844c73..72ba7b1693e7 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/requesting-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Owners and collaborators on a repository owned by a user account can assign pull request reviews. Organization members with triage permissions to a repository can assign a pull request review. diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md index ec47c6933b68..a423d69817d8 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md +++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- You can only resolve merge conflicts on {% data variables.product.product_name %} that are caused by competing line changes, such as when people make different changes to the same line of the same file on different branches in your Git repository. For all other types of merge conflicts, you must resolve the conflict locally on the command line. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md index 5dae3a154053..f97a0aa9fbcd 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." diff --git a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md index dd7b4b5df1be..2eeeb21d67f9 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reverting-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About reverting a pull request diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md index 83cbe9154986..f0b03a1aae2b 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests.md @@ -9,5 +9,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md index 2f68164e6220..f925a1ee2368 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request.md @@ -3,6 +3,8 @@ title: Reviewing dependency changes in a pull request intro: 'If a pull request contains changes to dependencies, you can view a summary of what has changed and whether there are known vulnerabilities in any of the dependencies.' versions: free-pro-team: '*' +topics: + - pull requests --- {% note %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md index efecceace8f5..0abbfff56244 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md +++ b/content/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- ### About reviewing pull requests diff --git a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md index affc3dd844ad..941f9b9da1e5 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md +++ b/content/github/collaborating-with-issues-and-pull-requests/syncing-a-fork.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- Before you can sync your fork with an upstream repository, you must [configure a remote that points to the upstream repository](/articles/configuring-a-remote-for-a-fork) in Git. diff --git a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md index 6beac4889529..7eab837b12df 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md +++ b/content/github/collaborating-with-issues-and-pull-requests/viewing-a-pull-request-review.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.search.requested_reviews_search %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md index 28d3dee2e53a..563ad76cfb0a 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md +++ b/content/github/collaborating-with-issues-and-pull-requests/what-happens-to-forks-when-a-repository-is-deleted-or-changes-visibility.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- {% data reusables.repositories.deleted_forks_from_private_repositories_warning %} diff --git a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md index fef659dd91ef..0fca472b8f20 100644 --- a/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md +++ b/content/github/collaborating-with-issues-and-pull-requests/working-with-forks.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests --- diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md index 3b9fb08f27e5..2df075cbef4e 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github.md @@ -5,6 +5,8 @@ redirect_from: - /articles/about-archiving-content-and-data-on-github versions: free-pro-team: '*' +topics: + - repositories --- ### Persistence of public repositories diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md index 51d0fc1e328c..829e7fffa77c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md index c9da88109fba..c65f2577a1e9 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-code-owners.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- People with admin or owner permissions can set up a CODEOWNERS file in a repository. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md index 2e65dc8587e6..c11e0278a740 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About READMEs diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md index 214d30606e25..87e8cbf1fd2e 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- You can own repositories individually, or you can share ownership of repositories with other people in an organization. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md index 94d1f82eb31b..2fde93a169bc 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-languages.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github/linguist) to determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch. diff --git a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md index 9e2fc6a4ec4f..722ababce542 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-repository-visibility.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository visibility diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md index bb9d9e01a712..39ef8ed46ef1 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/archiving-a-github-repository.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md index 8a8f7b9bdf35..e7d866a63bb2 100644 --- a/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/archiving-repositories.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% data reusables.repositories.archiving-repositories-recommendation %} diff --git a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md index ac898cfee55b..8fd1c33c3f8d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md index 8272d98dcb29..e8b70b558fdc 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md index 0dc66db59f6f..8014777ecb18 100644 --- a/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/cloning-a-repository.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About cloning a repository diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md index fbd4af8d7b03..bdf453d8424a 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-new-repository.md @@ -13,6 +13,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% tip %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md index c8174a611ee4..a5cb8960238d 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### About repository templates diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md index ca3e328a934b..ab4eaeb9cd54 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md index 39778d159c4d..786ce1022cc4 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-a-template-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- {% note %} diff --git a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md index 29b1a39280de..c02192cb3804 100644 --- a/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/creating-an-issues-only-repository.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- 1. Create a **private** repository to host the source code from your project. diff --git a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md index bff96eedc7c9..69243b563ca2 100644 --- a/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/duplicating-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Before you can duplicate a repository and push to your new copy, or _mirror_, of the repository, you must [create the new repository](/articles/creating-a-new-repository) on {% data variables.product.product_location %}. In these examples, `exampleuser/new-repository` or `exampleuser/mirrored` are the mirrors. diff --git a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md index f1854f8be8ff..1f7017a371bd 100644 --- a/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md +++ b/content/github/creating-cloning-and-archiving-repositories/error-remote-head-refers-to-nonexistent-ref-unable-to-checkout.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Detecting this error is simple; Git will warn you when you try to clone the repository: diff --git a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md index 55b0e571ce69..b5a1a1591ddf 100644 --- a/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md +++ b/content/github/creating-cloning-and-archiving-repositories/error-repository-not-found.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- ### Check your spelling diff --git a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md index 5910f71320e3..8c1b1a9b6abb 100644 --- a/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md +++ b/content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Here's an example of an HTTPS error you might receive: diff --git a/content/github/creating-cloning-and-archiving-repositories/index.md b/content/github/creating-cloning-and-archiving-repositories/index.md index d590e22a927c..c5b3fb896fba 100644 --- a/content/github/creating-cloning-and-archiving-repositories/index.md +++ b/content/github/creating-cloning-and-archiving-repositories/index.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- diff --git a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md index 0110416cc7c3..aaf80f4d9a78 100644 --- a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md @@ -7,6 +7,8 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '*' +topics: + - repositories --- ### Choosing the right license diff --git a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md index 0a5310093a9e..1ebf7e51a805 100644 --- a/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/limits-for-viewing-content-and-diffs-in-a-repository.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - repositories --- Most of the limits below affect both {% data variables.product.product_name %} and the API. diff --git a/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md b/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md index 6bf832fcb67e..be9786624d19 100644 --- a/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md +++ b/content/github/creating-cloning-and-archiving-repositories/referencing-and-citing-content.md @@ -5,6 +5,8 @@ redirect_from: - /articles/referencing-and-citing-content versions: free-pro-team: '*' +topics: + - repositories --- ### Issuing a persistent identifier for your repository with Zenodo diff --git a/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md b/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md index 22648b22421f..c7553618ce96 100644 --- a/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-billing-for-codespaces.md @@ -4,6 +4,8 @@ intro: 'When {% data variables.product.prodname_codespaces %} becomes generally product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/about-codespaces.md b/content/github/developing-online-with-codespaces/about-codespaces.md index c711a287630b..133a2f95f3ea 100644 --- a/content/github/developing-online-with-codespaces/about-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-codespaces.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/about-github-codespaces versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md index 07781dde1b63..0c63b670abf4 100644 --- a/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md +++ b/content/github/developing-online-with-codespaces/configuring-codespaces-for-your-project.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/configuring-github-codespaces-for-your-project versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/creating-a-codespace.md b/content/github/developing-online-with-codespaces/creating-a-codespace.md index ff22cc9ec47b..11f694ab4101 100644 --- a/content/github/developing-online-with-codespaces/creating-a-codespace.md +++ b/content/github/developing-online-with-codespaces/creating-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/creating-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/deleting-a-codespace.md b/content/github/developing-online-with-codespaces/deleting-a-codespace.md index db9fe05a45e3..3479d7ede0d2 100644 --- a/content/github/developing-online-with-codespaces/deleting-a-codespace.md +++ b/content/github/developing-online-with-codespaces/deleting-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/deleting-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md index a9df2f093fa8..f40aa202bc8e 100644 --- a/content/github/developing-online-with-codespaces/developing-in-a-codespace.md +++ b/content/github/developing-online-with-codespaces/developing-in-a-codespace.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/developing-in-a-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/index.md b/content/github/developing-online-with-codespaces/index.md index 1ec4ada1215c..c0a39439e161 100644 --- a/content/github/developing-online-with-codespaces/index.md +++ b/content/github/developing-online-with-codespaces/index.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md index a364ad30507c..1db7b63da34c 100644 --- a/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md @@ -4,6 +4,8 @@ intro: You can manage the repositories that codespaces can access. product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md index 2843a272a729..f99fc17ff167 100644 --- a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md @@ -1,9 +1,11 @@ --- title: Managing encrypted secrets for Codespaces -intro: You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables. +intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.' product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md index 41c342082979..2aeb8deb0965 100644 --- a/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces.md @@ -1,9 +1,11 @@ --- title: Managing GPG verification for Codespaces -intro: You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source. +intro: 'You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.' product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md index 2539fd67627a..57ec686accf5 100644 --- a/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md +++ b/content/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account.md @@ -7,6 +7,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md index 2daf7c260763..400c0391881e 100644 --- a/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md +++ b/content/github/developing-online-with-codespaces/troubleshooting-your-codespace.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-github-codespaces/troubleshooting-your-codespace versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md index cc973aea5e47..a190ef196242 100644 --- a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code.md @@ -6,6 +6,8 @@ redirect_from: - /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code versions: free-pro-team: '*' +topics: + - codespaces --- {% data reusables.codespaces.release-stage %} diff --git a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md index 64cedbedb9f1..084fc31a5389 100644 --- a/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md +++ b/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md @@ -4,6 +4,8 @@ intro: 'You can develop in your codespace directly in {% data variables.product. product: '{% data reusables.gated-features.codespaces %}' versions: free-pro-team: '*' +topics: + - codespaces --- {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md index 93644fd98585..8599ca24b290 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md index 0e514fc25e32..5869a83fc04d 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md index d8f88cd46b94..cac898efaf72 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index c54a30bb932d..26d431136039 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md index b94bfc2fbaf2..dae62003f2f0 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta-codeql-runner %} @@ -35,12 +37,18 @@ To customize the way the {% data variables.product.prodname_codeql_runner %} sca Scanning code whenever a pull request is created prevents developers from introducing new vulnerabilities and errors into the code. -To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. +To scan a pull request, run the `analyze` command and use the `--ref` flag to specify the pull request. The reference is `refs/pull//head` or `refs/pull//merge`, depending on whether you have checked out the HEAD commit of the pull request branch or a merge commit with the base branch. ```shell -$ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/head +$ /path/to-runner/codeql-runner-linux analyze --ref refs/pull/42/merge ``` +{% note %} + +**Note**: If you analyze code with a third-party tool and want the results to appear as pull request checks, you must run the `upload` command and use the `--ref` flag to specify the pull request instead of the branch. The reference is `refs/pull//head` or `refs/pull//merge`. + +{% endnote %} + ### Overriding automatic language detection The {% data variables.product.prodname_codeql_runner %} automatically detects and scans code written in the supported languages. @@ -110,7 +118,9 @@ If the `autobuild` command can't build your code, you can run the build steps yo By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command. -Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." +Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. +- If you uploaded to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." +- If you uploaded to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." ### {% data variables.product.prodname_codeql_runner %} command reference diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md index 3f9ef7ac04ec..99dabb5999a9 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md @@ -11,6 +11,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md index cf5bc1721e5c..3b6825a2dbdb 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- ### Table of Contents diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md index ee5e4671d591..a463ffdbf6ee 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md @@ -10,5 +10,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md index a05a2ca34942..004c326f7914 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md index b2ff31219a8e..511d7205cd92 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- @@ -98,6 +100,8 @@ To view the command-line reference for the runner, use the `-h` flag. For exampl This example runs {% data variables.product.prodname_codeql %} analysis on a Linux CI server for the `octo-org/example-repo` repository hosted on `{% data variables.command_line.git_url_example %}`. The process is very simple because the repository contains only languages that can be analyzed by {% data variables.product.prodname_codeql %} directly, without being built (that is, Go, JavaScript, Python, and TypeScript). +In this example, the server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. + 1. Check out the repository to analyze. 1. Move into the directory where the repository is checked out. 1. Initialize the {% data variables.product.prodname_codeql_runner %} and create {% data variables.product.prodname_codeql %} databases for the languages detected. @@ -110,19 +114,7 @@ This example runs {% data variables.product.prodname_codeql %} analysis on a Lin > Created CodeQL database at /srv/checkout/example-repo/codeql-runner/codeql_databases/javascript. ``` -1. Populate the {% data variables.product.prodname_codeql_runner %} databases, analyze them, and upload the results to {% data variables.product.product_name %}. - - ```shell - $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo - --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN - --commit 5b6a3078b31dc346e5ce7b86837d6abbe7a18bbd --ref refs/heads/main - > Finalizing database creation - > ... - > POST /repos/octo-org/example-repo/code-scanning/sarifs - 202 in 786ms - > Successfully uploaded results - ``` - -The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." +{% data reusables.code-scanning.codeql-runner-analyze-example %} #### Compiled language example @@ -139,8 +131,8 @@ This example is similar to the previous example, however this time the repositor > ... > CodeQL environment output to "/srv/checkout/example-repo-2/codeql-runner/codeql-env.json" and "/srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". - Please export these variables to future processes so that CodeQL can monitor the build, for example by running " - . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". + Please export these variables to future processes so that CodeQL can monitor the build, for example by running + ". /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` 1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. @@ -151,17 +143,7 @@ This example is similar to the previous example, however this time the repositor 1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting CodeQL code scanning in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system#no-code-found-during-the-build)." -1. Populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload the results to {% data variables.product.prodname_dotcom %}. - - ```shell - $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo-2 - --github-url {% data variables.command_line.git_url_example %} --github-auth TOKEN - --commit ae7b655ef30b50fb726ae7b3daa79571a39d194d --ref refs/heads/main - > Finalizing database creation - > ... - > POST /repos/octo-org/example-repo-2/code-scanning/sarifs - 202 in 573ms - > Successfully uploaded results - ``` +{% data reusables.code-scanning.codeql-runner-analyze-example %} {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md index eb3de3852583..8bdd7005a85b 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md index e7659aeb0920..fb199b31c068 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md @@ -12,6 +12,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -31,8 +33,8 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a {% data reusables.repositories.sidebar-security %} 3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) -4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. - !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png) +4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. + !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Workflows are only displayed if they are relevant for the programming languages detected in the repository. The {% data variables.product.prodname_codeql_workflow %} is always displayed, but the "Set up this workflow" button is only enabled if {% data variables.product.prodname_codeql %} analysis supports the languages present in the repository.{% endif %} 5. To customize how {% data variables.product.prodname_code_scanning %} scans your code, edit the workflow. Generally you can commit the {% data variables.product.prodname_codeql_workflow %} without making any changes to it. However, many of the third-party workflows require additional configuration, so read the comments in the workflow before committing. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md index 496acb280221..1d93129def8a 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md @@ -8,6 +8,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md index 6a37da5f57d9..7fb5107e44cf 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta-codeql-runner %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index 5e1f031769f0..b88ddd1e4fad 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -9,6 +9,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} @@ -168,4 +170,4 @@ The revised `steps` section of the workflow will look like this: ... ``` -For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#editing-a-code-scanning-workflow)." \ No newline at end of file +For more information about editing the {% data variables.product.prodname_codeql %} workflow file, see "[Configuring {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#editing-a-code-scanning-workflow)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index a8908896f78c..d8b31a696854 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -10,6 +10,8 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md index 942e66060bc4..685e815aeac8 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md @@ -8,5 +8,7 @@ versions: free-pro-team: '*' enterprise-server: '>=2.22' github-ae: '*' +topics: + - security --- diff --git a/content/github/finding-talent-with-github-jobs/about-github-jobs.md b/content/github/finding-talent-with-github-jobs/about-github-jobs.md index b828445961db..f524f975c777 100644 --- a/content/github/finding-talent-with-github-jobs/about-github-jobs.md +++ b/content/github/finding-talent-with-github-jobs/about-github-jobs.md @@ -6,6 +6,8 @@ redirect_from: intro: 'You can post a job on {% data variables.product.prodname_jobs %} to find talent for your business.' versions: free-pro-team: '*' +topics: + - jobs --- Before you can post a job, you must create a {% data variables.product.prodname_dotcom %} account and verify your email address. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)" and "[Verifying your email address](/articles/verifying-your-email-address)." diff --git a/content/github/finding-talent-with-github-jobs/index.md b/content/github/finding-talent-with-github-jobs/index.md index 2ac9ca9b92c6..16bb315d08f7 100644 --- a/content/github/finding-talent-with-github-jobs/index.md +++ b/content/github/finding-talent-with-github-jobs/index.md @@ -6,6 +6,8 @@ redirect_from: - /categories/finding-talent-with-github-jobs versions: free-pro-team: '*' +topics: + - jobs --- diff --git a/content/github/getting-started-with-github/about-github-advanced-security.md b/content/github/getting-started-with-github/about-github-advanced-security.md index f4e1f7ed5365..89ae0113f8b0 100644 --- a/content/github/getting-started-with-github/about-github-advanced-security.md +++ b/content/github/getting-started-with-github/about-github-advanced-security.md @@ -1,15 +1,18 @@ --- title: About GitHub Advanced Security -intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license. These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.' +intro: '{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% if currentVersion == "free-pro-team@latest" %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}' +product: '{% data reusables.gated-features.ghas %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' github-ae: '*' +topics: + - security --- ### About {% data variables.product.prodname_GH_advanced_security %} -{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% if currentVersion != "github-ae@latest" %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. +{% data variables.product.prodname_dotcom %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans{% if currentVersion != "github-ae@latest" %}, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}{% endif %}. Other security features require a license for {% data variables.product.prodname_GH_advanced_security %} to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}. {% if currentVersion == "free-pro-team@latest" %}For more information, see "[About licensing for {% data variables.product.prodname_GH_advanced_security %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-licensing-for-github-advanced-security)."{% elsif currentVersion ver_gt "enterprise-server@2.22" %}For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}.{% elsif currentVersion == "github-ae@latest" %}There is no charge for {% data variables.product.prodname_GH_advanced_security %} on {% data variables.product.prodname_ghe_managed %} during the beta release.{% endif %} @@ -43,7 +46,7 @@ Once your system is set up, you can enable and disable these features at the org For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public. -For other repositories, once you have a license for your organization or enterprise, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} {% endif %} diff --git a/content/github/getting-started-with-github/access-permissions-on-github.md b/content/github/getting-started-with-github/access-permissions-on-github.md index b2483b1986ea..bd8b6a4f518b 100644 --- a/content/github/getting-started-with-github/access-permissions-on-github.md +++ b/content/github/getting-started-with-github/access-permissions-on-github.md @@ -10,6 +10,9 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - permissions + - accounts --- ### Personal user accounts diff --git a/content/github/getting-started-with-github/be-social.md b/content/github/getting-started-with-github/be-social.md index d326445068bf..2817ef122eea 100644 --- a/content/github/getting-started-with-github/be-social.md +++ b/content/github/getting-started-with-github/be-social.md @@ -8,6 +8,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profile + - pull requests + - issues + - notifications + - accounts --- To learn about accessing your personal dashboard, see "[About your personal dashboard](/articles/about-your-personal-dashboard)." diff --git a/content/github/getting-started-with-github/create-a-repo.md b/content/github/getting-started-with-github/create-a-repo.md index e04f4e2030d5..94477e922cf8 100644 --- a/content/github/getting-started-with-github/create-a-repo.md +++ b/content/github/getting-started-with-github/create-a-repo.md @@ -8,6 +8,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md b/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md index caee1aa1ebf5..595962f3c5ec 100644 --- a/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md +++ b/content/github/getting-started-with-github/exploring-early-access-releases-with-feature-preview.md @@ -5,6 +5,8 @@ redirect_from: - /articles/exploring-early-access-releases-with-feature-preview versions: free-pro-team: '*' +topics: + - early access --- ### {% data variables.product.prodname_dotcom %}'s release cycle diff --git a/content/github/getting-started-with-github/exploring-projects-on-github.md b/content/github/getting-started-with-github/exploring-projects-on-github.md index 796214bfb518..86b64226f473 100644 --- a/content/github/getting-started-with-github/exploring-projects-on-github.md +++ b/content/github/getting-started-with-github/exploring-projects-on-github.md @@ -11,5 +11,7 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - projects --- diff --git a/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md b/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md index 6d85fbd4f0d8..c9bba505fd13 100644 --- a/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md +++ b/content/github/getting-started-with-github/faq-about-changes-to-githubs-plans.md @@ -3,6 +3,8 @@ title: FAQ about changes to GitHub’s plans intro: 'As of April 14, 2020, GitHub announced that all of the core GitHub features are now free for everyone.' versions: free-pro-team: '*' +topics: + - github --- ### What plans and pricing changes did GitHub announce on April 14? diff --git a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md index d1b5e3c6c9a4..46760bbc0700 100644 --- a/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md +++ b/content/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github.md @@ -10,6 +10,8 @@ redirect_from: - /github/getting-started-with-github/finding-open-source-projects-on-github versions: free-pro-team: '*' +topics: + - open source --- ### Discovering relevant projects diff --git a/content/github/getting-started-with-github/following-people.md b/content/github/getting-started-with-github/following-people.md index cbf380c4a01c..c629d1875126 100644 --- a/content/github/getting-started-with-github/following-people.md +++ b/content/github/getting-started-with-github/following-people.md @@ -7,6 +7,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - profile --- When you follow people, you'll see their public activity in the activity view of your news feed.{% if currentVersion == "free-pro-team@latest" %} If someone you follow stars a public repository, {% data variables.product.product_name %} may recommend the repository to you in the discovery view of your news feed.{% endif %} To follow someone, visit their profile page and click **Follow** under their profile image. diff --git a/content/github/getting-started-with-github/fork-a-repo.md b/content/github/getting-started-with-github/fork-a-repo.md index 74914f4ea55f..777773290a11 100644 --- a/content/github/getting-started-with-github/fork-a-repo.md +++ b/content/github/getting-started-with-github/fork-a-repo.md @@ -9,6 +9,11 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - pull requests + - issues + - notifications + - accounts --- Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. diff --git a/content/github/getting-started-with-github/github-cli.md b/content/github/getting-started-with-github/github-cli.md index 9abdb3615951..ff68b7c922cf 100644 --- a/content/github/getting-started-with-github/github-cli.md +++ b/content/github/getting-started-with-github/github-cli.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '>2.19' github-ae: '*' +topics: + - cli --- ### About {% data variables.product.prodname_cli %} diff --git a/content/github/getting-started-with-github/github-desktop.md b/content/github/getting-started-with-github/github-desktop.md index bce85ea84e85..cfb8affbb716 100644 --- a/content/github/getting-started-with-github/github-desktop.md +++ b/content/github/getting-started-with-github/github-desktop.md @@ -5,6 +5,8 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - desktop --- ### About {% data variables.product.prodname_desktop %} diff --git a/content/github/getting-started-with-github/github-for-mobile.md b/content/github/getting-started-with-github/github-for-mobile.md index 1a0fc38c537e..13e74967423b 100644 --- a/content/github/getting-started-with-github/github-for-mobile.md +++ b/content/github/getting-started-with-github/github-for-mobile.md @@ -4,6 +4,8 @@ intro: 'Triage, collaborate, and manage your work on {% data variables.product.p versions: free-pro-team: '*' enterprise-server: '>=3.0' +topics: + - mobile --- {% data reusables.mobile.ghes-release-phase %} diff --git a/content/github/getting-started-with-github/githubs-products.md b/content/github/getting-started-with-github/githubs-products.md index 4f14fddd35c5..8a162bbf28a2 100644 --- a/content/github/getting-started-with-github/githubs-products.md +++ b/content/github/getting-started-with-github/githubs-products.md @@ -8,6 +8,12 @@ versions: free-pro-team: '*' enterprise-server: '*' github-ae: '*' +topics: + - accounts + - cli + - mobile + - desktop + - security --- {% data variables.product.prodname_dotcom %} offers free and paid products. You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %} @@ -79,7 +85,8 @@ In addition to the features available with {% data variables.product.prodname_te - Additional security, compliance, and deployment controls - Authentication with SAML single sign-on - Access provisioning with SAML or SCIM -- {% data variables.product.prodname_github_connect %} +- {% data variables.product.prodname_github_connect %}{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +- The option to purchase {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)."{% endif %} {% data variables.product.prodname_ghe_cloud %} also includes: - {% data variables.contact.enterprise_support %}. For more information, see "{% data variables.product.prodname_ghe_cloud %} support" and "{% data variables.product.prodname_ghe_cloud %} Addendum." diff --git a/content/github/getting-started-with-github/index.md b/content/github/getting-started-with-github/index.md index f3f4596e9eb9..184a5a0296c6 100644 --- a/content/github/getting-started-with-github/index.md +++ b/content/github/getting-started-with-github/index.md @@ -34,6 +34,11 @@ featuredLinks: - /github/getting-started-with-github/types-of-github-accounts - /github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github - /github/getting-started-with-github/troubleshooting-connectivity-problems +topics: + - pull requests + - issues + - notifications + - accounts ---