Skip to content

Commit 29d4c09

Browse files
authored
Merge pull request #41171 from github/repo-sync
Repo sync
2 parents 6da17c1 + 220395a commit 29d4c09

File tree

14 files changed

+251
-73
lines changed

14 files changed

+251
-73
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Auto-add ready-for-doc-review label
2+
3+
# **What it does**: Automatically adds the "ready-for-doc-review" label to DIY docs PRs that contain content or data changes when they are opened in a non-draft state or converted from draft to ready for review.
4+
# **Why we have it**: To ensure DIY docs PRs are automatically added to the docs-content review board without requiring manual labeling.
5+
# **Who does it impact**: Contributors making content changes and docs-content reviewers.
6+
7+
on:
8+
pull_request:
9+
types:
10+
- opened
11+
- ready_for_review
12+
paths:
13+
- 'content/**'
14+
- 'data/**'
15+
16+
permissions:
17+
contents: read
18+
pull-requests: write
19+
20+
jobs:
21+
add-review-label:
22+
name: Add ready-for-doc-review label to DIY docs PRs
23+
if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.actor != 'github-openapi-bot' && github.actor != 'docs-bot'
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: Check out repo
28+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
29+
30+
- name: Check team membership
31+
id: membership_check
32+
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
33+
with:
34+
github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
35+
script: |
36+
try {
37+
await github.rest.teams.getMembershipForUserInOrg({
38+
org: 'github',
39+
team_slug: 'docs',
40+
username: context.payload.sender.login,
41+
});
42+
return true
43+
} catch(err) {
44+
console.log(err)
45+
return false
46+
}
47+
48+
- name: Add ready-for-doc-review label
49+
if: steps.membership_check.outputs.result == 'false'
50+
env:
51+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
52+
PR_URL: ${{ github.event.pull_request.html_url }}
53+
run: |
54+
gh pr edit $PR_URL --add-label ready-for-doc-review

.github/workflows/first-responder-v2-prs-collect.yml

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name: Add docs-internal PRs to the docs-content FR project v2
1+
name: Add maintenance PRs to the docs-content FR project v2
22

3-
# **What it does**: Adds docs-internal pull requests that were opened by people outside of the docs team to the docs-content FR project v2
4-
# **Why we have it**: So we don't lose track of new pull requests for docs-content to review
3+
# **What it does**: Adds docs-internal pull requests authored by docs-bot to the docs-content FR project v2
4+
# **Why we have it**: So we don't lose track of maintenance pull requests for docs-content to review
55
# **Who does it impact**: Docs content
66

77
on:
@@ -18,76 +18,34 @@ permissions:
1818

1919
jobs:
2020
first-responder-triage-pr:
21-
name: Add PR to FR project v2
22-
if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.actor != 'dependabot[bot]' && github.event.pull_request.head.ref != 'repo-sync' && !contains(github.event.pull_request.labels.*.name, 'skip FR board')
21+
name: Add maintenance PR to FR project v2
22+
if: github.repository == 'github/docs-internal' && github.event.pull_request.draft == false && github.event.pull_request.user.id == 77750099 && github.event.pull_request.head.ref != 'repo-sync' && !contains(github.event.pull_request.labels.*.name, 'skip FR board')
2323
runs-on: ubuntu-latest
2424

2525
steps:
2626
- name: Checkout repository
2727
uses: actions/checkout@v5
2828

