Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 34 additions & 12 deletions .github/workflows/content-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ jobs:
fi

- name: Run content pipeline update script
id: update
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down Expand Up @@ -133,27 +134,48 @@ jobs:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
UPDATE_BRANCH: ${{ steps.branch.outputs.update_branch }}
PIPELINE_ID: ${{ matrix.id }}
COMPARE_URL: ${{ steps.update.outputs.compare_url }}
SHORT_RANGE: ${{ steps.update.outputs.short_range }}
run: |
PR_NUMBER="${{ steps.check-pr.outputs.pr_number }}"
PR_TITLE="docs: update ${PIPELINE_ID} content from source docs"

PR_BODY="_GitHub Copilot generated this pull request._"$'\n\n'
PR_BODY+="> [!NOTE]"$'\n'
PR_BODY+="> This PR is **automatically generated** by the [content pipeline update workflow](${{ github.server_url }}/${{ github.repository }}/actions/workflows/content-pipelines.yml). Each run adds a new commit with any documentation changes detected."$'\n\n'
PR_BODY+="## What this does"$'\n\n'
PR_BODY+="Runs the \`content-pipeline-update\` agent (${PIPELINE_ID}) against the latest source docs and updates official articles under \`content/\` that have fallen out of sync."$'\n\n'
PR_BODY+="## Review"$'\n\n'
PR_BODY+="* Review each commit for accuracy — the agent uses AI, so spot-check important changes"$'\n'
PR_BODY+="* To adjust agent behavior, see [Modifying results](${{ github.server_url }}/${{ github.repository }}/blob/main/src/content-pipelines/README.md#modifying-results)"$'\n'
PR_BODY+="* Once satisfied, merge to keep docs up to date"$'\n'
PR_BODY+="* A new PR will be created on the next run if there are further changes"
NEW_ITEM="* [\`${SHORT_RANGE}\`](${COMPARE_URL})"

if [ -n "$PR_NUMBER" ]; then
echo "PR #$PR_NUMBER already exists — new commit pushed"
echo "PR #$PR_NUMBER already exists — appending source changes to body"

EXISTING_BODY=$(gh pr view "$PR_NUMBER" --json body --jq '.body')

# Append a new bullet before the SOURCE_CHANGES end marker
# Uses bash parameter expansion for safe literal string replacement
MARKER="<!-- /SOURCE_CHANGES -->"
INSERTION="${NEW_ITEM}"$'\n'
INSERTION+="${MARKER}"
UPDATED_BODY="${EXISTING_BODY/$MARKER/$INSERTION}"

gh pr edit "$PR_NUMBER" --body "$UPDATED_BODY"

echo "Ensuring PR #$PR_NUMBER is marked ready for review"
gh pr ready "$PR_NUMBER" || echo "Unable to mark PR #$PR_NUMBER as ready (it may already be ready)"
else
echo "Creating new PR"

PR_BODY="_GitHub Copilot generated this pull request._"$'\n\n'
PR_BODY+="> [!NOTE]"$'\n'
PR_BODY+="> This PR is **automatically generated** by the [content pipeline update workflow](${{ github.server_url }}/${{ github.repository }}/actions/workflows/content-pipelines.yml). Each run adds a new commit with any documentation changes detected."$'\n\n'
PR_BODY+="## What this does"$'\n\n'
PR_BODY+="Runs the \`content-pipeline-update\` agent (${PIPELINE_ID}) against the latest source docs and updates official articles under \`content/\` that have fallen out of sync."$'\n\n'
PR_BODY+="## Source changes"$'\n\n'
PR_BODY+="Changes in the source repo that triggered this update:"$'\n\n'
PR_BODY+="<!-- SOURCE_CHANGES -->"$'\n'
PR_BODY+="${NEW_ITEM}"$'\n'
PR_BODY+="<!-- /SOURCE_CHANGES -->"$'\n\n'
PR_BODY+="## Review"$'\n\n'
PR_BODY+="* Review each commit for accuracy — the agent uses AI, so spot-check important changes"$'\n'
PR_BODY+="* To adjust agent behavior, see [Modifying results](${{ github.server_url }}/${{ github.repository }}/blob/main/src/content-pipelines/README.md#modifying-results)"$'\n'
PR_BODY+="* Once satisfied, merge to keep docs up to date"$'\n'
PR_BODY+="* A new PR will be created on the next run if there are further changes"

