diff --git a/.github/workflows/readability.yml b/.github/workflows/readability.yml new file mode 100644 index 000000000000..33634614f0fb --- /dev/null +++ b/.github/workflows/readability.yml @@ -0,0 +1,108 @@ +name: Readability report + +# **What it does**: Analyzes readability of rendered content for changed Markdown files in pull requests +# **Why we have it**: We want to track and improve the readability of our documentation over time +# **Who does it impact**: Contributors and content writers + +on: + # pull_request: + # paths: + # - 'content/**/*.md' + # - 'data/reusables/**/*.md' + # The pull_request trigger is currently disabled for testing purposes. + # Re-enable this trigger when ready to run readability analysis automatically on PRs. + workflow_dispatch: + inputs: + pull_request_number: + description: 'Pull request number to analyze (for testing)' + required: true + type: number + +permissions: + contents: read + pull-requests: write + +jobs: + readability-analysis: + if: github.repository == 'github/docs-internal' + runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }} + steps: + - name: Check out repo with full history + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + fetch-depth: 0 + + - name: Checkout PR for manual dispatch + if: ${{ github.event_name == 'workflow_dispatch' }} + run: | + gh pr checkout ${{ inputs.pull_request_number }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - uses: ./.github/actions/node-npm-setup + + - uses: ./.github/actions/get-docs-early-access + if: ${{ github.repository == 'github/docs-internal' }} + with: + token: ${{ secrets.DOCS_BOT_PAT_BASE }} + + - name: Get changed content files + id: changed_files + uses: ./.github/actions/get-changed-files + with: + files: 'content/**/*.md' + # For workflow_dispatch, compare against main + base: ${{ github.event_name == 'workflow_dispatch' && 'main' || '' }} + + - name: Disable Next.js telemetry + run: npx next telemetry disable + + - name: Start server in the background + if: ${{ steps.changed_files.outputs.filtered_changed_files }} + run: npm start > /tmp/stdout.log 2> /tmp/stderr.log & + + - name: Run readability analysis + if: ${{ steps.changed_files.outputs.filtered_changed_files }} + env: + CHANGED_FILES: ${{ steps.changed_files.outputs.filtered_changed_files }} + run: npm run readability-report + + - name: Find existing readability comment + if: ${{ steps.changed_files.outputs.filtered_changed_files }} + uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e + id: findComment + with: + issue-number: ${{ github.event_name == 'workflow_dispatch' && inputs.pull_request_number || github.event.number }} + comment-author: 'github-actions[bot]' + body-includes: '' + + - name: Read readability report + if: ${{ steps.changed_files.outputs.filtered_changed_files }} + id: read_report + run: | + if [ -f "readability-report.md" ]; then + { + echo 'report<> "$GITHUB_OUTPUT" + fi + + - name: Create or update readability comment + if: ${{ steps.changed_files.outputs.filtered_changed_files && steps.read_report.outputs.report }} + uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 + with: + comment-id: ${{ steps.findComment.outputs.comment-id }} + issue-number: ${{ github.event_name == 'workflow_dispatch' && inputs.pull_request_number || github.event.number }} + body: | + + ${{ steps.read_report.outputs.report }} + edit-mode: replace + + - if: ${{ failure() }} + name: Debug server outputs on errors + run: | + echo "____STDOUT____" + cat /tmp/stdout.log || echo "No stdout log found" + echo "____STDERR____" + cat /tmp/stderr.log || echo "No stderr log found" diff --git a/assets/images/help/copilot/mermaid-gantt-chart-example.png b/assets/images/help/copilot/mermaid-gantt-chart-example.png new file mode 100644 index 000000000000..c180eb4acb3d Binary files /dev/null and b/assets/images/help/copilot/mermaid-gantt-chart-example.png differ diff --git a/content/account-and-profile/how-tos/index.md b/content/account-and-profile/how-tos/index.md new file mode 100644 index 000000000000..5b5bff7d120a --- /dev/null +++ b/content/account-and-profile/how-tos/index.md @@ -0,0 +1,13 @@ +--- +title: How-tos for your GitHub account and profile +shortTitle: How-tos +intro: 'Learn how to accomplish specific tasks for your {% data variables.product.github %} account and profile.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +children: + - /setting-up-and-managing-your-github-profile + - /setting-up-and-managing-your-personal-account-on-github +--- + diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md similarity index 83% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md index bdc2fb852863..caf82af24f8d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md @@ -4,6 +4,7 @@ intro: You can customize your profile so that other people can get a better sens redirect_from: - /articles/customizing-your-profile - /github/setting-up-and-managing-your-github-profile/customizing-your-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index ce50dc5cf298..10063002c1ca 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -11,6 +11,7 @@ permissions: 'Profile READMEs are not available to {% data variables.enterprise. redirect_from: - /github/setting-up-and-managing-your-github-profile/managing-your-profile-readme - /github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme + - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme shortTitle: Your profile README --- ## About your profile README diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md similarity index 94% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md index 93b78423cb0b..afa346192ea4 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile.md @@ -6,6 +6,7 @@ redirect_from: - /articles/pinning-items-to-your-profile - /github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile - /github/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md similarity index 94% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md index 1b1bdeeb2a74..f16ba8f0a619 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md @@ -6,6 +6,8 @@ versions: topics: - Profiles shortTitle: Set profile to private +redirect_from: + - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private --- ## About private profiles diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/index.md similarity index 86% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/index.md index 97adb42f5279..f8b9b549887b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/index.md @@ -5,6 +5,7 @@ shortTitle: Profiles redirect_from: - /categories/setting-up-and-managing-your-github-profile - /github/setting-up-and-managing-your-github-profile + - /account-and-profile/setting-up-and-managing-your-github-profile versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md similarity index 88% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md index 1e9ebb4b9be0..538d95070b18 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/managing-contribution-graphs-on-your-profile - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md index 218dfb5f3a6a..13c28d672c3b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server.md @@ -9,6 +9,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-your-github-enterprise-server-contributions-to-your-githubcom-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/sharing-contributions-from-github-enterprise-server versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md similarity index 90% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md index 575cd333dda4..95c9ca2e7db0 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/showing-an-overview-of-your-activity-on-your-profile - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/showing-an-overview-of-your-activity-on-your-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/showing-an-overview-of-your-activity-on-your-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-an-overview-of-your-activity-on-your-profile versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md similarity index 85% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md index a758eb4f316f..c28e94b8e61b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile.md @@ -1,18 +1,19 @@ --- -title: Showing your private contributions {% ifversion hide-individual-achievements %}and achievements {% endif %}on your profile -intro: 'Your profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from private and internal repositories in addition to the activity from public repositories.' +title: 'Showing your private contributions {% ifversion hide-individual-achievements %}and achievements {% endif %}on your profile' +intro: Your profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from private and internal repositories in addition to the activity from public repositories. redirect_from: - /articles/publicizing-or-hiding-your-private-contributions-on-your-profile - /github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/publicizing-or-hiding-your-private-contributions-on-your-profile + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile versions: fpt: '*' ghes: '*' ghec: '*' topics: - Profiles -shortTitle: Private contributions {% ifversion hide-individual-achievements %}and achievements{% endif %} +shortTitle: 'Private contributions {% ifversion hide-individual-achievements %}and achievements{% endif %}' allowTitleToDifferFromFilename: true --- diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md index af44867ff0d5..983698442b63 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/troubleshooting-commits-on-your-timeline - /github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/troubleshooting-commits-on-your-timeline + - /account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/index.md similarity index 91% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/index.md index 90c8ee5cd820..971bc889bcb6 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/index.md @@ -6,6 +6,7 @@ redirect_from: - /categories/setting-up-and-managing-your-github-user-account - /github/setting-up-and-managing-your-github-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github versions: fpt: '*' ghes: '*' @@ -19,3 +20,4 @@ children: - /managing-access-to-your-personal-repositories - /managing-your-membership-in-organizations --- + diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md similarity index 88% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md index d0f4022cef1f..61d5320a5479 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/index.md @@ -7,6 +7,7 @@ redirect_from: - /articles/managing-access-to-your-personal-repositories - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories product: '{% data reusables.gated-features.user-repo-collaborators %}' versions: fpt: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md similarity index 95% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md index 265b74467ebe..abbb01658c5f 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository product: '{% data reusables.gated-features.user-repo-collaborators %}' versions: fpt: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md similarity index 92% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md index 6052b705a660..12c8c26313b2 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories.md @@ -11,6 +11,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/maintaining-ownership-continuity-of-your-user-accounts-repositories - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-user-accounts-repositories + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories shortTitle: Ownership continuity --- ## About successors diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md similarity index 92% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md index f4e59183c1c7..d4a43c5a2a2d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md @@ -11,6 +11,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository product: '{% data reusables.gated-features.user-repo-collaborators %}' versions: fpt: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md similarity index 88% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md index 2ec766ed7f1c..60f98c7c8037 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository.md @@ -10,6 +10,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository - /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-yourself-from-a-collaborators-repository versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md index 9a2f8685b1d4..d90863a9785b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md similarity index 91% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md index 5b572d080814..1dbf5b60f609 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/blocking-command-line-pushes-that-expose-your-personal-email-address - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md similarity index 89% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md index 3b466eed1902..6dcdb30c1986 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md @@ -1,11 +1,12 @@ --- title: Changing your primary email address -intro: To change your primary email address, you'll add a new email, then delete the old one. +intro: 'To change your primary email address, you''ll add a new email, then delete the old one.' redirect_from: - /articles/changing-your-primary-email-address - /github/setting-up-and-managing-your-github-user-account/changing-your-primary-email-address - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/changing-your-primary-email-address + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md similarity index 90% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md index 047740c5b1e9..ee415190dbf3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md @@ -6,6 +6,7 @@ redirect_from: - /articles/managing-email-preferences - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md similarity index 94% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md index e9a4017064ba..2cb40d5621de 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md @@ -6,6 +6,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-marketing-emails-from-github - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/managing-marketing-emails-from-github - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/managing-marketing-emails-from-github + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md similarity index 95% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md index fca0214c2b0f..9ffbf68b9afd 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/remembering-your-github-username-or-email - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/remembering-your-github-username-or-email + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md similarity index 75% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md index 6a86b6913623..11a1b9d8c7d7 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address.md @@ -1,11 +1,12 @@ --- title: Setting a backup email address -intro: 'Use a backup email address as an additional destination for security-relevant account notifications and to securely reset your password if you can no longer access your primary email address.' +intro: Use a backup email address as an additional destination for security-relevant account notifications and to securely reset your password if you can no longer access your primary email address. redirect_from: - /articles/setting-a-backup-email-address - /github/setting-up-and-managing-your-github-user-account/setting-a-backup-email-address - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-a-backup-email-address - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-a-backup-email-address + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-a-backup-email-address versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md index 0c5487cbfcd6..bd4c0a5c05af 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md @@ -13,6 +13,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address - /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md similarity index 98% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md index 174f310914d3..43652ec03e31 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address.md @@ -8,6 +8,7 @@ redirect_from: - /github/getting-started-with-github/verifying-your-email-address - /github/getting-started-with-github/signing-up-for-github/verifying-your-email-address - /get-started/signing-up-for-github/verifying-your-email-address + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md similarity index 84% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md index 4f2ed182f0bc..5f7619ab395e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire.md @@ -1,6 +1,6 @@ --- title: About 'Available for hire' -intro: When you select **Available for hire**, you indicate that you're open to job opportunities. +intro: 'When you select **Available for hire**, you indicate that you''re open to job opportunities.' redirect_from: - /articles/what-does-the-available-for-hire-checkbox-do - /github/setting-up-and-managing-your-github-user-account/what-does-the-available-for-hire-checkbox-do @@ -8,6 +8,7 @@ redirect_from: - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/what-does-the-available-for-hire-checkbox-do - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/what-does-the-available-for-hire-checkbox-do - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/what-does-the-available-for-hire-checkbox-do + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-available-for-hire versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md similarity index 90% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md index 812a24b591e2..20486aa17f13 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md similarity index 92% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md index 7595b67d83c7..18a4da7d59c2 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/integrating-jira-with-your-personal-projects - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/integrating-jira-with-your-personal-projects + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/integrating-jira-with-your-personal-projects versions: ghes: '*' shortTitle: Integrate Jira with projects diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md similarity index 94% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md index e5298ecb2e7e..b60a9b347ec1 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md @@ -9,6 +9,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-access-to-your-user-accounts-project-boards - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-access-to-your-user-accounts-project-boards - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards versions: feature: projects-v1 topics: diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md index bae9deb563ac..f52fb7c96bc0 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md @@ -9,6 +9,7 @@ versions: redirect_from: - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-accessibility-settings - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-accessibility-settings + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings type: how_to --- diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md similarity index 92% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md index bf382a96dd1e..e211d193de03 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories.md @@ -12,6 +12,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories shortTitle: Manage default branch name --- ## About management of the default branch name diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md similarity index 86% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md index 4ff78e34217f..b43075c9553a 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference.md @@ -11,6 +11,7 @@ shortTitle: Managing your tab size redirect_from: - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-tab-size-rendering-preference - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-tab-size-rendering-preference + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference --- If you feel that tabbed indentation in code rendered on {% data variables.product.github %} takes up too much, or too little space, you can change this in your settings. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md index 766b541db4cc..58f440d2e1c6 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account versions: feature: projects-v1 topics: diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md similarity index 86% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md index 0091b07b3459..2e8ee5e1a18d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization.md @@ -9,6 +9,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/accessing-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/accessing-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md similarity index 87% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md index 60238dd6fd61..33805aa1c9be 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/index.md @@ -5,6 +5,7 @@ redirect_from: - /articles/managing-your-membership-in-organizations - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md index 5af4ef321ce5..0e10db06c91c 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders.md @@ -10,6 +10,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-your-scheduled-reminders - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/managing-your-scheduled-reminders + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/managing-your-scheduled-reminders shortTitle: Manage scheduled reminders --- ## About scheduled reminders for users diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md similarity index 90% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md index febd59177a0a..79f9552fa50b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/publicizing-or-hiding-organization-membership - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md similarity index 91% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md index dc3617ea8199..bfaf86852f1d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization.md @@ -7,6 +7,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/removing-yourself-from-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/removing-yourself-from-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/removing-yourself-from-an-organization versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md similarity index 90% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md index 58dfa736d07e..a24efd0655d8 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps.md @@ -8,12 +8,13 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/requesting-organization-approval-for-oauth-apps - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps versions: fpt: '*' ghec: '*' topics: - Accounts -shortTitle: Request {% data variables.product.prodname_oauth_app %} approval +shortTitle: 'Request {% data variables.product.prodname_oauth_app %} approval' --- ## About requesting organization approval for an {% data variables.product.prodname_oauth_app %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md similarity index 96% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md index bec4fec616f3..d9d1a979c6d4 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/viewing-peoples-roles-in-an-organization - /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md index 9d6fe57340fe..db150850e0b5 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/converting-a-user-into-an-organization - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/converting-a-user-into-an-organization + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization intro: You can convert your personal account into an organization. This allows more granular permissions for repositories that belong to the organization. versions: fpt: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md index afa605a4c8d2..b277432b1e47 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account.md @@ -8,6 +8,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/deleting-your-user-account - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/deleting-your-personal-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/deleting-your-personal-account versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md similarity index 82% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md index 61ce0d3de7e6..614051638335 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/index.md @@ -14,5 +14,7 @@ children: - /converting-a-user-into-an-organization - /unlinking-your-email-address-from-a-locked-account - /deleting-your-personal-account +redirect_from: + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account --- diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md similarity index 97% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md index 30dcf9a2ee9c..8cae333d8e63 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts.md @@ -8,6 +8,8 @@ topics: - Git - GitHub shortTitle: Manage multiple accounts +redirect_from: + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/managing-multiple-accounts --- ## About management of multiple accounts diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md similarity index 95% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md index 9b75440b2e1f..37e6f224da8b 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts.md @@ -9,6 +9,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/merging-multiple-personal-accounts + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/merging-multiple-personal-accounts versions: fpt: '*' ghec: '*' diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md similarity index 59% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md rename to content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md index 3834acfdb0e0..633ea34523ec 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md +++ b/content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account.md @@ -1,8 +1,9 @@ --- title: Unlinking your email address from a locked account -intro: 'If you have lost your two-factor authentication (2FA) credentials and are unable to recover access, you can remove the connection between your email address and a 2FA locked account. The email address is then available for you to link it to a new or existing account, maintaining your commit history.' +intro: 'If you have lost your two-factor authentication (2FA) credentials and are unable to recover access, you can remove the connection between your email address and a 2FA locked account.' redirect_from: - /early-access/account-and-profile/unlinking-your-email-address-from-a-locked-account + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account versions: fpt: '*' ghec: '*' @@ -25,22 +26,17 @@ Be aware that nothing else associated with your 2FA locked account, including yo Unlinking email addresses is only available for accounts with 2FA enabled. If you do not have 2FA enabled, you can sign in and remove your email address from your account settings. +Educational benefits cannot be transferred after an email address is unlinked and associated with a different account. To keep these benefits, you must continue using the original account that was used to apply. + > [!WARNING] -> Following these steps will not disable 2FA or provide access to a locked account, but will instead unlink the associated email address so it may be used for a different account. If you cannot regain access to the 2FA locked account, these steps will permanently break the link between the account and the linked email address. Before continuing with this article, be sure you have lost all access to your account. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials). -> -> Educational benefits and discounts cannot be transferred after an email address is unlinked and associated with a different account. To keep these benefits, you must continue using the original account that was used to apply. +> Following these steps will not disable 2FA or provide access to a locked account, but will instead unlink the associated email address so it may be used for a different account. If you cannot regain access to the 2FA locked account, these steps will permanently break the link between the account and the linked email address. Before continuing, be sure you have lost all access to your account. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials). ### Unlinking with your password -If you know your password, you can sign in with your password to unlink your email address +If you know your password, you can sign in with your password to unlink your email address. -1. Navigate to [https://github.com/login](https://github.com/login). -1. To prompt two-factor authentication, type your username and password, then click **Sign in**. -1. Under "Having problems?", click **Use a recovery code or begin 2FA account recovery**. -1. Under "Locked out?", click **Try 2FA account recovery, or unlink your account email address(es)**. -1. In the modal that appears, click **I understand, get started**. -1. You may be required to verify an email address. To send an email containing a one-time password to each email address associated with your account, click **Send one-time password**. -1. To verify your identity, type the one-time password from your email in the "One-time password" text field, then click **Verify email address**. +{% data reusables.accounts.prompt-for-2fa-recovery-code %} +{% data reusables.accounts.start-automated-recovery-with-password %} {% data reusables.accounts.unlinking-email-address %} ### Unlinking without your password @@ -48,7 +44,5 @@ If you know your password, you can sign in with your password to unlink your ema If you do not know your account password, you can request a password reset link to unlink your email address. {% data reusables.accounts.request-password-reset-link %} - -1. On {% data variables.product.prodname_dotcom %}, you will be prompted for your 2FA credentials. Under "Having problems?", click **Start a 2FA recovery request or unlink your account email address(es)**. -1. In the modal that appears, click **I understand, get started**. +{% data reusables.accounts.start-automated-recovery-without-password %} {% data reusables.accounts.unlinking-email-address %} diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index c52d6acdf787..d570cda13b48 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -1,26 +1,23 @@ --- title: Account and profile documentation shortTitle: Account and profile -intro: 'Make {% data variables.product.github %} work best for you by customizing your personal account settings, personalizing your profile page, and managing the notifications you receive.' +intro: 'Make {% data variables.product.github %} work best for you by customizing your personal account settings and personalizing your profile page.' introLinks: quickstart: - /get-started/onboarding/getting-started-with-your-github-account featuredLinks: startHere: - /account-and-profile/concepts/changing-your-github-username - - /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme - - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications + - /account-and-profile/how-tos/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme popular: - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository - - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications + - /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address + - /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository guideCards: - /account-and-profile/reference/why-are-my-contributions-not-showing-up-on-my-profile - - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address - - '{% ifversion ghes %}/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}' + - /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address + - '{% ifversion ghes %}/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-the-default-branch-name-for-your-repositories{% endif %}' changelog: - label: 'profiles, github-themes, notifications' + label: 'profiles, github-themes' versions: fpt: '*' ghec: '*' @@ -32,14 +29,11 @@ versions: topics: - Accounts - Profiles - - Notifications children: - /get-started - /concepts + - /how-tos - /tutorials - /reference - - /setting-up-and-managing-your-personal-account-on-github - - /setting-up-and-managing-your-github-profile - - /managing-subscriptions-and-notifications-on-github --- diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/index.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/index.md deleted file mode 100644 index 0b721155af90..000000000000 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Setting up notifications -intro: 'To improve the relevance of your notifications and simplify your triaging workflow, set up your notifications to match your priorities.' -redirect_from: - - /articles/getting-started-with-notifications - - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Notifications -children: - - /about-notifications - - /configuring-notifications ---- - diff --git a/content/admin/all-releases.md b/content/admin/all-releases.md index 1563b33c6ba1..f5dad4c6428d 100644 --- a/content/admin/all-releases.md +++ b/content/admin/all-releases.md @@ -25,7 +25,7 @@ For information about the latest release, see the [{% data variables.product.pro {%- for version in enterpriseServerReleases.supported %} {%- assign currentDate = 'now' | date: '%s' %} {%- assign deprecationDate = enterpriseServerReleases.dates[version].deprecationDate | date: '%s' %} -| {{version}} | {{enterpriseServerReleases.dates[version].releaseDate}} | {{enterpriseServerReleases.dates[version].deprecationDate}} | {% if currentDate < deprecationDate %}{% octicon "check" aria-label="Supported" %}{% else %}{% octicon "x" aria-label="Not supported" %}{% endif %} | [{{version}} release notes](/enterprise-server@{{version}}/admin/release-notes) | [{{version}} documentation](/enterprise-server@{{version}}) | +| {{version}} | {{enterpriseServerReleases.dates[version].releaseDate}} | Support temporarily extended until further notice | {% octicon "check" aria-label="Supported" %} | [{{version}} release notes](/enterprise-server@{{version}}/admin/release-notes) | [{{version}} documentation](/enterprise-server@{{version}}) | {%- endfor %} {%- for version in enterpriseServerReleases.deprecatedReleasesWithNewFormat %} | {{version}} | {{enterpriseServerReleases.dates[version].releaseDate}} | {{enterpriseServerReleases.dates[version].deprecationDate}} | {% octicon "x" aria-label="Not supported" %} | [{{version}} release notes](/enterprise-server@{{version}}/admin/release-notes) | [{{version}} documentation](/enterprise-server@{{version}}) | diff --git a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md index 07ef4f44b9a6..bf5cf3482a0a 100644 --- a/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md +++ b/content/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance.md @@ -21,6 +21,14 @@ redirect_from: {% data variables.product.company_short %} strongly recommends regular backups of your instance's configuration and data. Before you proceed with any upgrade, back up your instance, then validate the backup in a staging environment. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance) and [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). +## Hold off on upgrading to 3.15 and above + +We have received a few reports of performance issues with {% data variables.product.prodname_ghe_server %} versions 3.15, 3.16, and 3.17. Out of an abundance of caution, we recommend holding off on upgrading to these versions until further notice. + +We are extending the support window for versions 3.14, 3.15, 3.16, and 3.17. The support window for 3.13 remains unchanged. The closing down date for each of 3.14, 3.15, 3.16, and 3.17 has been updated to "Support temporarily extended until further notice". For more information, see [AUTOTITLE](/admin/all-releases#releases-of-github-enterprise-server). + +We will continue to release patches for 3.14, 3.15, 3.16, and 3.17 throughout this extended support window. + {% ifversion ghes < 3.15 %} ## Elasticsearch Upgrade diff --git a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index b3517d0b773c..c009bd57dae7 100644 --- a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -1,6 +1,6 @@ --- title: Updating your GitHub access credentials -intro: '{% data variables.product.github %} credentials include not only your password, but also the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.github %}. Should you have the need, you can reset all of these access credentials yourself.' +intro: '{% data variables.product.github %} credentials include your password, access tokens, SSH keys, and application API tokens used to communicate with {% data variables.product.github %}. You can reset all of these access credentials yourself.' redirect_from: - /articles/rolling-your-credentials - /articles/how-can-i-reset-my-password @@ -27,18 +27,16 @@ shortTitle: Update access credentials {% data reusables.accounts.request-password-reset-link %} 1. If you have enabled two-factor authentication, you will be prompted for your 2FA credentials: -{% ifversion fpt or ghec %} - * If you have {% data variables.product.prodname_mobile %}, you will be sent a push notification to verify your identity. Open the push notification or the {% data variables.product.prodname_mobile %} app and enter the two-digit code shown to you on the password reset page in your browser. - * To skip using {% data variables.product.prodname_mobile %} to verify, click **Enter two-factor authentication or recovery code**. -{% endif %} - * Type your authentication code or one of your recovery codes and click **Verify**. - * If you have added a security key to your account, click **Use security key** instead of typing an authentication code. - {% ifversion fpt or ghec %} - * If you have set up [{% data variables.product.prodname_mobile %}](https://github.com/mobile), click **Authenticate with {% data variables.product.prodname_mobile %}** instead. - {% endif %} - {% ifversion 2fa-recovery-flow %} - * If you've lost access to your two-factor authentication credentials and your recovery codes, you can start account recovery request. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#recovering-without-your-password-or-two-factor-authentication-credentials). - {% endif %} + * If you have added a passkey or a security key to your account, click **Use passkey or security key**. + {% ifversion fpt or ghec %} + * If you have set up [{% data variables.product.prodname_mobile %}](https://github.com/mobile), you will be sent a push notification to verify your identity. If you didn't receive a notification, click "More options", then **Authenticate with {% data variables.product.prodname_mobile %}**. + {% endif %} + * Alternatively, type your TOTP or SMS authentication code, or one of your recovery codes, and click **Verify**. + + {% ifversion 2fa-recovery-flow %} + > [!NOTE] + > If you've lost access to your two-factor authentication credentials and your recovery codes, you can start account recovery request. See [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#recovering-without-your-password-or-two-factor-authentication-credentials). + {% endif %} 1. In the text field under **Password**, type a new password. Then, in the text field under **Confirm password**, type the password again. 1. Click **Change password**. For help creating a strong password, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password). diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md index cb0637a0fb71..6231cc200b80 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -29,12 +29,10 @@ shortTitle: Recover an account with 2FA Use one of your recovery codes to automatically regain entry into your account. You may have saved your recovery codes to a password manager or your computer's downloads folder. The default filename for recovery codes is `github-recovery-codes.txt`. For more information about recovery codes, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods#downloading-your-two-factor-authentication-recovery-codes). -1. Type your username and password to prompt authentication. - - > [!NOTE] - > If you do not know your password, you can use a recovery code after requesting a new password. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password). +> [!NOTE] +> If you do not know your password, you can use a recovery code after requesting a new password. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password). -1. Under "Having problems?," click **Use a recovery code{% ifversion fpt or ghec %} or begin 2FA account recovery{% endif %}**. +{% data reusables.accounts.prompt-for-2fa-recovery-code %} 1. Type one of your recovery codes, then click **Verify**. ## Authenticating with a passkey @@ -63,19 +61,14 @@ If you know your password for {% data variables.product.prodname_dotcom %} but d You can use your two-factor authentication credentials or two-factor authentication recovery codes to regain access to your account anytime during the 3-5 day waiting period. -1. Type your username and password to prompt authentication. +> [!WARNING] +> {% data reusables.accounts.you-must-know-your-password %} - > [!WARNING] - > {% data reusables.accounts.you-must-know-your-password %} +{% data reusables.accounts.prompt-for-2fa-recovery-code %} +{% data reusables.accounts.start-automated-recovery-with-password %} +{% data reusables.accounts.choose-recovery-verification-factor %} -1. Under "Having problems?," click **Use a recovery code or begin 2FA account recovery**. -1. Under "Locked out?," click **Try 2FA account recovery, or unlink your account email address(es)**. -1. Click **I understand, get started** to request a reset of your authentication settings. -1. Click **Send one-time password** to send a one-time password to all eligible addresses associated with your account. Only verified emails are eligible for account recovery. If you've restricted password resets to your primary and/or backup addresses, these addresses are the only addresses eligible for account recovery. -1. Under "One-time password," type the temporary password from the recovery email {% data variables.product.prodname_dotcom %} sent, then click **Verify email address**. -1. {% data reusables.accounts.alternative-authentication %} - {% data reusables.accounts.alternative-authentication-note %} -1. {% data reusables.accounts.support-request-recovery %} +{% data reusables.accounts.automated-recovery-review-period-notice %} {% endif %} @@ -83,7 +76,11 @@ You can use your two-factor authentication credentials or two-factor authenticat ## Recovering without your password -If you have forgotten your password, you can request a new password. During the password reset process, you can use one of your two-factor authentication credentials or a recovery code. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password). +If you have forgotten your password, you can request a new password and recover your account during the password reset process. + +### Using a two-factor authentication recovery code to reset your password + +If you have your recovery codes, you can use them to complete the password reset process. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password). ### Recovering without your password or two-factor authentication credentials @@ -91,15 +88,14 @@ If you have lost access to your two-factor authentication credentials and your r {% data reusables.accounts.request-password-reset-link %} -1. On {% data variables.product.prodname_dotcom %}, you will be prompted for your 2FA credentials. Under "Having problems?," click **Start a 2FA recovery request or unlink your account email address(es)**. -1. To complete your recovery request, you'll need to verify an alternative authentication factor. -{% data reusables.accounts.alternative-authentication %} - {% data reusables.accounts.alternative-authentication-note %} -1. {% data reusables.accounts.support-request-recovery %} +{% data reusables.accounts.start-automated-recovery-without-password %} +{% data reusables.accounts.choose-recovery-verification-factor %} + +{% data reusables.accounts.automated-recovery-review-period-notice %} ## Unlinking your email address -If you have exhausted your recovery options, you can unlink your email address from your account. The email address is then available for you to link it to a new or existing account, maintaining your commit history. See [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account#unlinking-without-your-password). +If you have exhausted your recovery options, you can unlink your email address from your account. The email address is then available for you to link it to a new or existing account, maintaining your commit history. See [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/unlinking-your-email-address-from-a-locked-account). {% endif %} diff --git a/content/copilot/concepts/billing/copilot-requests.md b/content/copilot/concepts/billing/copilot-requests.md index c9992d0feeaf..c2ffeabeb85f 100644 --- a/content/copilot/concepts/billing/copilot-requests.md +++ b/content/copilot/concepts/billing/copilot-requests.md @@ -94,19 +94,20 @@ If you use **{% data variables.copilot.copilot_free_short %}**, you have access {% rowheaders %} -| Model | Multiplier for **paid plans** | Multiplier for **{% data variables.copilot.copilot_free_short %}** | -|-------------------------------------------------------------------------|--------------------------------|-----------------------| -| {% data variables.copilot.copilot_gpt_41 %} | 0 | 1 | -| {% data variables.copilot.copilot_gpt_4o %} | 0 | 1 | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | 1 | 1 | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | 1 | Not applicable | -| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | 1.25 | Not applicable | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | 1 | Not applicable | -| {% data variables.copilot.copilot_claude_opus %} | 10 | Not applicable | -| {% data variables.copilot.copilot_gemini_flash %} | 0.25 | 1 | -| {% data variables.copilot.copilot_gemini_25_pro %} | 1 | Not applicable | -| {% data variables.copilot.copilot_o3 %} | 1 | Not applicable | -| {% data variables.copilot.copilot_o4_mini %} | 0.33 | Not applicable | +| Model | Multiplier for **paid plans** | Multiplier for **{% data variables.copilot.copilot_free_short %}** | +|----------------------------------------------------------------|--------------------------------|-----------------------| +| {% data variables.copilot.copilot_gpt_41 %} | 0 | 1 | +| {% data variables.copilot.copilot_gpt_4o %} | 0 | 1 | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | 1 | 1 | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | 1 | Not applicable | +| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | 1.25 | Not applicable | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | 1 | Not applicable | +| {% data variables.copilot.copilot_claude_opus_41 %} | 10 | Not applicable | +| {% data variables.copilot.copilot_claude_opus %} | 10 | Not applicable | +| {% data variables.copilot.copilot_gemini_flash %} | 0.25 | 1 | +| {% data variables.copilot.copilot_gemini_25_pro %} | 1 | Not applicable | +| {% data variables.copilot.copilot_o3 %} | 1 | Not applicable | +| {% data variables.copilot.copilot_o4_mini %} | 0.33 | Not applicable | {% endrowheaders %} diff --git a/content/copilot/concepts/spaces.md b/content/copilot/concepts/spaces.md index ef71e038c5ee..8f77aaadb60b 100644 --- a/content/copilot/concepts/spaces.md +++ b/content/copilot/concepts/spaces.md @@ -49,7 +49,7 @@ Anyone with a {% data variables.product.prodname_copilot_short %} license, inclu During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Opt in to preview features** setting enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom). -{% data variables.copilot.copilot_spaces_short %} can belong to a personal account or to an organization. Spaces owned by an organization can be shared with other organization members (read-only) or kept private to the person who created the space. +{% data variables.copilot.copilot_spaces_short %} can belong to a personal account or to an organization. Spaces owned by an organization can be shared with other organization members or kept private to the person who created the space. ## How does using {% data variables.copilot.copilot_spaces_short %} affect my usage? diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 0010d12bf086..e80419dbd2b7 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -30,8 +30,6 @@ This version of this article is for using repository custom instructions and pro {% visualstudio %} -> [!NOTE] This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. - This version of this article is for using repository custom instructions in {% data variables.product.prodname_vs %}. Click the tabs above for instructions on using custom instructions in other environments. {% endvisualstudio %} @@ -78,7 +76,7 @@ Repository custom instructions let you provide {% data variables.product.prodnam {% visualstudio %} -* The **Enable custom instructions** option must be enabled in your settings. This is disabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article. +* The **Enable custom instructions** option must be enabled in your settings. This is enabled by default. See [Enabling or disabling repository custom instructions](#enabling-or-disabling-repository-custom-instructions) later in this article. {% endvisualstudio %} diff --git a/content/copilot/how-tos/provide-context/use-copilot-spaces/collaborate-with-your-team.md b/content/copilot/how-tos/provide-context/use-copilot-spaces/collaborate-with-your-team.md index e4a8f4b6cbed..52fccbe7ccf6 100644 --- a/content/copilot/how-tos/provide-context/use-copilot-spaces/collaborate-with-your-team.md +++ b/content/copilot/how-tos/provide-context/use-copilot-spaces/collaborate-with-your-team.md @@ -26,7 +26,7 @@ contentType: how-tos ## Use cases for team collaboration -* **Onboarding**: Share a space with code, documentation, diagrams, and checklists to help new developers get started faster. +* **Onboarding**: Share a space with code, documentation, diagrams, and checklists to help new developers get started faster. Make other members of your team editors so anyone can update the included resources. * **System knowledge**: Create a space for a complex system or workflow (like authentication or CI pipelines) that other people can reference. * **Style guides or review checklists**: Document standards and examples in a space that {% data variables.product.prodname_copilot_short %} can reference when suggesting changes. @@ -36,17 +36,22 @@ For example, a subject matter expert creates a space called “Accessibility Rev When you create a space, you can choose whether it’s owned by you or by one of your organizations. If you choose an organization: -* You can share the space with others in the organization, giving read access to all organization members. -* Other people with access can view the context, use {% data variables.product.prodname_copilot_short %} within the space, and ask questions. +* You can share the space with the organization, giving viewer, editor, or admin access to all organization members. +* You can give access to specific users or teams in the organization. For example, make everyone on your team an editor, or give admin access to a specific person so they can update the space's settings. If you choose to create a personal space, **you can't share it with others**. -To share a space with your organization: +To share a space with others: 1. In the top right corner of the space, click **{% octicon "kebab-horizontal" aria-hidden="true" aria-label="kebab-horizontal" %}**, then click **{% octicon "share" aria-hidden="true" aria-label="share" %} Share**. -1. Change the base role to "The entire organization can access". +1. To add specific users or teams, search for them with the search bar, then choose a role for the people you added. +1. Optionally, next to your organization's name, choose a base role for all other organization members. -Other people in your organization can now view the space in the "Organizations" tab and use it to ask questions. Additionally, you can also click **{% octicon "link" aria-label="the link" %} Copy link** to copy the link to the space and share it with others. + * **Viewers** can use the space to ask questions and view the included attachments and instructions. + * **Editors** can update the space's attachments, description, name, and instructions, in addition to having all the permissions of viewers. However, editors can't update sharing settings or delete the space. + * **Admins** can update sharing settings or delete the space, in addition to having all the permissions of viewers and editors. + +1. Optionally, click **{% octicon "link" aria-label="the link" %} Copy link** to copy the link to the space and share it with others. ## Accessing shared {% data variables.copilot.copilot_spaces_short %} diff --git a/content/copilot/reference/ai-models/model-comparison.md b/content/copilot/reference/ai-models/model-comparison.md index 193c395c15be..0fbea9b993da 100644 --- a/content/copilot/reference/ai-models/model-comparison.md +++ b/content/copilot/reference/ai-models/model-comparison.md @@ -23,18 +23,19 @@ contentType: reference Use this table to find a suitable model quickly, see more detail in the sections below. -| Model | Task area | Excels at (primary use case) | Additional capabilities | -|-------|-----------|-------------------------------|--------------------------| -| {% data variables.copilot.copilot_gpt_41 %} | General-purpose coding and writing | Fast, accurate code completions and explanations | Agent mode, visual | -| {% data variables.copilot.copilot_gpt_4o %} | General-purpose coding and writing | Fast completions and visual input understanding | Agent mode, visual | -| {% data variables.copilot.copilot_o3 %} | Deep reasoning and debugging | Multi-step problem solving and architecture-level code analysis | Reasoning | -| {% data variables.copilot.copilot_o4_mini %} | Fast help with simple or repetitive tasks | Fast, reliable answers to lightweight coding questions | Lower latency | -| {% data variables.copilot.copilot_claude_opus %} | Deep reasoning and debugging | Complex problem-solving challenges, sophisticated reasoning | Reasoning, vision | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | Fast help with simple or repetitive tasks | Quick responses for code, syntax, and documentation | Agent mode | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | Deep reasoning and debugging | Structured reasoning across large, complex codebases | Agent mode | +| Model | Task area | Excels at (primary use case) | Additional capabilities | +|-------------------------------------------------------|-----------|-------------------------------|--------------------------| +| {% data variables.copilot.copilot_gpt_41 %} | General-purpose coding and writing | Fast, accurate code completions and explanations | Agent mode, vision | +| {% data variables.copilot.copilot_gpt_4o %} | General-purpose coding and writing | Fast completions and visual input understanding | Agent mode, vision | +| {% data variables.copilot.copilot_o3 %} | Deep reasoning and debugging | Multi-step problem solving and architecture-level code analysis | Reasoning | +| {% data variables.copilot.copilot_o4_mini %} | Fast help with simple or repetitive tasks | Fast, reliable answers to lightweight coding questions | Lower latency | +| {% data variables.copilot.copilot_claude_opus_41 %} | Deep reasoning and debugging | Complex problem-solving challenges, sophisticated reasoning | Reasoning, vision | +| {% data variables.copilot.copilot_claude_opus %} | Deep reasoning and debugging | Complex problem-solving challenges, sophisticated reasoning | Reasoning, vision | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | Fast help with simple or repetitive tasks | Quick responses for code, syntax, and documentation | Agent mode, vision | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | Deep reasoning and debugging | Structured reasoning across large, complex codebases | Agent mode, vision | | {% data variables.copilot.copilot_claude_sonnet_40 %} | Deep reasoning and debugging | Performance and practicality, perfectly balanced for coding workflows | Agent mode, vision | -| {% data variables.copilot.copilot_gemini_25_pro %} | Deep reasoning and debugging | Complex code generation, debugging, and research workflows | Reasoning | -| {% data variables.copilot.copilot_gemini_flash %} | Working with visuals (diagrams, screenshots) | Real-time responses and visual reasoning for UI and diagram-based tasks | Visual | +| {% data variables.copilot.copilot_gemini_25_pro %} | Deep reasoning and debugging | Complex code generation, debugging, and research workflows | Reasoning, vision | +| {% data variables.copilot.copilot_gemini_flash %} | Working with visuals (diagrams, screenshots) | Real-time responses and visual reasoning for UI and diagram-based tasks | Vision | ## Task: General-purpose coding and writing @@ -93,13 +94,14 @@ These models are designed for tasks that require step-by-step reasoning, complex ### Recommended models -| Model | Why it's a good fit | -|-------|---------------------| -| {% data variables.copilot.copilot_o3 %} | Strong at algorithm design, system debugging, and architecture decisions. Balances performance and reasoning. | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | Provides hybrid reasoning that adapts to both fast tasks and deeper thinking. | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | Improves on 3.7 with more reliable completions and smarter reasoning under pressure. | -| {% data variables.copilot.copilot_claude_opus %} | Anthropic’s most powerful model. Strong at strategy, debugging, and multi-layered logic. | -| {% data variables.copilot.copilot_gemini_25_pro %} | Advanced reasoning across long contexts and scientific or technical analysis. | +| Model | Why it's a good fit | +|-------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| {% data variables.copilot.copilot_o3 %} | Strong at algorithm design, system debugging, and architecture decisions. Balances performance and reasoning. | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | Provides hybrid reasoning that adapts to both fast tasks and deeper thinking. | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | Improves on 3.7 with more reliable completions and smarter reasoning under pressure. | +| {% data variables.copilot.copilot_claude_opus_41 %} | Anthropic’s most powerful model. Improves on {% data variables.copilot.copilot_claude_opus %}. | +| {% data variables.copilot.copilot_claude_opus %} | Strong at strategy, debugging, and multi-layered logic. | +| {% data variables.copilot.copilot_gemini_25_pro %} | Advanced reasoning across long contexts and scientific or technical analysis. | ### When to use these models @@ -122,8 +124,11 @@ Use these models when you want to ask questions about screenshots, diagrams, UI | Model | Why it's a good fit | |-------|---------------------| -| {% data variables.copilot.copilot_gpt_4o %} | Supports image input. Great for interpreting screenshots or debugging UI issues with visual context. | +| {% data variables.copilot.copilot_gpt_41 %} | Reliable default for most coding and writing tasks. Fast, accurate, and supports multimodal input for visual reasoning tasks. Works well across languages and frameworks. | +| {% data variables.copilot.copilot_claude_opus %} | Anthropic’s most powerful model. Strong at strategy, debugging, and multi-layered logic. | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | Improves on 3.7 with more reliable completions and smarter reasoning under pressure. | | {% data variables.copilot.copilot_gemini_flash %} | Fast, multimodal model optimized for real-time interaction. Useful for feedback on diagrams, visual prototypes, and UI layouts. | +| {% data variables.copilot.copilot_gemini_25_pro %} | Deep reasoning and debugging, ideal for complex code generation, debugging, and research workflows. | ### When to use these models diff --git a/content/copilot/reference/ai-models/model-hosting.md b/content/copilot/reference/ai-models/model-hosting.md index 3536a1f0ec87..3cd72c220fd3 100644 --- a/content/copilot/reference/ai-models/model-hosting.md +++ b/content/copilot/reference/ai-models/model-hosting.md @@ -30,13 +30,14 @@ When using OpenAI's models, input requests and output responses continue to run Used for: +* {% data variables.copilot.copilot_claude_opus_41 %} * {% data variables.copilot.copilot_claude_opus %} * {% data variables.copilot.copilot_claude_sonnet_35 %} * {% data variables.copilot.copilot_claude_sonnet_37 %} * {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking * {% data variables.copilot.copilot_claude_sonnet_40 %} -{% data variables.copilot.copilot_claude_opus %} and {% data variables.copilot.copilot_claude_sonnet_40 %} are hosted by Anthropic PBC and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_37 %} is hosted by Amazon Web Services, Anthropic PBC, and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_35 %} is hosted exclusively by Amazon Web Services. {% data variables.product.github %} has provider agreements in place to ensure data is not used for training. Additional details for each provider are included below: +{% data variables.copilot.copilot_claude_opus_41 %} is hosted by Anthropic PBC. {% data variables.copilot.copilot_claude_opus %} and {% data variables.copilot.copilot_claude_sonnet_40 %} are hosted by Anthropic PBC and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_37 %} is hosted by Amazon Web Services, Anthropic PBC, and Google Cloud Platform. {% data variables.copilot.copilot_claude_sonnet_35 %} is hosted exclusively by Amazon Web Services. {% data variables.product.github %} has provider agreements in place to ensure data is not used for training. Additional details for each provider are included below: * Amazon Bedrock: Amazon makes the [following data commitments](https://docs.aws.amazon.com/bedrock/latest/userguide/data-protection.html): _Amazon Bedrock doesn't store or log your prompts and completions. Amazon Bedrock doesn't use your prompts and completions to train any AWS models and doesn't distribute them to third parties_. * Anthropic PBC: {% data variables.product.github %} maintains a [zero data retention agreement](https://privacy.anthropic.com/en/articles/8956058-i-have-a-zero-retention-agreement-with-anthropic-what-products-does-it-apply-to) with Anthropic. diff --git a/content/copilot/reference/ai-models/supported-models.md b/content/copilot/reference/ai-models/supported-models.md index f8fd4f0b4209..c3bbd117cab9 100644 --- a/content/copilot/reference/ai-models/supported-models.md +++ b/content/copilot/reference/ai-models/supported-models.md @@ -35,19 +35,20 @@ This table lists the AI models available in {% data variables.product.prodname_c {% rowheaders %} -| Model name | Provider | Release status | Agent mode | Ask mode | Edit mode | -|------------|----------|----------------|------------|----------------------|---------------| -| {% data variables.copilot.copilot_gpt_41 %} | OpenAI | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gpt_4o %} | OpenAI | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_o3 %} | OpenAI | {% data variables.release-phases.public_preview_caps %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_o4_mini %} | OpenAI | {% data variables.release-phases.public_preview_caps %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_opus %} | Anthropic | GA | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| Model name | Provider | Release status | Agent mode | Ask mode | Edit mode | +|----------------------------------------------------------------|----------|--------------|------------|----------------------|---------------| +| {% data variables.copilot.copilot_gpt_41 %} | OpenAI | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gpt_4o %} | OpenAI | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_o3 %} | OpenAI | {% data variables.release-phases.public_preview_caps %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_o4_mini %} | OpenAI | {% data variables.release-phases.public_preview_caps %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_opus_41 %} | Anthropic | {% data variables.release-phases.public_preview_caps %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_opus %} | Anthropic | GA | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | Anthropic | GA | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_25_pro %} | Google | {% data variables.release-phases.public_preview_caps %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_flash %} | Google | GA | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | Anthropic | GA | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_25_pro %} | Google | {% data variables.release-phases.public_preview_caps %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_flash %} | Google | GA | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% endrowheaders %} @@ -57,19 +58,20 @@ The following table shows which models are available in each client. {% rowheaders %} -| Model | {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_vscode %} | {% data variables.product.prodname_vs %} | Eclipse | Xcode | JetBrains IDEs | -|---------------------------|------------|---------|----------------|---------|--------|------------| -| {% data variables.copilot.copilot_gpt_41 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gpt_4o %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_o3 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_o4_mini %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_opus %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} |{% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_25_pro %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_flash %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| Model | {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_vscode %} | {% data variables.product.prodname_vs %} | Eclipse | Xcode | JetBrains IDEs | +|----------------------------------------------------------------|------------|---------|---------------------------------------------|---------------------------------------------|---------------------------------------------|---------------------------------------------| +| {% data variables.copilot.copilot_gpt_41 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gpt_4o %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_o3 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_o4_mini %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_opus_41 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | +| {% data variables.copilot.copilot_claude_opus %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_25_pro %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_flash %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% endrowheaders %} @@ -87,19 +89,20 @@ For more information about premium requests, see [AUTOTITLE](/copilot/managing-c {% rowheaders %} -| Model | Multiplier for **paid plans** | Multiplier for **{% data variables.copilot.copilot_free_short %}** | -|-------|-------------------------------|-------------------------------------------------| -| {% data variables.copilot.copilot_gpt_41 %} | 0 | 1 | -| {% data variables.copilot.copilot_gpt_4o %} | 0 | 1 | -| {% data variables.copilot.copilot_o3 %} | 1 | Not applicable | -| {% data variables.copilot.copilot_o4_mini %} | 0.33 | Not applicable | -| {% data variables.copilot.copilot_claude_opus %} | 10 | Not applicable | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | 1 | 1 | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | 1 | Not applicable | +| Model | Multiplier for **paid plans** | Multiplier for **{% data variables.copilot.copilot_free_short %}** | +|----------------------------------------------------------------|-------------------------------|-------------------------------------------------| +| {% data variables.copilot.copilot_gpt_41 %} | 0 | 1 | +| {% data variables.copilot.copilot_gpt_4o %} | 0 | 1 | +| {% data variables.copilot.copilot_o3 %} | 1 | Not applicable | +| {% data variables.copilot.copilot_o4_mini %} | 0.33 | Not applicable | +| {% data variables.copilot.copilot_claude_opus_41 %} | 10 | Not applicable | +| {% data variables.copilot.copilot_claude_opus %} | 10 | Not applicable | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | 1 | 1 | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | 1 | Not applicable | | {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | 1.25 | Not applicable | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | 1 | Not applicable | -| {% data variables.copilot.copilot_gemini_25_pro %} | 1 | Not applicable | -| {% data variables.copilot.copilot_gemini_flash %} | 0.25 | 1 | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | 1 | Not applicable | +| {% data variables.copilot.copilot_gemini_25_pro %} | 1 | Not applicable | +| {% data variables.copilot.copilot_gemini_flash %} | 0.25 | 1 | {% endrowheaders %} diff --git a/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams.md b/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams.md new file mode 100644 index 000000000000..4a8f2cb18431 --- /dev/null +++ b/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/creating-diagrams.md @@ -0,0 +1,64 @@ +--- +title: Creating diagrams +shortTitle: Create diagrams +intro: GitHub Copilot Chat can help you create diagrams to better understand your data and communicate insights. +versions: + feature: copilot +complexity: + - Simple +octicon: copilot +topics: + - Copilot +contentType: tutorials +--- + +{% data variables.copilot.copilot_chat %} can help you create mermaid diagrams to visualize data, making it easier to understand and communicate insights. You can ask {% data variables.copilot.copilot_chat_short %} to generate diagrams based on your data or code, and it will provide you with the necessary code to create those diagrams. + +## Example scenario + +You want to create a Gantt chart to visualize the timeline of a project. You can ask {% data variables.copilot.copilot_chat_short %} to generate the mermaid code for the Gantt chart, with specific details about the project phases and their durations. You can then use this code in any Markdown file that supports mermaid syntax, such as issues, discussions, or pull requests on {% data variables.product.github %}. + +## Example prompt + +`Create a mermaid gantt diagram that covers the period August 1st 2025 until January 31st, 2025. Include 5 phases, each taking 6 weeks, and overlapping equally.` + +## Example response + +{% data reusables.copilot.example-prompts.response-is-an-example %} + +{% data variables.product.prodname_copilot_short %} will provide you with the mermaid code to create the flowchart. You can copy the code {% data variables.copilot.copilot_chat_short %} provides and paste it anywhere on {% data variables.product.github %} that supports Markdown, such as an issue or discussion. + +Ensure you include the correct mermaid syntax of `` ```mermaid `` before and `` ``` `` after the code block to render the diagram correctly. + +````text +```mermaid +gantt + title Project Timeline: Aug 2025 - Jan 2026 + dateFormat YYYY-MM-DD + axisFormat %b %d + + section Phase 1 + Phase 1 :a1, 2025-08-01, 42d + + section Phase 2 + Phase 2 :a2, 2025-09-07, 42d + + section Phase 3 + Phase 3 :a3, 2025-10-13, 42d + + section Phase 4 + Phase 4 :a4, 2025-11-18, 42d + + section Phase 5 + Phase 5 :a5, 2025-12-24, 42d +``` +```` + +This Mermaid code would generate the following diagram: + +![Screenshot of a rendered Mermaid gantt chart.](/assets/images/help/copilot/mermaid-gantt-chart-example.png) + +## Further reading + +* [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/) +* [GitHub Copilot Chat documentation](/copilot/how-tos/use-chat) diff --git a/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/index.md b/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/index.md new file mode 100644 index 000000000000..1803c6b02b3d --- /dev/null +++ b/content/copilot/tutorials/copilot-chat-cookbook/communicate-effectively/index.md @@ -0,0 +1,11 @@ +--- +title: Communicate effectively +intro: 'Discover ways that you can use {% data variables.product.prodname_copilot %} to communicate effectively with your team and stakeholders.' +versions: + feature: copilot +topics: + - Copilot +children: + - /creating-diagrams +contentType: tutorials +--- diff --git a/content/copilot/tutorials/copilot-chat-cookbook/index.md b/content/copilot/tutorials/copilot-chat-cookbook/index.md index b6627efbeb02..3172c118adee 100644 --- a/content/copilot/tutorials/copilot-chat-cookbook/index.md +++ b/content/copilot/tutorials/copilot-chat-cookbook/index.md @@ -21,6 +21,7 @@ spotlight: - article: /debug-errors/debug-invalid-json image: /assets/images/copilot-landing/debugging_invalid_json.png children: + - /communicate-effectively - /debug-errors - /analyze-functionality - /refactor-code diff --git a/content/index.md b/content/index.md index cc7640f0ab11..312655e45239 100644 --- a/content/index.md +++ b/content/index.md @@ -53,6 +53,7 @@ children: - get-started - enterprise-onboarding - account-and-profile + - subscriptions-and-notifications - authentication - repositories - admin @@ -92,6 +93,7 @@ childGroups: - get-started - migrations - account-and-profile + - subscriptions-and-notifications - authentication - billing - site-policy diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md b/content/subscriptions-and-notifications/concepts/about-notifications.md similarity index 97% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md rename to content/subscriptions-and-notifications/concepts/about-notifications.md index 80135dd6f582..8a97b5297002 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications.md +++ b/content/subscriptions-and-notifications/concepts/about-notifications.md @@ -7,6 +7,8 @@ redirect_from: - /github/managing-subscriptions-and-notifications-on-github/about-notifications-beta - /github/managing-subscriptions-and-notifications-on-github/about-notifications - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications + - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications + - /subscriptions-and-notifications/setting-up-notifications/about-notifications versions: fpt: '*' ghes: '*' diff --git a/content/subscriptions-and-notifications/concepts/index.md b/content/subscriptions-and-notifications/concepts/index.md new file mode 100644 index 000000000000..3a8f71d5b2b6 --- /dev/null +++ b/content/subscriptions-and-notifications/concepts/index.md @@ -0,0 +1,14 @@ +--- +title: Concepts for your GitHub notifications +shortTitle: Concepts +intro: 'Learn the core concepts for your {% data variables.product.github %} notifications and subscriptions.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Notifications +children: + - /about-notifications +--- + diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/content/subscriptions-and-notifications/get-started/configuring-notifications.md similarity index 99% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md rename to content/subscriptions-and-notifications/get-started/configuring-notifications.md index 83e451003d5e..48020aeffa7e 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/content/subscriptions-and-notifications/get-started/configuring-notifications.md @@ -15,6 +15,8 @@ redirect_from: - /articles/choosing-the-types-of-notifications-you-receive - /github/managing-subscriptions-and-notifications-on-github/configuring-notifications - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications + - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications + - /subscriptions-and-notifications/setting-up-notifications/configuring-notifications versions: fpt: '*' ghes: '*' diff --git a/content/subscriptions-and-notifications/get-started/index.md b/content/subscriptions-and-notifications/get-started/index.md new file mode 100644 index 000000000000..7d5350d362ba --- /dev/null +++ b/content/subscriptions-and-notifications/get-started/index.md @@ -0,0 +1,16 @@ +--- +title: Get started with your GitHub subscriptions and notifications +shortTitle: Get started +intro: 'Learn about configuring your {% data variables.product.github %} notifications and subscriptions.' +redirect_from: + - /articles/getting-started-with-notifications + - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications + - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications + - /subscriptions-and-notifications/setting-up-notifications +versions: + fpt: '*' + ghes: '*' + ghec: '*' +children: + - /configuring-notifications +--- diff --git a/content/subscriptions-and-notifications/how-tos/index.md b/content/subscriptions-and-notifications/how-tos/index.md new file mode 100644 index 000000000000..fe3207c7b640 --- /dev/null +++ b/content/subscriptions-and-notifications/how-tos/index.md @@ -0,0 +1,13 @@ +--- +title: How-tos for your GitHub notifications +shortTitle: How-tos +intro: 'Learn how to accomplish specific tasks for your {% data variables.product.github %} notifications.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +children: + - /managing-subscriptions-for-activity-on-github + - /viewing-and-triaging-notifications +--- + diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/index.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md similarity index 69% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/index.md rename to content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md index f091a3dbabce..a85a0f95929a 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/index.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md @@ -3,6 +3,8 @@ title: Managing subscriptions for activity on GitHub intro: 'To maintain sustainable notification workflows, understand and regularly review your subscriptions.' redirect_from: - /github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github + - /account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github + - /subscriptions-and-notifications/managing-subscriptions-for-activity-on-github versions: fpt: '*' ghes: '*' @@ -14,3 +16,4 @@ children: - /managing-your-subscriptions shortTitle: Manage subscriptions --- + diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md similarity index 92% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md rename to content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md index a3f3e55c7689..cf3a2cd6eb55 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md @@ -10,9 +10,11 @@ topics: redirect_from: - /github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions - /github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions + - /account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions + - /subscriptions-and-notifications/managing-subscriptions-for-activity-on-github/managing-your-subscriptions shortTitle: Manage your subscriptions --- -To help you understand your subscriptions and decide whether to unsubscribe, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions). +To help you understand your subscriptions and decide whether to unsubscribe, see [AUTOTITLE](/subscriptions-and-notifications/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions). > [!NOTE] > Instead of unsubscribing, you have the option to ignore a repository. If you ignore a repository, you won't receive any notifications. We don't recommend ignoring repositories as you won't be notified if you're @mentioned. {% ifversion fpt or ghec %}If you're experiencing abuse and want to ignore a repository, please visit {% data variables.contact.contact_support_page %} so we can help. {% data reusables.policies.abuse %}{% endif %} diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md similarity index 96% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md rename to content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index f7de2239d04d..2308df87bc6b 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -16,6 +16,8 @@ redirect_from: - /articles/listing-the-repositories-youre-watching - /github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions - /github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions + - /account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions + - /subscriptions-and-notifications/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/index.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md similarity index 74% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/index.md rename to content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md index dfef6a9d2ed6..0e9c2e7c70cc 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/index.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md @@ -5,6 +5,8 @@ redirect_from: - /articles/managing-notifications - /articles/managing-your-notifications - /github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications + - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications + - /subscriptions-and-notifications/viewing-and-triaging-notifications versions: fpt: '*' ghes: '*' @@ -14,7 +16,6 @@ topics: children: - /managing-notifications-from-your-inbox - /triaging-a-single-notification - - /customizing-a-workflow-for-triaging-your-notifications shortTitle: Customize a workflow --- diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md similarity index 96% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md rename to content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 2783eb080458..91046bcd8014 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -1,11 +1,13 @@ --- title: Managing notifications from your inbox -intro: 'Use your inbox to quickly triage and sync your notifications across email and mobile.' +intro: Use your inbox to quickly triage and sync your notifications across email and mobile. redirect_from: - /articles/marking-notifications-as-read - /articles/saving-notifications-for-later - /github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox - /github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox + - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox + - /subscriptions-and-notifications/viewing-and-triaging-notifications/managing-notifications-from-your-inbox versions: fpt: '*' ghes: '*' diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md similarity index 91% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md rename to content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md index ac539ed2def7..e22403ef28e2 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md @@ -10,6 +10,8 @@ topics: redirect_from: - /github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification - /github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification + - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification + - /subscriptions-and-notifications/viewing-and-triaging-notifications/triaging-a-single-notification shortTitle: Triage a notification --- ## Saving a single notification diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/index.md b/content/subscriptions-and-notifications/index.md similarity index 52% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/index.md rename to content/subscriptions-and-notifications/index.md index a39e5a103ff2..97095b981c32 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/index.md +++ b/content/subscriptions-and-notifications/index.md @@ -1,11 +1,20 @@ --- -title: Managing subscriptions and notifications on GitHub +title: Subscriptions and notifications documentation intro: 'You can specify how to receive notifications, the repositories you are interested in, and the types of activity you want to hear about.' redirect_from: - /categories/76/articles - /categories/notifications - /categories/receiving-notifications-about-activity-on-github - /github/managing-subscriptions-and-notifications-on-github + - /account-and-profile/managing-subscriptions-and-notifications-on-github +layout: product-landing +featuredLinks: + startHere: + - /subscriptions-and-notifications/concepts/about-notifications + popular: + - /subscriptions-and-notifications/get-started/configuring-notifications +changelog: + label: notifications versions: fpt: '*' ghes: '*' @@ -13,8 +22,10 @@ versions: topics: - Notifications children: - - /setting-up-notifications - - /viewing-and-triaging-notifications - - /managing-subscriptions-for-activity-on-github + - /get-started + - /concepts + - /how-tos + - /tutorials shortTitle: Subscriptions & notifications --- + diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications.md b/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md similarity index 95% rename from content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications.md rename to content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md index e2987bee5c37..49fdf8b3238b 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications.md +++ b/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md @@ -10,6 +10,8 @@ topics: redirect_from: - /github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications - /github/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications + - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications + - /subscriptions-and-notifications/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications shortTitle: Triage your notifications --- ## Starting your inbox triage diff --git a/content/subscriptions-and-notifications/tutorials/index.md b/content/subscriptions-and-notifications/tutorials/index.md new file mode 100644 index 000000000000..a4653960d2e0 --- /dev/null +++ b/content/subscriptions-and-notifications/tutorials/index.md @@ -0,0 +1,13 @@ +--- +title: Tutorials for your GitHub notifications +shortTitle: Tutorials +intro: 'Build skills and knowledge about your {% data variables.product.github %} notifications.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Notifications +children: + - /customizing-a-workflow-for-triaging-your-notifications +--- diff --git a/data/reusables/accounts/alternative-authentication-note.md b/data/reusables/accounts/alternative-authentication-note.md deleted file mode 100644 index 0a11ed420bfe..000000000000 --- a/data/reusables/accounts/alternative-authentication-note.md +++ /dev/null @@ -1,2 +0,0 @@ -> [!NOTE] -> For security reasons, an authentication factor may not be available for recovery, even if you've used that authentication method with the account before. For example, SSH keys are removed from accounts after a period of inactivity and verified devices are recorded with cookies, and won't be available if your browser deletes cookies regularly. diff --git a/data/reusables/accounts/alternative-authentication.md b/data/reusables/accounts/alternative-authentication.md deleted file mode 100644 index 787ec2b36efd..000000000000 --- a/data/reusables/accounts/alternative-authentication.md +++ /dev/null @@ -1,4 +0,0 @@ -Choose a recovery verification factor. - - If you've used your current device to log into this account before and would like to use the device for verification, click **Verify with this device**. - - If you've previously set up an SSH key on this account and would like to use the SSH key for verification, click **SSH key**. - - If you've previously set up a {% data variables.product.pat_generic %} and would like to use the {% data variables.product.pat_generic %} for verification, click **{% data variables.product.pat_generic_caps %}**. diff --git a/data/reusables/accounts/support-request-recovery.md b/data/reusables/accounts/automated-recovery-review-period-notice.md similarity index 79% rename from data/reusables/accounts/support-request-recovery.md rename to data/reusables/accounts/automated-recovery-review-period-notice.md index 00be0ae3dc7e..a9b53b69de0f 100644 --- a/data/reusables/accounts/support-request-recovery.md +++ b/data/reusables/accounts/automated-recovery-review-period-notice.md @@ -1 +1 @@ -A member of {% data variables.contact.github_support %} will review your request and email you within three business days. If your request is approved, you'll receive a link to complete your account recovery process. If your request is denied, the email will include a way to contact support with any additional questions. +A member of {% data variables.contact.github_support %} will review your request and email you within three business days. If your request is approved, you'll receive a link to complete your account recovery process. If your request is denied, the email will include a way to contact support. diff --git a/data/reusables/accounts/choose-recovery-verification-factor.md b/data/reusables/accounts/choose-recovery-verification-factor.md new file mode 100644 index 000000000000..708dc8c9a127 --- /dev/null +++ b/data/reusables/accounts/choose-recovery-verification-factor.md @@ -0,0 +1,8 @@ +1. Choose a recovery verification factor. + + * If you've used your current device to log into this account before and would like to use the device for verification, click **Verify with this device**. + * If you've previously set up an SSH key on this account and would like to use the SSH key for verification, click **SSH key**. + * If you've previously set up a {% data variables.product.pat_generic %} and would like to use the {% data variables.product.pat_generic %} for verification, click **{% data variables.product.pat_generic_caps %}**. + + > [!NOTE] + > For security reasons, an authentication factor may not be available for recovery, even if you've used that authentication method with the account before. For example, SSH keys are removed from accounts after a period of inactivity. diff --git a/data/reusables/accounts/prompt-for-2fa-recovery-code.md b/data/reusables/accounts/prompt-for-2fa-recovery-code.md new file mode 100644 index 000000000000..8591c32d5d3e --- /dev/null +++ b/data/reusables/accounts/prompt-for-2fa-recovery-code.md @@ -0,0 +1,5 @@ +1. Navigate to [https://github.com/login](https://github.com/login). +1. To prompt two-factor authentication, type your username and password, then click **Sign in**. + > [!NOTE] + > If you have linked a Google account to your {% data variables.product.prodname_dotcom %} account, you can sign-in with your social login instead of using your password. +1. Under "More options", click **2FA recovery code**. diff --git a/data/reusables/accounts/start-automated-recovery-with-password.md b/data/reusables/accounts/start-automated-recovery-with-password.md new file mode 100644 index 000000000000..9780a72e8ec7 --- /dev/null +++ b/data/reusables/accounts/start-automated-recovery-with-password.md @@ -0,0 +1,6 @@ +1. Under "More options", click **Begin account or email recovery**. +1. In the modal that appears, click **I understand, get started**. +1. You may be required to verify an email address. To send an email containing a one-time password to each email address associated with your account, click **Send one-time password**. + > [!NOTE] + > The one-time password will be sent to your primary and backup email addresses. Unless you have previously chosen a specific backup email address, all verified emails are considered backup email addresses. +1. Type the one-time password from your email in the "One-time password" text field, then click **Verify email address**. diff --git a/data/reusables/accounts/start-automated-recovery-without-password.md b/data/reusables/accounts/start-automated-recovery-without-password.md new file mode 100644 index 000000000000..60a28cc13cb4 --- /dev/null +++ b/data/reusables/accounts/start-automated-recovery-without-password.md @@ -0,0 +1,2 @@ +1. You will be prompted for your 2FA credentials. Under "More options", click **Begin account or email recovery**. +1. In the modal that appears, click **I understand, get started**. diff --git a/data/reusables/accounts/unlinking-email-address.md b/data/reusables/accounts/unlinking-email-address.md index 0d6e20a1b201..b5fa0519b44a 100644 --- a/data/reusables/accounts/unlinking-email-address.md +++ b/data/reusables/accounts/unlinking-email-address.md @@ -1,8 +1,6 @@ 1. To begin unlinking, click **Start unlinking email**. 1. On the "Email unlink" screen, click **Continue**. {% data variables.product.prodname_dotcom %} will send a verification link to each email on the account. -1. In the inbox of the email account you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email." - * Optionally, to unlink multiple email accounts, in the inbox of each account you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email," then complete the following steps. - +1. In the inbox of each email account that you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email." 1. In the email, click **Unlink this email**. ![Screenshot of an email from {% data variables.product.prodname_dotcom %} to unlink an email address from a {% data variables.product.prodname_dotcom %} account. A link with the text "Unlink this email" is outlined in orange.](/assets/images/help/2fa/unlink-this-email.png) diff --git a/data/reusables/copilot/available-models-per-plan.md b/data/reusables/copilot/available-models-per-plan.md index 83c2e9e176a9..43bd48772bce 100644 --- a/data/reusables/copilot/available-models-per-plan.md +++ b/data/reusables/copilot/available-models-per-plan.md @@ -6,12 +6,13 @@ | {% data variables.copilot.copilot_gpt_4o %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.copilot.copilot_o3 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | | {% data variables.copilot.copilot_o4_mini %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_opus %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_35 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_37 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking| {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_claude_sonnet_40 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_25_pro %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | -| {% data variables.copilot.copilot_gemini_flash %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_opus_41 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_opus %} | {% octicon "x" aria-label="Not included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_35 %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_37 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_37 %} Thinking | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_claude_sonnet_40 %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_25_pro %} | {% octicon "x" aria-label="Not included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | +| {% data variables.copilot.copilot_gemini_flash %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% endrowheaders %} diff --git a/data/variables/copilot.yml b/data/variables/copilot.yml index cb74cfeebc1c..a80095ad35a7 100644 --- a/data/variables/copilot.yml +++ b/data/variables/copilot.yml @@ -102,6 +102,7 @@ copilot_claude_sonnet: 'Claude Sonnet' copilot_claude_sonnet_35: 'Claude Sonnet 3.5' copilot_claude_sonnet_37: 'Claude Sonnet 3.7' copilot_claude_sonnet_40: 'Claude Sonnet 4' +copilot_claude_opus_41: 'Claude Opus 4.1' copilot_claude_opus: 'Claude Opus 4' # Gemini: copilot_gemini: 'Gemini' diff --git a/package.json b/package.json index 01e9fcf0ec3f..a1e24880f3cb 100644 --- a/package.json +++ b/package.json @@ -76,6 +76,7 @@ "prevent-pushes-to-main": "tsx src/workflows/prevent-pushes-to-main.ts", "purge-fastly-edge-cache": "tsx src/workflows/purge-fastly-edge-cache.ts", "purge-fastly-edge-cache-per-language": "tsx src/languages/scripts/purge-fastly-edge-cache-per-language.js", + "readability-report": "tsx src/workflows/experimental/readability-report.ts", "ready-for-docs-review": "tsx src/workflows/ready-for-docs-review.ts", "release-banner": "tsx src/ghes-releases/scripts/release-banner.ts", "repo-sync": "./src/workflows/local-repo-sync.sh", diff --git a/src/audit-logs/data/fpt/organization.json b/src/audit-logs/data/fpt/organization.json index 3d7d1dd119b1..a52f0bed61f4 100644 --- a/src/audit-logs/data/fpt/organization.json +++ b/src/audit-logs/data/fpt/organization.json @@ -9313,7 +9313,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10984,7 +10984,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12070,7 +12070,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/fpt/user.json b/src/audit-logs/data/fpt/user.json index ed95e3d15a72..acdd9c866999 100644 --- a/src/audit-logs/data/fpt/user.json +++ b/src/audit-logs/data/fpt/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4768,7 +4768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5564,7 +5564,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6854,7 +6854,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6871,7 +6871,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6888,7 +6888,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6905,7 +6905,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6938,7 +6938,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7258,7 +7258,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7782,7 +7782,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -8000,7 +8000,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 9a670c764f80..1fd5168930ce 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -12644,7 +12644,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -14269,7 +14269,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -15355,7 +15355,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghec/organization.json b/src/audit-logs/data/ghec/organization.json index 3d7d1dd119b1..a52f0bed61f4 100644 --- a/src/audit-logs/data/ghec/organization.json +++ b/src/audit-logs/data/ghec/organization.json @@ -9313,7 +9313,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10984,7 +10984,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12070,7 +12070,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghec/user.json b/src/audit-logs/data/ghec/user.json index ed95e3d15a72..acdd9c866999 100644 --- a/src/audit-logs/data/ghec/user.json +++ b/src/audit-logs/data/ghec/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4768,7 +4768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5564,7 +5564,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6854,7 +6854,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6871,7 +6871,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6888,7 +6888,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6905,7 +6905,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6938,7 +6938,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7258,7 +7258,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7782,7 +7782,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -8000,7 +8000,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.14/enterprise.json b/src/audit-logs/data/ghes-3.14/enterprise.json index ab7ecb6e11d1..db31554ef139 100644 --- a/src/audit-logs/data/ghes-3.14/enterprise.json +++ b/src/audit-logs/data/ghes-3.14/enterprise.json @@ -7926,7 +7926,7 @@ "owner", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization" + "docs_reference_titles": "Converting a user into an organization" }, { "action": "org.unblock_user", @@ -8793,7 +8793,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10322,7 +10322,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -11401,7 +11401,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -13781,7 +13781,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -13798,7 +13798,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -13815,7 +13815,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -13832,7 +13832,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -13865,7 +13865,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "team.add_member", @@ -14561,7 +14561,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -15154,7 +15154,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -15464,7 +15464,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -15569,7 +15569,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.14/organization.json b/src/audit-logs/data/ghes-3.14/organization.json index ccfe25880d9d..00011b5e7e2a 100644 --- a/src/audit-logs/data/ghes-3.14/organization.json +++ b/src/audit-logs/data/ghes-3.14/organization.json @@ -8456,7 +8456,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -9985,7 +9985,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -10981,7 +10981,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghes-3.14/user.json b/src/audit-logs/data/ghes-3.14/user.json index b268db3d9966..bc6410b50862 100644 --- a/src/audit-logs/data/ghes-3.14/user.json +++ b/src/audit-logs/data/ghes-3.14/user.json @@ -3757,7 +3757,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4326,7 +4326,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5122,7 +5122,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6412,7 +6412,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6429,7 +6429,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6446,7 +6446,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6463,7 +6463,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6496,7 +6496,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -6816,7 +6816,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7340,7 +7340,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -7558,7 +7558,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -7644,7 +7644,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.15/enterprise.json b/src/audit-logs/data/ghes-3.15/enterprise.json index a683b1ed7232..4d19359238db 100644 --- a/src/audit-logs/data/ghes-3.15/enterprise.json +++ b/src/audit-logs/data/ghes-3.15/enterprise.json @@ -8009,7 +8009,7 @@ "owner", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization" + "docs_reference_titles": "Converting a user into an organization" }, { "action": "org.unblock_user", @@ -8876,7 +8876,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10521,7 +10521,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -11600,7 +11600,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -13980,7 +13980,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -13997,7 +13997,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -14014,7 +14014,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -14031,7 +14031,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -14064,7 +14064,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "team.add_member", @@ -14760,7 +14760,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -15353,7 +15353,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -15663,7 +15663,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -15768,7 +15768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.15/organization.json b/src/audit-logs/data/ghes-3.15/organization.json index 00c449f04849..c36875aa23cd 100644 --- a/src/audit-logs/data/ghes-3.15/organization.json +++ b/src/audit-logs/data/ghes-3.15/organization.json @@ -8565,7 +8565,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10210,7 +10210,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -11206,7 +11206,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghes-3.15/user.json b/src/audit-logs/data/ghes-3.15/user.json index 410467994323..2cbcf2094d7a 100644 --- a/src/audit-logs/data/ghes-3.15/user.json +++ b/src/audit-logs/data/ghes-3.15/user.json @@ -3840,7 +3840,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4525,7 +4525,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5321,7 +5321,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6611,7 +6611,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6628,7 +6628,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6645,7 +6645,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6662,7 +6662,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6695,7 +6695,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7015,7 +7015,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7539,7 +7539,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -7757,7 +7757,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -7843,7 +7843,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.16/enterprise.json b/src/audit-logs/data/ghes-3.16/enterprise.json index b53b75448a62..35e8cd2660b2 100644 --- a/src/audit-logs/data/ghes-3.16/enterprise.json +++ b/src/audit-logs/data/ghes-3.16/enterprise.json @@ -8318,7 +8318,7 @@ "owner", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization" + "docs_reference_titles": "Converting a user into an organization" }, { "action": "org.unblock_user", @@ -9231,7 +9231,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10876,7 +10876,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12005,7 +12005,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -14694,7 +14694,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -14711,7 +14711,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -14728,7 +14728,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -14745,7 +14745,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -14778,7 +14778,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "team.add_member", @@ -15474,7 +15474,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -16067,7 +16067,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -16377,7 +16377,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -16482,7 +16482,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.16/organization.json b/src/audit-logs/data/ghes-3.16/organization.json index 51e6786f04c6..980f3c1c8568 100644 --- a/src/audit-logs/data/ghes-3.16/organization.json +++ b/src/audit-logs/data/ghes-3.16/organization.json @@ -8907,7 +8907,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10578,7 +10578,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -11624,7 +11624,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghes-3.16/user.json b/src/audit-logs/data/ghes-3.16/user.json index 1b7cb6ba65a3..1e4227ef90e7 100644 --- a/src/audit-logs/data/ghes-3.16/user.json +++ b/src/audit-logs/data/ghes-3.16/user.json @@ -3994,7 +3994,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4679,7 +4679,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5475,7 +5475,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6765,7 +6765,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6782,7 +6782,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6799,7 +6799,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6816,7 +6816,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6849,7 +6849,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7169,7 +7169,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7693,7 +7693,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -7911,7 +7911,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -7997,7 +7997,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.17/enterprise.json b/src/audit-logs/data/ghes-3.17/enterprise.json index ad0527c4573e..60b4c837fe87 100644 --- a/src/audit-logs/data/ghes-3.17/enterprise.json +++ b/src/audit-logs/data/ghes-3.17/enterprise.json @@ -8562,7 +8562,7 @@ "owner", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization" + "docs_reference_titles": "Converting a user into an organization" }, { "action": "org.unblock_user", @@ -9609,7 +9609,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -11254,7 +11254,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12423,7 +12423,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -15141,7 +15141,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -15158,7 +15158,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -15175,7 +15175,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -15192,7 +15192,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -15225,7 +15225,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "team.add_member", @@ -15921,7 +15921,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -16514,7 +16514,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -16824,7 +16824,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -16929,7 +16929,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.17/organization.json b/src/audit-logs/data/ghes-3.17/organization.json index f7e2e588cff8..3fa49b147ee1 100644 --- a/src/audit-logs/data/ghes-3.17/organization.json +++ b/src/audit-logs/data/ghes-3.17/organization.json @@ -9097,7 +9097,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10768,7 +10768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -11854,7 +11854,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghes-3.17/user.json b/src/audit-logs/data/ghes-3.17/user.json index 7c7811a2d9b0..04d91d523758 100644 --- a/src/audit-logs/data/ghes-3.17/user.json +++ b/src/audit-logs/data/ghes-3.17/user.json @@ -4057,7 +4057,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4742,7 +4742,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5538,7 +5538,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6828,7 +6828,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6845,7 +6845,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6862,7 +6862,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6879,7 +6879,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6912,7 +6912,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7232,7 +7232,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7756,7 +7756,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -7974,7 +7974,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -8060,7 +8060,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.18/enterprise.json b/src/audit-logs/data/ghes-3.18/enterprise.json index addfeb691413..4e922be5859b 100644 --- a/src/audit-logs/data/ghes-3.18/enterprise.json +++ b/src/audit-logs/data/ghes-3.18/enterprise.json @@ -8611,7 +8611,7 @@ "owner", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization" + "docs_reference_titles": "Converting a user into an organization" }, { "action": "org.unblock_user", @@ -9658,7 +9658,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -11303,7 +11303,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12472,7 +12472,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -15244,7 +15244,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -15261,7 +15261,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -15278,7 +15278,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -15295,7 +15295,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -15328,7 +15328,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "team.add_member", @@ -16024,7 +16024,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -16617,7 +16617,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -16927,7 +16927,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -17032,7 +17032,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/data/ghes-3.18/organization.json b/src/audit-logs/data/ghes-3.18/organization.json index 9d15e56b3db5..bebb3845dd6b 100644 --- a/src/audit-logs/data/ghes-3.18/organization.json +++ b/src/audit-logs/data/ghes-3.18/organization.json @@ -9288,7 +9288,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -10959,7 +10959,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -12045,7 +12045,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", diff --git a/src/audit-logs/data/ghes-3.18/user.json b/src/audit-logs/data/ghes-3.18/user.json index ed95e3d15a72..acdd9c866999 100644 --- a/src/audit-logs/data/ghes-3.18/user.json +++ b/src/audit-logs/data/ghes-3.18/user.json @@ -4083,7 +4083,7 @@ "actor", "operation_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile" + "docs_reference_titles": "Personalizing your profile" }, { "action": "project.access", @@ -4768,7 +4768,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository" + "docs_reference_titles": "Inviting collaborators to a personal repository" }, { "action": "repo.add_topic", @@ -5564,7 +5564,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository" + "docs_reference_titles": "Removing a collaborator from a personal repository" }, { "action": "repo.remove_self_hosted_runner", @@ -6854,7 +6854,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.cancel", @@ -6871,7 +6871,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.create", @@ -6888,7 +6888,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.decline", @@ -6905,7 +6905,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "successor_invitation.destroy", @@ -6938,7 +6938,7 @@ "created_at", "_document_id" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/maintaining-ownership-continuity-of-your-personal-accounts-repositories" + "docs_reference_titles": "Maintaining ownership continuity of your personal account's repositories" }, { "action": "trusted_device.register", @@ -7258,7 +7258,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account" + "docs_reference_titles": "Adding an email address to your GitHub account" }, { "action": "user.async_delete", @@ -7782,7 +7782,7 @@ "operation_type", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.login", @@ -8000,7 +8000,7 @@ "created_at", "request_access_security_header" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/showing-your-private-contributions-and-achievements-on-your-profile" + "docs_reference_titles": "Showing your private contributions on your profile" }, { "action": "user.sign_in_from_unrecognized_device", @@ -8086,7 +8086,7 @@ "token_scopes", "programmatic_access_type" ], - "docs_reference_titles": "/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#setting-a-status" + "docs_reference_titles": "Personalizing your profile" }, { "action": "user.suspend", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 14229ade1cd4..8a4523252c75 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -9,5 +9,5 @@ "git": "Note: Git events have special access requirements and retention policies that differ from other audit log events. For GitHub Enterprise Cloud, access Git events via the REST API only with 7-day retention. For GitHub Enterprise Server, Git events must be enabled in audit log configuration and are not included in search results.", "sso_redirect": "Note: Automatically redirecting users to sign in is currently in beta for Enterprise Managed Users and subject to change." }, - "sha": "b74dd07094cbdc7d8bc60c1485a38c25c2eab0b0" + "sha": "cf64dc674a26e5950075b354147da9219ace667d" } \ No newline at end of file diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index d01b70cdfe89..96014071b791 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,18 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Field securityContactEmail was added to object type Enterprise