29-
- name: Check if the event originated from a team member
30-
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd
31-
id: check-membership
32-
with:
33-
github-token: ${{secrets.DOCS_BOT_PAT_BASE}}
34-
result-encoding: string
35-
script: |
36-
const repoName = context.payload.repository.name
37-
const ownerName = context.payload.repository.owner.login
38-
const prAuthor = context.payload.pull_request.user.login
39-
const teamMembers = await github.request(
40-
`/orgs/github/teams/docs/members?per_page=100`
41-
)
42-
const teamLogins = teamMembers.data.map(member => member.login)
43-
if (teamLogins.some(login => login === prAuthor)) {
44-
console.log(`This pull request was authored by a member of the github/docs team.`)
45-
return 'true'
46-
}
47-
console.log(`This pull request was authored by an external contributor.`)
48-
return 'false'
49-
50-
# Check if docs-bot authored the PR
51-
# If yes, set Type field to "Maintenance"
52-
# If no, set Type field to "External contributor PR"
53-
- name: Check if docs-bot is PR author
54-
env:
55-
PR_AUTHOR_ID: ${{ github.event.pull_request.user.id }}
56-
run: |
57-
if [ $PR_AUTHOR_ID == 77750099 ]; then
58-
echo "TYPE_FIELD_VALUE=3f142cf2" >> $GITHUB_ENV
59-
else
60-
echo "TYPE_FIELD_VALUE=bbd0922a" >> $GITHUB_ENV
61-
fi
62-
63-
- name: Add the docs-content-fr label
64-
if: ${{ steps.check-membership.outputs.result == 'false' }}
65-
env:
66-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
67-
PR_URL: ${{ github.event.pull_request.html_url }}
68-
run: |
69-
gh pr edit $PR_URL --add-label docs-content-fr
70-
7129
# Add to the FR project
72-
# and set type to "Maintenance" or "External contributor PR"
30+
# and set type to "Maintenance"
7331
# and set date to now
7432
- name: Triage to docs-content FR project
75-
if: steps.check-membership.outputs.result == 'false'
7633
env:
7734
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }}
7835
PR_URL: ${{ github.event.pull_request.html_url }}
7936
PROJECT_NUMBER: 11672
8037
PROJECT_ID: PVT_kwDNJr_OAGNkBg
8138
TYPE_FIELD_ID: PVTSSF_lADNJr_OAGNkBs4D-Nyn
8239
DATE_FIELD_ID: PVTF_lADNJr_OAGNkBs4D-N1h
40+
TYPE_FIELD_VALUE: 3f142cf2
8341
run: |
8442
echo "Adding item to project..."
8543
8644
ITEM_ID=$(gh project item-add $PROJECT_NUMBER --owner github --url $PR_URL --format json | jq .id)
8745
8846
echo "Editing type..."
8947
90-
gh project item-edit --project-id $PROJECT_ID --id $ITEM_ID --field-id $TYPE_FIELD_ID --single-select-option-id ${{ env.TYPE_FIELD_VALUE }}
48+
gh project item-edit --project-id $PROJECT_ID --id $ITEM_ID --field-id $TYPE_FIELD_ID --single-select-option-id $TYPE_FIELD_VALUE
9149
9250
echo "Editing date..."
9351

.github/workflows/hubber-contribution-help.yml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,23 @@ jobs:
4444
- name: Comment on the PR
4545
if: steps.membership_check.outputs.result == 'false'
4646
run: |
47-
gh pr comment $PR --body "### Next: add the review label
47+
gh pr comment $PR --body "## Requesting a review from the Docs team
4848
49-
**🛎️ Is this PR ready for review?** A PR is ready for a docs review _after_ the self-review checklist is complete.
49+
### 🚧 Draft PRs
5050
51-
When this is ready for review, add the **\`ready-for-doc-review\`** label to this PR. The PR will then be automatically added to the [Docs Content review board](https://github.com/orgs/github/projects/2936). _Please allow at least 3 working days for a review, and longer if this is a substantial change._"
51+
To add the PR to the Docs Content review board, click **Ready for review** in the merge box.
52+
53+
### 🚀 Non-draft PRs
54+
55+
The PR is **ready** and has automatically been added to the Docs Content review board. The docs team will review it as soon as possible.
56+
57+
### Lead time for review
58+
59+
Please allow at least 3 business days for a Docs Content review.
60+
61+
### Need help?
62+
63+
Reach out in [#docs-content](https://github-grid.enterprise.slack.com/archives/C0E9DK082) on Slack.
5264
5365
env:
5466
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

content/admin/administering-your-instance/administering-your-instance-from-the-web-ui/managing-search-indices-for-your-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ In normal use, enterprise owners do not need to create new indices or schedule r
4141
1. If you want the index to be searchable, select the **Make this index searchable** checkbox.
4242
1. If you want the index to be writable, select the **Make this index writable** checkbox.
4343
1. Click **Create index**.
44-
1. If your instance uses a high availability or cluster configuration, you will need to run a script to ensure the number of search indices is correctly configured across the instance.
44+
1. If your instance uses a high availability or cluster configuration, you will need to run a script to ensure the number of search indices is correctly configured across the instance. This step does not apply to those using the new HA configuration released in {% data variables.product.prodname_ghe_server %} 3.19.
4545

4646
Access the administrative shell for your primary appliance via SSH, then run one of the following commands.
4747

content/copilot/concepts/prompting/response-customization.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,8 @@ The following examples demonstrate how to use prompt files.
315315
316316
```
317317