gh pr create \
--title "$PR_TITLE" \
--body "$PR_BODY" \
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/reviewers-docs-engineering.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ on:
- 'src/**'
- '!src/**.json' # So that Docs Engineering isn't reviewing automated pipeline data PRs
- '!src/**.yml' # So that Docs Engineering isn't reviewing automated pipeline data PRs
- '!src/**.sha' # So that Docs Engineering isn't reviewing automated pipeline data PRs
- '.github/**'
- 'config/**'
- '.devcontainer/**'
Expand Down
2 changes: 2 additions & 0 deletions content/get-started/accessibility/github-command-palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
shortTitle: GitHub Command Palette
redirect_from:
- /get-started/using-github/github-command-palette
category:
- Customize your experience
---

{% data reusables.command-palette.beta-note %}
Expand Down
2 changes: 2 additions & 0 deletions content/get-started/accessibility/keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Customize your experience
---
## About keyboard shortcuts

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ redirect_from:
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings
shortTitle: Manage theme settings
category:
- Customize your experience
---

For choice and flexibility in how and when you use {% data variables.product.github %}, you can configure theme settings to change how {% data variables.product.github %} looks to you. You can choose from themes that are light or dark, or you can configure {% data variables.product.github %} to follow your system settings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ versions:
fpt: '*'
ghec: '*'
shortTitle: GitHub Archive program
category:
- Set up your account on GitHub
---

