Skip to content

Commit a799bfd

Browse files
authored
Merge pull request #45092 from github/repo-sync
Repo sync
2 parents fb6008d + 14f20d6 commit a799bfd

461 files changed

Lines changed: 1483 additions & 1409 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/copilot-setup-steps.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,11 @@ jobs:
5757
run: npm run build
5858

5959
# Populate Elasticsearch with fixture data so search/language tests work.
60+
# ELASTICSEARCH_URL is set inline in the run command because the
61+
# Copilot/GHAS agent runtime executes these setup steps with its own
62+
# injected environment and does not apply the workflow's `env:` blocks
63+
# (job-level or step-level). The inline assignment is part of the run
64+
# command, which the agent runs verbatim, so it is honored in both the
65+
# agent context and normal workflow_dispatch runs.
6066
- name: Index fixtures into the local Elasticsearch
61-
run: npm run index-test-fixtures
67+
run: ELASTICSEARCH_URL=http://localhost:9200/ npm run index-test-fixtures

.github/workflows/notify-release-pms.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,27 @@ on:
3636

3737
permissions:
3838
contents: read
39+
pull-requests: read
3940

4041
jobs:
4142
notify:
4243
name: Notify release PMs
4344
if: github.repository == 'github/docs-internal'
4445
runs-on: ubuntu-latest
4546
steps:
47+
- name: Get PR head branch
48+
id: pr-ref
49+
env:
50+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
51+
PR_NUMBER: ${{ inputs.pr }}
52+
run: |
53+
ref=$(gh pr view "$PR_NUMBER" --repo github/docs-internal --json headRefName --jq '.headRefName')
54+
echo "ref=$ref" >> "$GITHUB_OUTPUT"
55+
4656
- name: Checkout repository code
4757
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
58+
with:
59+
ref: ${{ steps.pr-ref.outputs.ref }}
4860

4961
- uses: ./.github/actions/node-npm-setup
5062

content/contributing/collaborating-on-github-docs/about-contributing-to-github-docs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The documentation repository is the place to discuss and collaborate on the docu
1616

1717
## Issues
1818