318+
For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/prompt-files).
319+
318320
{% data reusables.copilot.custom-instructions-effective %}
319321

320322
## Next steps
@@ -353,6 +355,8 @@ Common use cases for repository custom instructions include:
353355

354356
{% data reusables.copilot.repository-custom-instructions-example %}
355357

358+
For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions).
359+
356360
{% data reusables.copilot.custom-instructions-effective %}
357361

358362
## Next steps

content/copilot/how-tos/configure-custom-instructions/add-personal-instructions.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,7 @@ Did you successfully add personal custom instructions?
4949
<a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>Yes</span></a> <a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>No</span></a>
5050

5151
{% endnote %}
52+
53+
## Further reading
54+
55+
* [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions)—a curated collection of examples

content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,11 +584,11 @@ To enable prompt files, configure the workspace settings.
584584

585585
1. Submit the chat prompt.
586586

587-
For more information about prompt files, see [Custom instructions for {% data variables.product.prodname_copilot %} in VS Code](https://code.visualstudio.com/docs/copilot/copilot-customization#_reusable-prompt-files-experimental) in the {% data variables.product.prodname_vscode %} documentation.
587+
For more information about prompt files, see [Use prompt files in {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/docs/copilot/customization/prompt-files) in the {% data variables.product.prodname_vscode %} documentation.
588588

589589
## Further reading
590590

591-
* [AUTOTITLE](/copilot/tutorials/customization-library)
591+
* [AUTOTITLE](/copilot/tutorials/customization-library)—a curated collection of examples
592592

593593
{% endvscode %}
594594

content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ For information on configuring the {% data variables.product.github %} MCP serve
9999
![Screenshot of the {% data variables.copilot.copilot_chat_short %} box in {% data variables.product.prodname_vscode %}. The "Agent" option is outlined in dark orange.](/assets/images/help/copilot/copilot-chat-agent-option.png)
100100

101101
1. To view your list of available MCP servers, click the tools icon in the top left corner of the chat box. This will open the MCP server list, where you can see all the MCP servers and associated tools that are currently available in your {% data variables.product.prodname_vscode %} instance.
102-
* Optionally, you can define toolsets, groups of related tools that you can reference in chat. Toolsets make it easier to group related MCP tools together and quickly enable or disable them. For information on how to define and use a toolset, see the [{% data variables.product.prodname_vscode_shortname %} docs](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode#_define-tool-sets).
102+
* Optionally, you can define toolsets, groups of related tools that you can reference in chat. Toolsets make it easier to group related MCP tools together and quickly enable or disable them. For information on how to define and use a toolset, see the [{% data variables.product.prodname_vscode_shortname %} docs](https://code.visualstudio.com/docs/copilot/chat/chat-tools#_group-tools-with-tool-sets).
103103

104104
For more information on configuring MCP servers in {% data variables.product.prodname_vscode %}, see [Use MCP servers in {% data variables.product.prodname_vscode %}](https://aka.ms/vscode-add-mcp) in the {% data variables.product.prodname_vscode %} documentation.
105105

content/copilot/reference/allowlist-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ If your company employs security measures like a firewall or proxy server, you s
3535
| `https://*.individual.githubcopilot.com`[^2] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
3636
| `https://*.business.githubcopilot.com`[^3] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
3737
| `https://*.enterprise.githubcopilot.com`[^4] | API service for {% data variables.product.prodname_copilot_short %} suggestions |
38+
| `https://*.SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
39+
| `https://SUBDOMAIN.ghe.com` | For {% data variables.product.prodname_copilot_short %} users on {% data variables.enterprise.data_residency_site %} |
3840

3941
Depending on the security policies and editors your organization uses, you may need to allowlist additional domains and URLs. For more information on specific editors, see [Further reading](#further-reading).
4042

data/reusables/contributing/content-linter-rules.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
| GHD022 | liquid-ifversion-versions | Liquid `ifversion`, `elsif`, and `else` tags should be valid and not contain unsupported versions. | error | liquid, versioning |
4444
| GHD031 | image-alt-text-exclude-words | Alternate text for images should not begin with words like "image" or "graphic" | error | accessibility, images |
4545
| GHD032 | image-alt-text-end-punctuation | Alternate text for images should end with punctuation | error | accessibility, images |
46-
| GHD033 | incorrect-alt-text-length | Images alternate text should be between 40-150 characters | warning | accessibility, images |
46+
| GHD033 | incorrect-alt-text-length | Images alternate text should be between 40-150 characters | error | accessibility, images |
4747
| GHD035 | rai-reusable-usage | RAI articles and reusables can only reference reusable content in the data/reusables/rai directory | error | feature, rai |
4848
| GHD036 | image-no-gif | Image must not be a gif, styleguide reference: contributing/style-guide-and-content-model/style-guide.md#images | error | images |
4949
| GHD038 | expired-content | Expired content must be remediated. | warning | expired |
@@ -52,11 +52,11 @@
5252
| GHD041 | third-party-action-pinning | Code examples that use third-party actions must always pin to a full length commit SHA | error | feature, actions |
5353
| GHD042 | liquid-tag-whitespace | Liquid tags should start and end with one whitespace. Liquid tag arguments should be separated by only one whitespace. | error | liquid, format |
5454
| GHD043 | link-quotation | Internal link titles must not be surrounded by quotations | error | links, url |
55-
| GHD045 | code-annotation-comment-spacing | Code comments in annotation blocks must have exactly one space after the comment character(s) | warning | code, comments, annotate, spacing |
56-
| GHD046 | outdated-release-phase-terminology | Outdated release phase terminology should be replaced with current GitHub terminology | warning | terminology, consistency, release-phases |
57-
| GHD047 | table-column-integrity | Tables must have consistent column counts across all rows | warning | tables, accessibility, formatting |
58-
| GHD051 | frontmatter-versions-whitespace | Versions frontmatter should not contain unnecessary whitespace | warning | frontmatter, versions |
59-
| GHD054 | third-party-actions-reusable | Code examples with third-party actions must include disclaimer reusable | warning | actions, reusable, third-party |
55+
| GHD045 | code-annotation-comment-spacing | Code comments in annotation blocks must have exactly one space after the comment character(s) | error | code, comments, annotate, spacing |
56+
| GHD046 | outdated-release-phase-terminology | Outdated release phase terminology should be replaced with current GitHub terminology | error | terminology, consistency, release-phases |
57+
| GHD047 | table-column-integrity | Tables must have consistent column counts across all rows | error | tables, accessibility, formatting |
58+
| GHD051 | frontmatter-versions-whitespace | Versions frontmatter should not contain unnecessary whitespace | error | frontmatter, versions |
59+
| GHD054 | third-party-actions-reusable | Code examples with third-party actions must include disclaimer reusable | error | actions, reusable, third-party |
6060
| GHD056 | frontmatter-landing-recommended | Only landing pages can have recommended articles, there should be no duplicate recommended articles, and all recommended articles must exist | error | frontmatter, landing, recommended |
6161
| GHD057 | ctas-schema | CTA URLs must conform to the schema | error | ctas, schema, urls |
6262
| GHD058 | journey-tracks-liquid | Journey track properties must use valid Liquid syntax | error | frontmatter, journey-tracks, liquid |

0 commit comments

Comments
 (0)