{% data reusables.repositories.about-github-archive-program %} For more information, see [AUTOTITLE](/repositories/archiving-a-github-repository/about-archiving-content-and-data-on-github#about-the-github-archive-program).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ versions:
fpt: '*'
ghec: '*'
shortTitle: Request account archive
category:
- Set up your account on GitHub
---

{% data variables.product.github %} stores repository and profile metadata from your personal account's activity. You can export your personal account's data through your account settings on {% data variables.product.prodname_dotcom %} or with the User Migration API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ versions:
ghec: '*'
redirect_from:
- /get-started/quickstart/contributing-to-projects
category:
- Explore and contribute
---

Contributing to a project on {% data variables.product.github %} is an essential skill for developers and collaborators working together to achieve shared goals. Whether you're fixing bugs, adding features, or improving documentation, the process of contributing ensures structured and efficient collaboration.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Contribute to open source
category:
- Explore and contribute
---

In this article, you'll learn how to contribute to an open source project by working through an example. We'll guide you through making a contribution to the `github/docs` repository: familiarizing yourself with the repository, finding an area to contribute, making and submitting a pull request, and working with maintainers to get your changes accepted.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ versions:
fpt: '*'
ghec: '*'
shortTitle: Finding open source projects
category:
- Explore and contribute
---

Open source software powers much of the technology you use daily, from the web browser on your screen to the [NASA Ingenuity helicopter that flew on Mars](https://github.com/readme/featured/nasa-ingenuity-helicopter).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Explore and contribute
---

{% data reusables.organizations.follow-organizations-beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Explore and contribute
---

## About followers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Save repositories with stars
category:
- Explore and contribute
---
You can search, sort, and filter your starred repositories and topics on your {% data variables.explore.your_stars_page %}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ intro: 'This guide will help you use {% data variables.product.prodname_copilot_
versions:
feature: copilot
shortTitle: Use Copilot to explore projects
category:
- Explore and contribute
---

In this guide, you’ll learn how to use {% data variables.copilot.copilot_chat_dotcom_short %} to understand a repository’s purpose, examine files, and dive into specific lines of code. By following these steps, you’ll gain insights into any project faster—making onboarding, code review, and project exploration easier and more efficient.
Expand Down
2 changes: 2 additions & 0 deletions content/get-started/git-basics/about-remote-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Work with Git
---
## About remote repositories

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Associate text editors
category:
- Set up Git
---

## Using {% data variables.product.prodname_vscode %} as your editor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Caching credentials
category:
- Set up Git
---

> [!TIP]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Handle line endings
category:
- Set up Git
---
## About line endings

Expand Down
2 changes: 2 additions & 0 deletions content/get-started/git-basics/git-cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ versions:
ghes: '*'
ghec: '*'
intro: This Git cheat sheet is a time saver when you forget a command or don't want to use help in the CLI.
category:
- Work with Git
---
Learning all available Git commands at once can be a daunting task. You can use [Git Cheat Sheets](https://training.github.com/) for a quick reference to frequently used commands. The "Using Git" cheat sheet is available in several languages.

Expand Down
2 changes: 2 additions & 0 deletions content/get-started/git-basics/git-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,7 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Explore and contribute
---
You can adopt the {% data variables.product.prodname_dotcom %} flow method to standardize how your team functions and collaborates on {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/get-started/using-github/github-flow).
2 changes: 2 additions & 0 deletions content/get-started/git-basics/ignoring-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Work with Git
---
## Configuring ignored files for a single repository

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Manage remote repositories
category:
- Work with Git
---
{% ifversion ghec %}

Expand Down
2 changes: 2 additions & 0 deletions content/get-started/git-basics/set-up-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Set up Git
---
## Using Git

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Set your username
category:
- Set up Git
---
## About Git usernames

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: macOS Keychain credentials
category:
- Set up Git
---

> [!NOTE]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Repeated credential prompts
category:
- Set up Git
---
Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your {% data variables.product.github %} credentials every time you pull or push a repository.

Expand Down
40 changes: 21 additions & 19 deletions content/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,31 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
layout: product-landing
layout: discovery-landing
introLinks:
quickstart: /get-started/start-your-journey
featuredLinks:
startHere:
- /get-started/start-your-journey/about-github-and-git
- /get-started/learning-about-github/githubs-plans
- /get-started/onboarding/getting-started-with-your-github-account
- /get-started/onboarding/getting-started-with-github-team
- /get-started/onboarding/getting-started-with-github-enterprise-cloud
- /get-started/onboarding/getting-started-with-github-enterprise-server
- /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github
popular:
quickstart: /get-started/start-your-journey/hello-world
overview: /get-started/start-your-journey/about-github-and-git
carousels:
recommended:
- /get-started/start-your-journey
- /get-started/learning-to-code
- /get-started/start-your-journey/creating-an-account-on-github
- /get-started/start-your-journey/hello-world
- /get-started/git-basics/set-up-git
- /get-started/using-github-docs/about-versions-of-github-docs
- /get-started/learning-about-github/github-glossary
- /get-started/accessibility/keyboard-shortcuts
guideCards:
- /get-started/learning-about-github/types-of-github-accounts
- /get-started/start-your-journey/hello-world
- /get-started/onboarding/getting-started-with-your-github-account
- /get-started/learning-about-github/githubs-plans
- /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github
- /get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github
- /get-started/using-github/troubleshooting-connectivity-problems
includedCategories:
- Set up your account on GitHub
- Explore GitHub plans and features
- Set up Git
- Work with Git
- Explore and contribute
- Write and format content
- Share and reuse content
- Learn to code
- Customize your experience
children:
- /start-your-journey
- /onboarding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ redirect_from:
- /github/getting-started-with-github/about-github-advanced-security
- /github/getting-started-with-github/learning-about-github/about-github-advanced-security
shortTitle: GitHub Advanced Security
category:
- Explore GitHub plans and features
---

## About {% data variables.product.prodname_GHAS %} {% ifversion ghas-products %}products{% endif %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ versions:
ghes: '*'
ghec: '*'
shortTitle: Access permissions
category:
- Explore GitHub plans and features
---

## About access permissions on {% data variables.product.github %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ redirect_from:
- /github/getting-started-with-github/faq-about-changes-to-githubs-plans
- /github/getting-started-with-github/learning-about-github/faq-about-changes-to-githubs-plans
shortTitle: Changes to GitHub plans
category:
- Explore GitHub plans and features
---
## What plans and pricing changes did GitHub announce on April 14?

Expand Down
2 changes: 2 additions & 0 deletions content/get-started/learning-about-github/github-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Explore GitHub plans and features
---
{% for glossary in glossaries %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ versions:
redirect_from:
- /github/getting-started-with-github/github-language-support
- /github/getting-started-with-github/learning-about-github/github-language-support
category:
- Explore GitHub plans and features
---
<!-- If you make changes to this article, also update any feature-level articles to reflect the same changes in language support. -->

Expand Down
2 changes: 2 additions & 0 deletions content/get-started/learning-about-github/githubs-plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
category:
- Explore GitHub plans and features
---
## About {% data variables.product.prodname_dotcom %}'s plans

Expand Down
Loading