Skip to content

Repo sync #39662

New issue

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

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

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions .github/workflows/readability.yml
Original file line number Diff line number Diff line change
@@ -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: '<!-- READABILITY_REPORT -->'

- name: Read readability report
if: ${{ steps.changed_files.outputs.filtered_changed_files }}
id: read_report
run: |
if [ -f "readability-report.md" ]; then
{
echo 'report<<EOF'
cat readability-report.md
echo EOF
} >> "$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: |
<!-- READABILITY_REPORT -->
${{ 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"
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Docs changelog

**4 August 2025**

To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/en/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)".

The new guide incorporates cross-platform GitHub tools, as well as opinionated guidance from GitHub's secret scanning team, to walk the developer through a thorough remediation process.

It also clearly communicates the risks of leaked secrets, the challenges of remediation, and the value of enabling [GitHub Secret Protection](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security#github-secret-protection).

<hr>

**28 July 2025**

We have restructured the general "[Billing and payments](https://docs.github.com/en/billing)" articles to align with the Copilot and Actions docs. In addition, we've combined a few old "About" articles to directly answer common questions that new users have: [How GitHub billing works](https://docs.github.com/en/billing/get-started/how-billing-works) and [Introduction to billing and licensing](https://docs.github.com/en/billing/get-started/introduction-to-billing).
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ redirect_from:
- /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/about-your-personal-dashboard
intro: 'You can visit your personal dashboard to keep track of issues and pull requests you''re working on or following, navigate to your top repositories and team pages, stay updated on recent activities in organizations and repositories you''re subscribed to, and explore recommended repositories.'
versions:
fpt: '*'
Expand Down
13 changes: 13 additions & 0 deletions content/account-and-profile/get-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Get started with your GitHub account and profile
shortTitle: Get started
intro: 'Learn the basics of your {% data variables.product.github %} account and profile.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-your-personal-dashboard
- /personalizing-your-profile
---

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Personalizing your profile
intro: 'You can share information about yourself with other users by setting a profile picture and adding a bio to your profile.'
intro: You can share information about yourself with other users by setting a profile picture and adding a bio to your profile.
redirect_from:
- /articles/adding-a-bio-to-your-profile
- /articles/setting-your-profile-picture
Expand All @@ -10,6 +10,7 @@ redirect_from:
- /articles/personalizing-your-profile
- /github/setting-up-and-managing-your-github-profile/personalizing-your-profile
- /github/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile
- /account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile
versions:
fpt: '*'
ghes: '*'
Expand Down
13 changes: 13 additions & 0 deletions content/account-and-profile/how-tos/index.md
Original file line number Diff line number Diff line change
@@ -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
---

Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ 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: '*'
ghec: '*'
topics:
- Profiles
children:
- /personalizing-your-profile
- /managing-your-profile-readme
- /pinning-items-to-your-profile
- /setting-your-profile-to-private
- /using-your-github-profile-to-enhance-your-resume
---

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand All @@ -19,3 +20,4 @@ children:
- /managing-access-to-your-personal-repositories
- /managing-your-membership-in-organizations
---

Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: '*'
Expand Down
Loading
Loading