Skip to content

Commit 81ed1aa

Browse files
authored
Merge branch 'main' into fixing-security-docs
2 parents ff6655f + 8102cd9 commit 81ed1aa

99 files changed

Lines changed: 2049 additions & 2361 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/benchmark-pages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
npx tsx src/workflows/benchmark-pages.ts \
4545
--versions "free-pro-team@latest,enterprise-cloud@latest,enterprise-server@latest" \
4646
--modes article-body \
47-
--slow 500 \
47+
--slow 1000 \
4848
--json /tmp/benchmark-results.json | tee /tmp/benchmark-output.txt
4949
5050
- name: Check results and create issue if needed
@@ -108,7 +108,7 @@ jobs:
108108
echo "**Total pages:** $TOTAL"
109109
echo "**Stats:** p50=${P50}ms · p99=${P99}ms · max=${MAX}ms"
110110
echo "**Errors:** $ERRORS"
111-
echo "**Slow (≥500ms):** $SLOW"
111+
echo "**Slow (≥1000ms):** $SLOW"
112112
} > "$BODY_FILE"
113113
114114
if [ "$ERRORS" -gt 0 ]; then
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Notify release PMs
2+
3+
# **What it does**: Posts review notification comments on release issues
4+
# in github/releases for generated GHES release notes.
5+
# **Why we have it**: So comments are always posted by docs-bot, without
6+
# needing to distribute a PAT to individual team members.
7+
# **Who does it impact**: Docs content (GHES release DRIs).
8+
9+
on:
10+
workflow_dispatch:
11+
inputs:
12+
release:
13+
description: 'GHES release version (e.g., 3.21)'
14+
type: string
15+
required: true
16+
pr:
17+
description: 'docs-internal PR number containing the release notes'
18+
type: string
19+
required: true
20+
release_type:
21+
description: 'Release type (auto-detects from files if not specified)'
22+
type: choice
23+
options:
24+
- auto
25+
- rc
26+
- ga
27+
default: 'auto'
28+
review_date:
29+
description: 'Override review deadline (YYYY-MM-DD, optional)'
30+
type: string
31+
required: false
32+
dry_run:
33+
description: 'Preview comments in the workflow log without posting them'
34+
type: boolean
35+
default: false
36+
37+
permissions:
38+
contents: read
39+
40+
jobs:
41+
notify:
42+
name: Notify release PMs
43+
if: github.repository == 'github/docs-internal'
44+
runs-on: ubuntu-latest
45+
steps:
46+
- name: Checkout repository code
47+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
48+
49+
- uses: ./.github/actions/node-npm-setup
50+
51+
- name: Post notification comments
52+
env:
53+
DOCS_BOT_PAT_BASE: ${{ secrets.DOCS_BOT_PAT_BASE }}
54+
INPUT_RELEASE: ${{ inputs.release }}
55+
INPUT_PR: ${{ inputs.pr }}
56+
INPUT_RELEASE_TYPE: ${{ inputs.release_type }}
57+
INPUT_REVIEW_DATE: ${{ inputs.review_date }}
58+
INPUT_DRY_RUN: ${{ inputs.dry_run }}
59+
run: |
60+
args=(--release "$INPUT_RELEASE" --pr "$INPUT_PR")
61+
62+
if [[ "$INPUT_RELEASE_TYPE" == "rc" ]]; then
63+
args+=(--rc)
64+
elif [[ "$INPUT_RELEASE_TYPE" == "ga" ]]; then
65+
args+=(--ga)
66+
fi
67+
68+
if [[ -n "$INPUT_REVIEW_DATE" ]]; then
69+
args+=(--review-date "$INPUT_REVIEW_DATE")
70+
fi
71+
72+
if [[ "$INPUT_DRY_RUN" == "true" ]]; then
73+
args+=(--dry-run)
74+
fi
75+
76+
npm run notify-release-pms -- "${args[@]}"