19-
[Issues](/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with. If an issue has a `triage` label, we haven't reviewed it yet, and you shouldn't begin work on it.
19+
[Issues](/issues/tracking-your-work-with-issues/learning-about-issues/about-issues) are used to track tasks that contributors can help with. If an issue has a `triage` label, we haven't reviewed it yet, and you shouldn't begin work on it.
2020

2121
If you've found something in the documentation content, or something about the docs.github.com website, that should be updated, search the open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you'd like to be fixed.<!-- markdownlint-disable-line search-replace -->
2222

@@ -25,9 +25,9 @@ If you've found something in the documentation content, or something about the d
2525
2626
## Pull requests
2727

28-
A [pull request](/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they're deployed to the live site within 24 hours.
28+
A [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they're deployed to the live site within 24 hours.
2929

30-
We cannot accept contributions to the [REST API reference documentation](/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository.
30+
We cannot accept contributions to the [REST API reference documentation](/rest). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository.
3131

3232
We only document {% data variables.product.prodname_dotcom %} products, features, tools, and extensions. We may mention or link to third-party tools to demonstrate how a feature works, but we do not accept pull requests to document third-party tools or integrations unless they were codeveloped with {% data variables.product.company_short %}.
3333

@@ -41,7 +41,7 @@ For content changes, make sure that you:
4141
* Review the content for technical accuracy.
4242
* Check your changes for grammar, spelling, and adherence to the [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide).
4343
* Make sure the text in your pull request will be easy to translate. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated).
44-
* Check new or updated Liquid statements to confirm that versioning is correct. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation).
44+
* Check new or updated Liquid statements to confirm that versioning is correct. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/versioning-documentation).
4545
* Check the preview of any pages you have changed. A preview is automatically generated after you submit a pull request and links are added to the pull request. The preview sometimes takes several minutes before it is ready to view. Confirm that everything is rendering as expected. Checking the preview will help you identify problems such as typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Make sure to check the rendered output for lists and tables, which can sometimes have problems that are difficult to identify in the Markdown.
4646
* If there are any failing checks in your pull request, troubleshoot them until they're all passing.
4747

content/contributing/collaborating-on-github-docs/using-git-on-github-docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ To keep your local branches in sync with their remotes and avoid merge conflicts
131131
* If a commit addresses an issue, you can reference the issue number in the commit, and a link to the commit will appear in the issue conversation timeline: "Addresses #1234 - adds steps for backing up the VM before upgrading."
132132

133133
> [!NOTE]
134-
> We generally don't close an issue via a commit. To close an issue, open a pull request and add "Closes #1234" to the description. The linked issue will be closed when the pull request is merged. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
134+
> We generally don't close an issue via a commit. To close an issue, open a pull request and add "Closes #1234" to the description. The linked issue will be closed when the pull request is merged. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue).
135135
136136
* Make commit messages clear, detailed, and imperative. For example: "Add conceptual article about 2FA," not "Add info."
137137
* Try not to leave uncommitted changes in your local branch when you finish working for the day. Get to a good stopping point and commit and push your changes so your work is backed up to the remote repository.

content/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ npm start
6060

6161
When the server is running, navigate to the problematic article on `https://localhost:4000` in your browser. The staging server will just show an "Oops" error, but the local server should show a stack trace for debugging.
6262

63-
If you see an error resembling the one below, make sure single quotes are properly escaped in the frontmatter. Also, check the formatting in `redirect_from` blocks. For more information, see [AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#escaping-single-quotes).
63+
If you see an error resembling the one below, make sure single quotes are properly escaped in the frontmatter. Also, check the formatting in `redirect_from` blocks. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#escaping-single-quotes).
6464

6565
```text
6666
error parsing file: /Users/z/git/github/docs/content/dotcom/articles/troubleshooting-custom-domains-and-github-pages.md

content/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/quickstar
1818

1919
## Working on documentation in a codespace
2020

21-
The following steps assume you have {% data variables.product.prodname_github_codespaces %} set up to edit files using {% data variables.product.prodname_vscode %} for Web. The steps are very similar if you have set a different editor. For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces).
21+
The following steps assume you have {% data variables.product.prodname_github_codespaces %} set up to edit files using {% data variables.product.prodname_vscode %} for Web. The steps are very similar if you have set a different editor. For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces).
2222

2323
1. Navigate to the open source repository for {% data variables.product.prodname_docs %}, [`github/docs`](https://github.com/github/docs).
2424
1. If you're an open source contributor, create a fork of the repository, then follow the rest of the steps in this procedure from your fork. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).

content/contributing/style-guide-and-content-model/about-combining-multiple-content-types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ Often, it's helpful to group information in context to help people complete a co
3030
## Examples of articles that combine multiple content types
3131

3232
* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)
33-
* [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
34-
* [AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)
35-
* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode)
33+
* [AUTOTITLE](/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
34+
* [AUTOTITLE](/free-pro-team@latest/billing/how-tos/manage-plan-and-licenses/upgrade-plan)
35+
* [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)

content/contributing/style-guide-and-content-model/about-the-content-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Categories are organized around a feature or a discrete set of tasks within a to
7676
* General or high-level enough to scale with future product enhancements.
7777
* Category titles must be 67 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 27 characters.
7878
* Examples
79-
* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github)
79+
* [AUTOTITLE](/account-and-profile/how-tos)
8080
* [AUTOTITLE](/pull-requests/committing-changes-to-your-project)
8181

8282
### Intros for categories
@@ -98,8 +98,8 @@ In general, avoid having a map topic within a map topic unless it is the best wa
9898
* General or high-level enough to scale with future additions to the product.
9999
* Map topic titles must be 63 characters or shorter and have a [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) less than 30 characters.
100100
* Examples
101-
* [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain)
102-
* [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise)
101+
* [AUTOTITLE](/code-security/concepts/supply-chain-security)
102+
* [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise)
103103

104104
### Intros for map topics
105105

content/contributing/style-guide-and-content-model/concepts-content-type.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Headers of conceptual sections in articles start with "About [subject]”.
4242

4343
* Conceptual articles
4444
* [About GitHub Sponsors](/free-pro-team@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)
45-
* [About Enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)
45+
* [About Enterprise accounts](/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/enterprise-accounts)
4646
* Conceptual sections within other articles
47-
* "About security policies" in [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository#about-security-policies)
48-
* "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode#about-maintenance-mode)
47+
* "About security policies" in [AUTOTITLE](/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/add-security-policy#about-security-policies)
48+
* "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode#about-maintenance-mode)

content/contributing/style-guide-and-content-model/contents-of-a-github-docs-article.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,11 @@ Tables of contents are automatically generated. For more information see [Autoge
112112

113113
## Conceptual content
114114

115-
Conceptual content helps people understand or learn about a topic. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type) in the content model.
115+
Conceptual content helps people understand or learn about a topic. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/concepts-content-type) in the content model.
116116

117117
## Referential content
118118

119-
Referential content provides structured information related to actively using a product or feature. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/referential-content-type) in the content model.
119+
Referential content provides structured information related to actively using a product or feature. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/reference-content-type) in the content model.
120120

121121
## Prerequisites
122122

@@ -137,8 +137,8 @@ Prerequisites are information that people need to know before proceeding with a
137137

138138
### Examples of articles with prerequisites sections
139139

140-
* [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws)
141-
* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-subdomain-isolation)
140+
* [AUTOTITLE](/enterprise-server@latest/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws)
141+
* [AUTOTITLE](/enterprise-server@latest/admin/configuring-settings/hardening-security-for-your-enterprise/enabling-subdomain-isolation)
142142

143143
## How-to content
144144

@@ -162,7 +162,7 @@ When an article describes one step in a larger process or has a logical next ste
162162
- {% data variables.product.company_short %} recommends that you review security considerations for self-hosted runner machines. See "Security hardening for {% data variables.product.prodname_actions %}."
163163
```
164164

165-
In this example from [AUTOTITLE](/enterprise-cloud@latest/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise#next-steps), the next steps section includes links to procedures that someone will need to do after they start using the feature described in the article.
165+
In this example from [AUTOTITLE](/enterprise-cloud@latest/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise#next-steps), the next steps section includes links to procedures that someone will need to do after they start using the feature described in the article.
166166

167167
```markdown
168168
## Next steps

0 commit comments

Comments
 (0)