", + "

Input field securityContactEmail of type String was added to input object type UpdateEnterpriseProfileInput

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2025-08-05" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index cc19bf1aef68..6c14879ad962 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -13467,6 +13467,11 @@ type Enterprise implements Node { last: Int ): RepositoryRulesetConnection + """ + The enterprise's security contact email address. + """ + securityContactEmail: String + """ The URL-friendly identifier for the enterprise. """ @@ -64664,6 +64669,11 @@ input UpdateEnterpriseProfileInput { """ name: String + """ + The security contact email address of the enterprise. + """ + securityContactEmail: String + """ The URL of the enterprise's website. """ diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json index 5efe9e01dcd3..7a6f98472a19 100644 --- a/src/graphql/data/fpt/schema.json +++ b/src/graphql/data/fpt/schema.json @@ -22192,6 +22192,14 @@ } ] }, + { + "name": "securityContactEmail", + "description": "

The enterprise's security contact email address.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "slug", "description": "

The URL-friendly identifier for the enterprise.

", @@ -109373,6 +109381,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "securityContactEmail", + "description": "

The security contact email address of the enterprise.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "websiteUrl", "description": "

The URL of the enterprise's website.

", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index cc19bf1aef68..6c14879ad962 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -13467,6 +13467,11 @@ type Enterprise implements Node { last: Int ): RepositoryRulesetConnection + """ + The enterprise's security contact email address. + """ + securityContactEmail: String + """ The URL-friendly identifier for the enterprise. """ @@ -64664,6 +64669,11 @@ input UpdateEnterpriseProfileInput { """ name: String + """ + The security contact email address of the enterprise. + """ + securityContactEmail: String + """ The URL of the enterprise's website. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 5efe9e01dcd3..7a6f98472a19 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -22192,6 +22192,14 @@ } ] }, + { + "name": "securityContactEmail", + "description": "

The enterprise's security contact email address.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "slug", "description": "

The URL-friendly identifier for the enterprise.

", @@ -109373,6 +109381,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "securityContactEmail", + "description": "

The security contact email address of the enterprise.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, { "name": "websiteUrl", "description": "

The URL of the enterprise's website.

", diff --git a/src/links/lib/excluded-links.yml b/src/links/lib/excluded-links.yml index 78879555bdc4..ff9050b42696 100644 --- a/src/links/lib/excluded-links.yml +++ b/src/links/lib/excluded-links.yml @@ -18,6 +18,10 @@ - startsWith: https://classroom.github.com/videos - startsWith: https://developer.anthology.com/portal +# Links to github.com/github-early-access that will 404 unless you are +# an organization member. Should only be used on early-access docs. +- startsWith: https://github.com/github-early-access + # Oneoff links that link checkers think are broken but are not. - is: https://haveibeenpwned.com/ - is: https://www.ilo.org/dyn/normlex/en/f?p=NORMLEXPUB:12100:0::NO::P12100_ILO_CODE:P029 diff --git a/src/rest/components/RestCodeSamples.tsx b/src/rest/components/RestCodeSamples.tsx index 006b76685f8a..1ea70c440665 100644 --- a/src/rest/components/RestCodeSamples.tsx +++ b/src/rest/components/RestCodeSamples.tsx @@ -8,7 +8,7 @@ import cx from 'classnames' import hljs from 'highlight.js/lib/core' import json from 'highlight.js/lib/languages/json' import javascript from 'highlight.js/lib/languages/javascript' -import { generateExampleOptions } from '@/rest/lib/content-type-utils' +import { generateExampleOptions } from '@/rest/lib/code-example-utils' import hljsCurl from 'highlightjs-curl' import { useTranslation } from '@/languages/components/useTranslation' diff --git a/src/rest/lib/content-type-utils.ts b/src/rest/lib/code-example-utils.ts similarity index 100% rename from src/rest/lib/content-type-utils.ts rename to src/rest/lib/code-example-utils.ts diff --git a/src/rest/tests/content-type-logic.js b/src/rest/tests/code-example-logic.js similarity index 99% rename from src/rest/tests/content-type-logic.js rename to src/rest/tests/code-example-logic.js index 4577c36f66b6..e2d0b246385f 100644 --- a/src/rest/tests/content-type-logic.js +++ b/src/rest/tests/code-example-logic.js @@ -3,7 +3,7 @@ import { shouldShowRequestContentType, shouldShowResponseContentType, generateExampleOptionTexts, -} from '@/rest/lib/content-type-utils' +} from '@/rest/lib/code-example-utils' describe('Request Content Type Logic', () => { test('detects request content types differ correctly', () => { diff --git a/src/secret-scanning/data/public-docs.yml b/src/secret-scanning/data/public-docs.yml index 8524bfad125f..9e3d647dd188 100644 --- a/src/secret-scanning/data/public-docs.yml +++ b/src/secret-scanning/data/public-docs.yml @@ -117,6 +117,17 @@ hasPushProtection: true hasValidityCheck: false isduplicate: false +- provider: Akamai + supportedSecret: Akamai API Credentials + secretType: akamai_api_credentials + versions: + fpt: '*' + ghec: '*' + isPublic: false + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + isduplicate: false - provider: Alibaba supportedSecret: Alibaba Cloud AccessKey ID secretType: alibaba_cloud_access_key_id
alibaba_cloud_access_key_secret @@ -1620,7 +1631,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: false - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Cohere supportedSecret: Cohere API Key @@ -2250,7 +2261,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: true - provider: GitHub supportedSecret: GitHub App Installation Access Token @@ -2494,7 +2505,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Grafana supportedSecret: Grafana Project API Key @@ -2758,7 +2769,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Intercom supportedSecret: Intercom Access Token @@ -4146,7 +4157,7 @@ isPublic: true isPrivateWithGhas: true hasPushProtection: true - hasValidityCheck: false + hasValidityCheck: '{% ifversion fpt or ghes %}false{% else %}true{% endif %}' isduplicate: false - provider: Salesforce supportedSecret: Salesforce OAuth2 Consumer Key diff --git a/src/secret-scanning/lib/config.json b/src/secret-scanning/lib/config.json index 17764fcb9568..0a3891776603 100644 --- a/src/secret-scanning/lib/config.json +++ b/src/secret-scanning/lib/config.json @@ -1,5 +1,5 @@ { - "sha": "01299c0adaae7096ec8fae216614337d502a4613", - "blob-sha": "a4039b2ae13a43e5737fc1e789713a0ebc2ea4c6", + "sha": "1a082834369ed04963911ef06c4a0de0cf1755a0", + "blob-sha": "70a236d2f851f211cfff51c0976d31a48677503c", "targetFilename": "code-security/secret-scanning/introduction/supported-secret-scanning-patterns" } \ No newline at end of file diff --git a/src/workflows/experimental/readability-report.ts b/src/workflows/experimental/readability-report.ts new file mode 100644 index 000000000000..8052748c26dc --- /dev/null +++ b/src/workflows/experimental/readability-report.ts @@ -0,0 +1,637 @@ +/** + * Readability Analysis Script + * + * This script analyzes the readability of rendered documentation content using standard + * readability metrics. It has a dual purpose: + * + * 1. **GitHub Actions Workflow**: Automatically runs on pull requests to analyze changed + * content files and post readability reports as PR comments. + * + * 2. **Local Development Tool**: Can be run locally by writers to test readability + * of specific files during content creation and editing. + * + * WORKFLOW USAGE: + * - Triggered automatically on PRs with content changes + * - Uses CHANGED_FILES environment variable from get-changed-files action + * - Outputs report to console and saves to readability-report.md for PR commenting + * - Requires local server to be running to analyze rendered content + * + * LOCAL USAGE: + * 1. Start local development server: `npm start` + * 2. Run analysis on specific files: + * - Single file: `npm run readability-report -- --paths content/file.md` + * - Multiple files: `npm run readability-report -- --paths content/file1.md content/file2.md` + * - Get help: `npm run readability-report -- --help` + * + * FEATURES: + * - Analyzes rendered content (not raw Markdown) to account for Liquid templating + * - Calculates multiple readability metrics (Flesch Reading Ease, Gunning Fog, FORCAST, etc.) + * - Provides detailed reports with improvement recommendations + * - Filters out code blocks and non-prose elements for accurate analysis + * + * REQUIREMENTS: + * - Local server running on localhost:4000 + * - Content files must be in content/ directory + * - Files must be accessible via rendered site URLs + */ + +import fs from 'fs' +import path from 'path' + +import cheerio from 'cheerio' +import got from 'got' + +interface ReadabilityMetrics { + fleschReadingEase: number + fleschKincaidGrade: number + gunningFog: number + colemanLiau: number + automatedReadabilityIndex: number + smogIndex: number + forcastGrade: number +} + +interface PageReadability { + path: string + url: string + title: string + metrics: ReadabilityMetrics + wordCount: number + sentenceCount: number + estimatedReadingTime: string +} + +async function main() { + // Check for help flag + const args = process.argv.slice(2) + if (args.includes('--help') || args.includes('-h')) { + console.log(` +Usage: npm run readability-report [-- --paths ...] + +Examples: + # Analyze specific files + npm run readability-report -- --paths content/copilot/using-github-copilot.md content/get-started/quickstart.md + + # Analyze a single file + npm run readability-report -- --paths content/copilot/using-github-copilot.md + + # Use environment variable (for CI) + CHANGED_FILES="content/file1.md content/file2.md" npm run readability-report + +Note: Requires a local server running on localhost:4000 (npm start) +`) + return + } + + console.log('Starting readability analysis...') + + // Get changed content files from environment variable or command line arguments + const changedFiles = getChangedContentFiles() + + if (changedFiles.length === 0) { + console.log('No content files to analyze. Use --help for usage information.') + return + } + + console.log(`Analyzing readability for ${changedFiles.length} changed files:`) + changedFiles.forEach((file) => console.log(` - ${file}`)) + + // Wait for server to be ready + await waitForServer() + + // Analyze each changed file + const results: PageReadability[] = [] + + for (const filePath of changedFiles) { + try { + const result = await analyzeFile(filePath) + if (result) { + results.push(result) + console.log(`✓ Analyzed: ${result.path}`) + } + } catch (error) { + console.error(`✗ Failed to analyze ${filePath}:`, (error as Error).message) + } + } + + // Generate and output report + const report = generateReport(results) + + // Always output to console for local development + console.log('\n' + report) + + // If running in CI, also save report for commenting on PR + if (process.env.GITHUB_ACTIONS) { + fs.writeFileSync('readability-report.md', report) + console.log('\nReport saved to readability-report.md') + } +} + +function getChangedContentFiles(): string[] { + // Check for command line arguments first + const args = process.argv.slice(2) + const pathsIndex = args.indexOf('--paths') + + if (pathsIndex !== -1 && pathsIndex + 1 < args.length) { + // Get all arguments after --paths until we hit another flag or end + const paths: string[] = [] + for (let i = pathsIndex + 1; i < args.length; i++) { + if (args[i].startsWith('--')) break + paths.push(args[i]) + } + + return paths.filter((filePath) => { + // Filter for content files only (not data files, READMEs, etc.) + return ( + filePath.endsWith('.md') && + filePath.split(path.sep)[0] === 'content' && + path.basename(filePath) !== 'README.md' + ) + }) + } + + // Fall back to environment variable (for CI) + const spaceSeparatedList = process.env.CHANGED_FILES || '' + return spaceSeparatedList.split(/\s+/g).filter((filePath) => { + // Filter for content files only (not data files, READMEs, etc.) + return ( + filePath.endsWith('.md') && + filePath.split(path.sep)[0] === 'content' && + path.basename(filePath) !== 'README.md' + ) + }) +} + +function makeURL(path: string): string { + return `http://localhost:4000${path}` +} + +async function waitForServer(): Promise { + console.log('Waiting for server to be ready...') + + const maxAttempts = 30 + const delayMs = 2000 + + for (let attempt = 1; attempt <= maxAttempts; attempt++) { + try { + await got(makeURL('/'), { timeout: { request: 5000 } }) + console.log('Server is ready!') + return + } catch (error) { + if (attempt === maxAttempts) { + console.error('Server failed to start. Last error:', (error as Error).message) + throw new Error(`Server failed to start after ${maxAttempts} attempts`) + } + console.log( + `Attempt ${attempt}/${maxAttempts} failed (${(error as Error).message}), retrying in ${delayMs}ms...`, + ) + await new Promise((resolve) => setTimeout(resolve, delayMs)) + } + } +} + +async function analyzeFile(filePath: string): Promise { + // Convert file path to URL path + // content/get-started/foo.md -> /get-started/foo + const urlPath = + '/' + + filePath + .replace(/^content\//, '') + .replace(/\.md$/, '') + .replace(/\/index$/, '') + + try { + // Fetch the rendered page + const response = await got(makeURL(urlPath), { + timeout: { request: 30000 }, + throwHttpErrors: false, + }) + + if (response.statusCode !== 200) { + console.warn(`Skipping ${urlPath}: HTTP ${response.statusCode}`) + return null + } + + // Parse HTML and extract content + const $ = cheerio.load(response.body) + + // Get page title + const title = $('h1').first().text().trim() || $('title').text().trim() || 'Untitled' + + // Extract main content text (excluding navigation, sidebars, etc.) + // Focus on the main article content with more specific selectors + const contentSelectors = [ + 'article .markdown-body', // Most specific - article content in docs + '.markdown-body', // GitHub markdown content + 'article', // Generic article + 'main', // Main content area + '[data-testid="lead"]', // Lead content + '#article-contents', // Fallback + ] + + let contentText = '' + for (const selector of contentSelectors) { + const element = $(selector) + if (element.length > 0) { + // Remove code blocks and other non-prose elements + element.find('pre, code, .highlight').remove() + element.find('nav, .breadcrumb, .pagination').remove() + element.find('[data-testid="breadcrumbs"]').remove() + element.find('.js-search-results').remove() + element.find('aside, .sidebar').remove() + element.find('.edit-this-page').remove() + + // Get the text content directly, which preserves natural spacing + contentText = element.text() + + // Clean up the text to remove excessive whitespace + contentText = contentText + .replace(/\s+/g, ' ') // Replace multiple whitespace with single space + .trim() + + break + } + } + + if (!contentText.trim()) { + console.warn(`No content found for ${urlPath}`) + return null + } + + // Calculate readability metrics + const metrics = await calculateReadability(contentText) + + // Calculate estimated reading time based on word count and complexity + const estimatedReadingTime = estimateReadingTime( + countWords(contentText), + metrics.fleschReadingEase, + ) + + return { + path: filePath, + url: urlPath, + title, + metrics, + wordCount: countWords(contentText), + sentenceCount: countSentences(contentText), + estimatedReadingTime, + } + } catch (error) { + throw new Error(`Failed to analyze ${urlPath}: ${(error as Error).message}`) + } +} + +async function calculateReadability(text: string): Promise { + // Direct implementation of readability formulas + const words = countWords(text) + const sentences = countSentences(text) + const syllables = countSyllables(text) + const complexWords = countComplexWords(text) + const singleSyllableWords = countSingleSyllableWords(text) + + if (sentences === 0 || words === 0) { + return { + fleschReadingEase: 0, + fleschKincaidGrade: 0, + gunningFog: 0, + colemanLiau: 0, + automatedReadabilityIndex: 0, + smogIndex: 0, + forcastGrade: 0, + } + } + + // Flesch Reading Ease: 206.835 - (1.015 × ASL) - (84.6 × ASW) + const avgSentenceLength = words / sentences + const avgSyllablesPerWord = syllables / words + const fleschReadingEase = Math.max( + 0, + 206.835 - 1.015 * avgSentenceLength - 84.6 * avgSyllablesPerWord, + ) + + // Flesch-Kincaid Grade Level: (0.39 × ASL) + (11.8 × ASW) - 15.59 + const fleschKincaidGrade = 0.39 * avgSentenceLength + 11.8 * avgSyllablesPerWord - 15.59 + + // Gunning Fog Index: 0.4 × (ASL + percentage of complex words) + const complexWordPercentage = (complexWords / words) * 100 + const gunningFog = 0.4 * (avgSentenceLength + complexWordPercentage) + + // Coleman-Liau Index: 0.0588 × L - 0.296 × S - 15.8 + const avgCharsPer100Words = (text.replace(/\s/g, '').length / words) * 100 + const avgSentencesPer100Words = (sentences / words) * 100 + const colemanLiau = 0.0588 * avgCharsPer100Words - 0.296 * avgSentencesPer100Words - 15.8 + + // Automated Readability Index: 4.71 × (characters/words) + 0.5 × (words/sentences) - 21.43 + const avgCharsPerWord = text.replace(/\s/g, '').length / words + const automatedReadabilityIndex = 4.71 * avgCharsPerWord + 0.5 * avgSentenceLength - 21.43 + + // SMOG Index: approximately 1.0430 × sqrt(complex words × 30/sentences) + 3.1291 + const smogIndex = 1.043 * Math.sqrt((complexWords * 30) / sentences) + 3.1291 + + // FORCAST Grade Level: 20 - (N / 10), where N = single-syllable words per 150 words + // Scale to 150-word sample proportion + const singleSyllablePer150Words = (singleSyllableWords / words) * 150 + const forcastGrade = Math.max(5, 20 - singleSyllablePer150Words / 10) // Can't go below 5th grade + + return { + fleschReadingEase: Math.round(fleschReadingEase * 100) / 100, + fleschKincaidGrade: Math.max(0, Math.round(fleschKincaidGrade * 100) / 100), + gunningFog: Math.max(0, Math.round(gunningFog * 100) / 100), + colemanLiau: Math.max(0, Math.round(colemanLiau * 100) / 100), + automatedReadabilityIndex: Math.max(0, Math.round(automatedReadabilityIndex * 100) / 100), + smogIndex: Math.max(0, Math.round(smogIndex * 100) / 100), + forcastGrade: Math.max(5, Math.round(forcastGrade * 100) / 100), + } +} + +function countSyllablesInWord(word: string): number { + // Remove non-alphabetic characters + const cleanWord = word.toLowerCase().replace(/[^a-z]/g, '') + if (cleanWord.length === 0) return 0 + + // Count vowel groups + const vowelGroups = cleanWord.match(/[aeiouy]+/g) || [] + let syllables = vowelGroups.length + + // Subtract silent 'e' at end + if (cleanWord.endsWith('e') && syllables > 1) { + syllables -= 1 + } + + // Ensure at least 1 syllable per word + return Math.max(1, syllables) +} + +function countWords(text: string): number { + // Clean the text and split into words + const cleanText = text + .replace(/\s+/g, ' ') // Replace multiple whitespace with single space + .trim() + + if (!cleanText) return 0 + + // Split on whitespace and filter out empty strings + const words = cleanText.split(/\s+/).filter((word) => { + // Remove punctuation and check if there are actual letters/numbers + const cleanWord = word.replace(/[^\w]/g, '') + return cleanWord.length > 0 + }) + + return words.length +} + +function countSentences(text: string): number { + // Clean and normalize the text first + const cleanText = text + .replace(/\s+/g, ' ') // Replace multiple whitespace with single space + .trim() + + // Split on sentence-ending punctuation, being more conservative + // Only count actual sentence-ending punctuation, not structural breaks + const sentences = cleanText + .split(/[.!?]+(?=\s|$)/) // Only split on punctuation followed by space or end + .map((s) => s.trim()) + .filter((s) => s.length > 0) + + return Math.max(1, sentences.length) +} + +function countSyllables(text: string): number { + // Simple syllable counting approximation + const words = text.toLowerCase().split(/\s+/) + let syllableCount = 0 + + for (const word of words) { + if (word.length === 0) continue + syllableCount += countSyllablesInWord(word) + } + + return syllableCount +} + +function countSingleSyllableWords(text: string): number { + // Count words with exactly 1 syllable + const words = text.toLowerCase().split(/\s+/) + let singleSyllableCount = 0 + + for (const word of words) { + if (word.length === 0) continue + + const syllables = countSyllablesInWord(word) + if (syllables === 1) { + singleSyllableCount += 1 + } + } + + return singleSyllableCount +} + +function countComplexWords(text: string): number { + // Count words with 3+ syllables (approximation) + const words = text.toLowerCase().split(/\s+/) + let complexCount = 0 + + for (const word of words) { + if (word.length === 0) continue + + const syllables = countSyllablesInWord(word) + if (syllables >= 3) { + complexCount += 1 + } + } + + return complexCount +} + +function estimateReadingTime(wordCount: number, fleschReadingEase: number): string { + // Base reading speed in words per minute (WPM) + // Average adult reading speed is around 200-250 WPM for normal text + let baseWPM = 200 + + // Adjust reading speed based on text complexity (Flesch Reading Ease score) + // Higher scores = easier text = faster reading + // Lower scores = harder text = slower reading + if (fleschReadingEase >= 90) { + baseWPM = 250 // Very easy - fast reading + } else if (fleschReadingEase >= 80) { + baseWPM = 230 // Easy - slightly faster + } else if (fleschReadingEase >= 70) { + baseWPM = 210 // Fairly easy - normal speed + } else if (fleschReadingEase >= 60) { + baseWPM = 200 // Standard - average speed + } else if (fleschReadingEase >= 50) { + baseWPM = 180 // Fairly difficult - slower + } else if (fleschReadingEase >= 30) { + baseWPM = 160 // Difficult - much slower + } else { + baseWPM = 140 // Very difficult - very slow + } + + // Calculate reading time in minutes + const readingTimeMinutes = wordCount / baseWPM + + // Format the output + if (readingTimeMinutes < 1) { + return '< 1 min' + } else if (readingTimeMinutes < 60) { + return `${Math.round(readingTimeMinutes)} min` + } else { + const hours = Math.floor(readingTimeMinutes / 60) + const minutes = Math.round(readingTimeMinutes % 60) + return minutes > 0 ? `${hours}h ${minutes}m` : `${hours}h` + } +} + +function generateReport(results: PageReadability[]): string { + if (results.length === 0) { + return '## 📊 Readability Report\n\nNo content changes found to analyze.' + } + + let report = '## 📊 Readability Report\n\n' + report += `Analyzed ${results.length} changed documentation page${results.length === 1 ? '' : 's'}.\n\n` + + // Summary table + report += '### Summary\n\n' + report += '| Page | Flesch Reading Ease | Grade Level | Reading Time | Words |\n' + report += '|------|:-------------------:|:-----------:|:------------:|:-----:|\n' + + for (const result of results) { + const grade = result.metrics.fleschKincaidGrade + const ease = result.metrics.fleschReadingEase + const readingTime = result.estimatedReadingTime + + // Determine readability assessment + let easeAssessment = '❓' + if (ease >= 60) easeAssessment = '🟢' + else if (ease >= 30) easeAssessment = '🟡' + else easeAssessment = '🔴' + + report += `| [${result.title}](${result.url}) | ${ease} ${easeAssessment} | ${grade} | ${readingTime} | ${result.wordCount} |\n` + } + + // Detailed metrics + report += '\n### Detailed Metrics\n\n' + + for (const result of results) { + report += `#### ${result.title}\n\n` + report += `**File:** \`${result.path}\` \n` + report += `**URL:** ${result.url} \n` + report += `**Words:** ${result.wordCount} | **Sentences:** ${result.sentenceCount} | **Est. Reading Time:** ${result.estimatedReadingTime}\n\n` + + report += '| Metric | Score | Target | Assessment |\n' + report += '|--------|:-----:|:------:|:----------:|\n' + + const metrics = [ + { + name: 'Flesch Reading Ease', + score: result.metrics.fleschReadingEase, + target: '60+', + assessment: + result.metrics.fleschReadingEase >= 60 + ? '🟢 Good' + : result.metrics.fleschReadingEase >= 30 + ? '🟡 Fair' + : '🔴 Difficult', + }, + { + name: 'Flesch-Kincaid Grade', + score: result.metrics.fleschKincaidGrade, + target: '8 or less', + assessment: + result.metrics.fleschKincaidGrade <= 8 + ? '🟢 Good' + : result.metrics.fleschKincaidGrade <= 12 + ? '🟡 Fair' + : '🔴 High', + }, + { + name: 'Gunning Fog Index', + score: result.metrics.gunningFog, + target: '8 or less', + assessment: + result.metrics.gunningFog <= 8 + ? '🟢 Good' + : result.metrics.gunningFog <= 12 + ? '🟡 Fair' + : '🔴 High', + }, + { + name: 'Coleman-Liau Index', + score: result.metrics.colemanLiau, + target: '8 or less', + assessment: + result.metrics.colemanLiau <= 8 + ? '🟢 Good' + : result.metrics.colemanLiau <= 12 + ? '🟡 Fair' + : '🔴 High', + }, + { + name: 'Automated Readability Index', + score: result.metrics.automatedReadabilityIndex, + target: '8 or less', + assessment: + result.metrics.automatedReadabilityIndex <= 8 + ? '🟢 Good' + : result.metrics.automatedReadabilityIndex <= 12 + ? '🟡 Fair' + : '🔴 High', + }, + { + name: 'FORCAST Grade Level', + score: result.metrics.forcastGrade, + target: '9-10', + assessment: + result.metrics.forcastGrade <= 10 + ? '🟢 Good' + : result.metrics.forcastGrade <= 12 + ? '🟡 Fair' + : '🔴 High', + }, + ] + + for (const metric of metrics) { + report += `| ${metric.name} | ${metric.score} | ${metric.target} | ${metric.assessment} |\n` + } + + report += '\n' + } + + // Guidelines + report += '### 📖 Readability Guidelines\n\n' + report += '**Target Audience:** Technical users (developers, administrators)\n\n' + report += '**Reading Time Estimation:**\n' + report += '- Based on complexity-adjusted reading speed (140-250 WPM)\n' + report += '- Easier content (higher Flesch scores) = faster reading\n' + report += '- More complex content = slower reading pace\n\n' + report += '**General Tips for Improvement:**\n' + report += '- **Sentences:** Aim for 15-20 words per sentence on average\n' + report += '- **Word choice:** Choose simpler alternatives when possible\n' + report += '- **Paragraphs:** Keep paragraphs under 75-100 words\n' + report += + '- **Voice:** Use active voice (e.g., "Click the button" vs "The button should be clicked")\n' + report += '- **Technical terms:** Define acronyms and jargon on first use\n' + report += + '- **FORCAST improvement:** Use more single-syllable words (aim for 110+ per 150 words)\n\n' + + // Add overall recommendations based on results + const avgFleschEase = + results.reduce((sum, r) => sum + r.metrics.fleschReadingEase, 0) / results.length + + if (avgFleschEase < 60) { + if (results.length === 1) { + report += + '**Priority Focus:** This page scored below 60 for Flesch Reading Ease. Consider breaking up complex sentences and using simpler vocabulary.\n\n' + } else { + report += + '**Priority Focus:** Several pages scored below 60 for Flesch Reading Ease. Consider breaking up complex sentences and using simpler vocabulary.\n\n' + } + } + + return report +} + +main().catch((error) => { + console.error('Readability analysis failed:', error) + process.exit(1) +})