.github/workflows/purge-fastly.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ jobs:
3939
- uses: ./.github/actions/node-npm-setup
4040

4141
- name: Wait for production to match build number
42+
if: github.event_name != 'workflow_dispatch'
4243
run: |
4344
needs=$(git rev-parse HEAD)
4445
start_time=$(date +%s)

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Docs changelog
22

3+
**15 April 2026**
4+
5+
LSP servers greatly improve Copilot CLI's ability to work with your code. For example, when Copilot renames a symbol throughout a project it can do this more quickly and reliably if it has access to an LSP server for the language the code is written in.
6+
7+
We've added documentation to explain LSP servers in greater detail and show how to install these for Copilot CLI:
8+
9+
* [Using LSP servers with GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/copilot-cli/lsp-servers)
10+
* [Adding LSP servers for GitHub Copilot CLI](https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/add-lsp-servers)
11+
12+
<hr>
13+
314
**13 April 2026**
415

516
To coincide with the release of the ability to [steer your Copilot CLI sessions remotely](https://github.blog/changelog/2026-04-13-remote-control-cli-sessions-on-web-and-mobile-in-public-preview/) (from GitHub.com, or from GitHub Mobile), we have added these new articles:

config/kubernetes/production/deployments/webapp.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ spec:
4040
image: docs-internal
4141
resources:
4242
requests:
43-
cpu: 1250m
43+
cpu: 1500m
4444
# Absolute minimum to start app is 1000m
4545
# Node is single-threaded but we want more CPUs
4646
# for OS and image resizing, and other binary executions
4747
# Better to increase replicas or memory than CPU
48-
memory: 8.0Gi
48+
memory: 5000Mi
4949
# Absolute minimum to start app is 4500Mi
5050
# Would increase with more pages, versions, or languages supported
5151
# The additional memory helps during traffic surges
5252
limits:
5353
cpu: 8000m
54-
memory: 16.0Gi
54+
memory: 14.0Gi
5555
ports:
5656
- name: http
5757
containerPort: 4000

content/billing/how-tos/set-up-budgets.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,4 @@ You can edit or delete a budget at any time, but you cannot change the scope of
136136
1. Navigate to the "Budgets and alerts" view. See [Viewing budgets](#viewing-budgets).
137137
1. In the list of budgets, click {% octicon "kebab-horizontal" aria-label="View actions" %} next to the budget you want to edit, and click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Edit** or **{% octicon "trash" aria-hidden="true" aria-label="trash" %} Delete**.
138138
1. Follow the prompts.
139+

content/codespaces/troubleshooting/troubleshooting-included-usage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,4 @@ If the dev container for the current codespace was built from the default image,
106106

107107
Alternatively, you can check which repositories have prebuilds by reviewing a usage report. See [Understanding your {% data variables.product.prodname_codespaces %} usage](#understanding-your-codespaces-usage) above.
108108
* Storage of containers built from the default dev container image for codespaces is free of charge and does not reduce your included storage. You can therefore avoid your storage allowance being consumed by your dev container by using the default image in your dev container configuration, rather than specifying a more specialized image. See [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration) and [Storage usage for your base dev container](#storage-usage-for-your-base-dev-container) above.
109+

content/contributing/style-guide-and-content-model/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ children:
1010
- /about-the-content-model
1111
- /contents-of-a-github-docs-article
1212
- /conceptual-content-type
13-
- /referential-content-type
13+
- /reference-content-type
1414
- /how-to-content-type
1515
- /troubleshooting-content-type
1616
- /release-note-content-type

content/contributing/style-guide-and-content-model/referential-content-type.md renamed to content/contributing/style-guide-and-content-model/reference-content-type.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
---
2-
title: Referential content type
3-
intro: Referential content provides detailed information that people need while they are actively using a feature.
2+
title: Reference content type
3+
intro: Reference content provides detailed information that people need while they are actively using a feature.
44
versions:
55
fpt: '*'
66
ghec: '*'
77
ghes: '*'
88
category:
99
- Follow the style guide and content model
1010
---
11+
Reference content is consulted for specific pieces of information. It’s information you can quickly check, meaning there’s less emphasis on sentences and paragraphs.
1112

12-
We create referential articles and referential sections within other articles.
13-
* Some major subjects may require their own referential article, especially if there is a large amount of referential content, such as for search syntax or YAML syntax in {% data variables.product.prodname_actions %}.
14-
* For smaller amounts of content or more specific information, like a list of a feature’s supported languages or hardware requirements, use referential sections in context within procedural or conceptual articles.
13+
Reference includes information that may be best represented in tables, lists, or other structured formats. We might think of reference as including our autogenerated pipeline content and other content that could potentially be automated.
1514

16-
## How to write referential content
15+
Reference content appears in reference articles and reference sections within other articles.
16+
* Some major subjects may require their own reference article, especially if there is a large amount of reference content, such as for search syntax or YAML syntax in {% data variables.product.prodname_actions %}.
17+
* For smaller amounts of content or more specific information, like a list of a feature’s supported languages or hardware requirements, use reference sections in context within procedural or conceptual articles.
1718

18-
For the referential content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#referential-article-template).
19+
## How to write reference content
1920

20-
* Write a sentence or an entire conceptual section to introduce the referential content.
21-
* Present the actual referential content clearly and consistently.
21+
For the reference content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#reference-article-template).
22+
23+
* Write a sentence or an entire conceptual section to introduce the reference content.
24+
* Present the actual reference content clearly and consistently.
2225
* For subjects with a single element to explain, use a list.
2326
* Example: [AUTOTITLE](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#repository-roles-for-organizations)
2427
* For subjects with multiple elements to explain, use a table.
@@ -33,14 +36,15 @@ For the referential content template, see [AUTOTITLE](/contributing/writing-for-
3336
* Referential articles or headers of referential sections clearly describe the contents of the section, and generally begin with nouns.
3437
* Titles include enough information to be accessible to novice users and fully describe the contents of each section.
3538
* Titles avoid stacked nouns - use prepositions to break up long strings of nouns.
39+
* Short titles should be one word or a short noun phrase. Example: "AI Models".
3640

37-
## Examples of referential content
41+
## Examples of reference content
3842

39-
* Referential articles
40-
* [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)
43+
* Reference articles
44+
* [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization)
4145
* [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)
4246
* [AUTOTITLE](/free-pro-team@latest/rest/reference/billing) in the REST API documentation
4347
* [AUTOTITLE](/graphql/reference/mutations) in the GraphQL API documentation
44-
* Referential sections within other articles
48+
* Reference sections within other articles
4549
* "Supported languages" in [AUTOTITLE](/free-pro-team@latest/get-started/using-github/github-mobile#supported-languages-for-github-mobile)
4650
* "Hardware considerations" in [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations)

content/contributing/writing-for-github-docs/templates.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ Optionally, include a bulleted list of related articles the user can reference t
5959
6060
<!-- markdownlint-enable search-replace -->
6161
62-
## Referential article template
62+
## Reference article template
6363
64-
Use the content model for full instructions and examples on how to write referential content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/referential-content-type).
64+
Use the content model for full instructions and examples on how to write reference content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/reference-content-type).
6565
6666
<!-- markdownlint-disable search-replace -->
6767
@@ -77,8 +77,8 @@ versions:
7777
---
7878

7979
{% comment %}
80-
Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model#referential to write this article.-- >
81-
Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/contributing/writing-for-github-docs/content-model
80+
Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model to write this article.-- >
81+
Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/en/contributing/style-guide-and-content-model/contents-of-a-github-docs-article#intro
8282
For product callout info, see https://github.com/github/docs/tree/main/content#product
8383
For product version instructions, see https://github.com/github/docs/tree/main/content#versioning
8484
Remove these comments from your article file when you're done writing

0 commit comments

Comments
 (0)