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
39 changes: 39 additions & 0 deletions .github/workflows/reviewers-docs-engineering.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ jobs:
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
!contains(github.event.pull_request.labels.*.name, 'reviewers-docs-engineering') &&
!contains(github.event.pull_request.labels.*.name, 'lockfile-churn-only') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
env:
Expand All @@ -50,7 +51,45 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v6.0.1

# Detect PRs that only changed package-lock.json (no engineering source files).
# These are usually cross-platform `npm install` churn from contributors
# editing content. We comment with reset instructions instead of pulling in
# docs-engineering for review.
- name: Detect lockfile-only churn
id: detect
run: |
changed=$(gh pr diff "$PR" --name-only)
echo "Changed files:"
echo "$changed"
lockfile=$(echo "$changed" | grep -c '^package-lock\.json$' || true)
other_eng=$(echo "$changed" | grep -cE '(\.tsx?$|\.scss$|^src/|^package\.json$|^\.github/|^config/|^\.devcontainer/|Dockerfile)' || true)
if [ "$lockfile" -gt 0 ] && [ "$other_eng" -eq 0 ]; then
echo "lockfile_only=true" >> "$GITHUB_OUTPUT"
else
echo "lockfile_only=false" >> "$GITHUB_OUTPUT"
fi

- name: Comment and label lockfile-only PRs
if: steps.detect.outputs.lockfile_only == 'true'
run: |
cat > /tmp/lockfile-churn-body.md <<'EOF'
_Posted by Copilot on behalf of docs-engineering._

This PR includes `package-lock.json` changes but no engineering files. Please reset the lockfile:

```
git checkout origin/main -- package-lock.json
git commit -m "Reset package-lock.json"
git push
```

If the lockfile change is intentional, remove the `lockfile-churn-only` label and request docs-engineering review.
EOF
gh pr comment "$PR" --body-file /tmp/lockfile-churn-body.md
gh pr edit "$PR" --add-label lockfile-churn-only

- name: Add docs engineering as a reviewer
if: steps.detect.outputs.lockfile_only != 'true'
uses: ./.github/actions/retry-command
with:
command: gh pr edit $PR --add-reviewer github/docs-engineering --add-label reviewers-docs-engineering
1 change: 0 additions & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ jobs:
- audit-logs
- automated-pipelines
# - bookmarklets
- changelogs
# - code-scanning
# - codeql-cli
- color-schemes
Expand Down
12 changes: 8 additions & 4 deletions config/moda/configuration/default/env.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ data:
RATE_LIMIT_MAX: '21'
# Moda uses a non-default port for sending datadog metrics
DD_DOGSTATSD_PORT: '28125'
# OTel distributed tracing — sends spans to OTel Collector via OTLP/HTTP (proto).
# Uses stamp address (not mesh) since docs-internal is not on the service mesh.
# See https://thehub.github.com/epd/engineering/dev-practicals/observability/distributed-tracing/instrumentation/
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: 'https://otelcol.service.%stamp%.github.net/v1/traces'
# NodeSDK auto-enables OTLP metrics and logs exporters when these env vars
# are unset. We only want traces, so explicitly disable the others to avoid
# spamming export errors. See https://opentelemetry.io/docs/specs/otel/protocol/exporter/
OTEL_METRICS_EXPORTER: 'none'
OTEL_LOGS_EXPORTER: 'none'
# OTel traces endpoint is set per-environment (see production/env.yaml).
# Stagings don't have OTEL_EXPORTER_OTLP_TRACES_HEADERS, so they don't
# export traces — tracing.ts gates SDK startup on the endpoint env var.
7 changes: 5 additions & 2 deletions config/moda/configuration/production/env.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ data:
# Equivalent to HEAVEN_DEPLOYED_ENV === 'production'
MODA_PROD_SERVICE_ENV: 'true'
# OTel distributed tracing — sends spans to OTel Collector via OTLP/HTTP (proto).
# Uses stamp address (not mesh) since docs-internal is not on the service mesh.
# Uses %site% template (not %stamp%) since docs-internal is not on the service
# mesh and not on a Proxima stamp (region: iad, profile: general). %site%
# interpolates to the cluster's site (e.g. iad), giving a hostname like
# otelcol.service.iad.github.net that resolves from production pods.
# See https://thehub.github.com/epd/engineering/dev-practicals/observability/distributed-tracing/instrumentation/
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: 'https://otelcol.service.%stamp%.github.net/v1/traces'
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: 'https://otelcol.service.%site%.github.net/v1/traces'
3 changes: 1 addition & 2 deletions content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,7 @@ shortTitle: Contributing to projects
### `layout`

- Purpose: Render the proper page layout.
- Type: `String` that matches the name of the layout.
For a layout named `components/landing`, the value would be `product-landing`.
- Type: `String` that matches the name of a supported layout. See `layoutNames` in `src/frame/lib/frontmatter.ts` for the authoritative list (for example, `discovery-landing`, `journey-landing`, `bespoke-landing`, `category-landing`, `toc-landing`, `inline`).
- Optional. If omitted, `DefaultLayout` is used.

### `children`
Expand Down
5 changes: 0 additions & 5 deletions content/account-and-profile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ introLinks:
quickstart: /account-and-profile/get-started/account
overview: /account-and-profile/get-started/profile
layout: discovery-landing
changelog:
label: profiles, github-themes
versions:
fpt: '*'
ghec: '*'
versions:
fpt: '*'
ghes: '*'
Expand Down
2 changes: 0 additions & 2 deletions content/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ intro: 'Automate, customize, and execute your software development workflows rig
introLinks:
overview: /actions/get-started/understand-github-actions
quickstart: /actions/get-started/quickstart
changelog:
label: actions
redirect_from:
- /articles/automating-your-workflow-with-github-actions
- /articles/customizing-your-project-with-github-actions
Expand Down
2 changes: 0 additions & 2 deletions content/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ redirect_from:
- /insights/installing-and-configuring-github-insights/managing-data-in-github-insights/managing-repositories
- /admin/configuration/configuring-your-enterprise/configuring-data-encryption-for-your-enterprise
- /admin/guides
changelog:
label: enterprise
layout: discovery-landing
includedCategories:
- Get started with GitHub Enterprise
Expand Down
2 changes: 0 additions & 2 deletions content/apps/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ carousels:
- /apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps
- /apps/creating-github-apps/writing-code-for-a-github-app/building-a-github-app-that-responds-to-webhook-events
- /apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app
changelog:
label: apps
versions:
fpt: '*'
ghes: '*'
Expand Down
2 changes: 0 additions & 2 deletions content/authentication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ versions:
ghec: '*'
introLinks:
overview: /authentication/keeping-your-account-and-data-secure/about-authentication-to-github
changelog:
label: '2FA,authentication,security keys,SSH,token authentication'
layout: discovery-landing
carousels:
recommended:
Expand Down
2 changes: 0 additions & 2 deletions content/billing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ redirect_from:
- /categories/setting-up-and-managing-billing-and-payments-on-github
introLinks:
overview: '{% ifversion fpt or ghec %}/billing/get-started/how-billing-works {% elsif ghes %}/billing/concepts/enterprise-billing/billing-for-enterprises{% endif %}'
changelog:
label: account-management
layout: discovery-landing
includedCategories:
- 'Get started with billing'
Expand Down
5 changes: 0 additions & 5 deletions content/code-security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ redirect_from:
introLinks:
overview: '{% ifversion ghes %}/code-security/getting-started/github-security-features{% endif %}'
generate_secret_risk_assessment_report_for_free: '{% ifversion secret-risk-assessment %}https://github.com/get_started?with=risk-assessment{% endif %}'
changelog:
label: security-and-compliance
versions:
fpt: '*'
ghec: '*'
layout: discovery-landing
contentType: landing
includedCategories:
Expand Down
2 changes: 0 additions & 2 deletions content/codespaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ carousels:
- /codespaces/developing-in-a-codespace/using-source-control-in-your-codespace
- /codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization
- /codespaces/reference/security-in-github-codespaces
changelog:
label: codespaces
communityRedirect:
name: Provide GitHub Feedback
href: 'https://github.com/orgs/community/discussions/categories/codespaces'
Expand Down
2 changes: 0 additions & 2 deletions content/communities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ intro: "Learn best practices for moderating and setting up collaborative, safe,
redirect_from:
- /categories/building-a-strong-community
- /github/building-a-strong-community
changelog:
label: wikis
layout: discovery-landing
introLinks:
overview: /communities/setting-up-your-project-for-healthy-contributions/about-community-management-and-moderation
Expand Down
2 changes: 0 additions & 2 deletions content/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ intro: 'Learn about how the {% data variables.product.prodname_docs %} team crea
introLinks:
overview: /contributing/collaborating-on-github-docs/about-contributing-to-github-docs
quickstart: /contributing/writing-for-github-docs/best-practices-for-github-docs
changelog:
label: docs
layout: discovery-landing
includedCategories:
- Understand the GitHub approach to docs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,9 @@ Prerequisites are information that people need to know before proceeding with a
* [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws)
* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-subdomain-isolation)

## Procedural content
## How-to content

Procedural content helps people complete tasks. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/procedural-content-type) in the content model.
How-to content helps people complete tasks. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/how-to-content-type) in the content model.

## Troubleshooting content

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ Before you begin, it’s important to understand who you’re writing for, what

Determine which type of content you will write, based on the intended audience and the core purpose of the content. {% data variables.product.prodname_docs %} use the following content types:

* [Conceptual content](/contributing/style-guide-and-content-model/conceptual-content-type)
* [Referential content](/contributing/style-guide-and-content-model/referential-content-type)
* [Procedural content](/contributing/style-guide-and-content-model/procedural-content-type)
* [Troubleshooting content](/contributing/style-guide-and-content-model/troubleshooting-content-type)
* [Quickstart](/contributing/style-guide-and-content-model/quickstart-content-type)
* [Tutorial](/contributing/style-guide-and-content-model/tutorial-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/referential-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/how-to-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/troubleshooting-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/quickstart-content-type)
* [AUTOTITLE](/contributing/style-guide-and-content-model/tutorial-content-type)

For example, use the conceptual content type to help readers understand the basics of a feature or topic and how it can help them accomplish their goals. Use the procedural content type to help people complete a specific task from start to finish.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,7 @@ shortTitle: Contributing to projects
### `layout`

* Purpose: Render the proper page layout.
* Type: `String` that matches the name of the layout.
For a layout named `components/landing`, the value would be `product-landing`.
* Type: `String` that matches the name of a supported layout. See `layoutNames` in `src/frame/lib/frontmatter.ts` for the authoritative list (for example, `discovery-landing`, `journey-landing`, `bespoke-landing`, `category-landing`, `toc-landing`, `inline`).
* Optional. If omitted, `DefaultLayout` is used.

### `children`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ In addition to the main {% data variables.product.prodname_copilot_short %} agen

* **research** — This agent operates as a staff-level software engineer and research specialist. It provides exhaustive, meticulously researched answers about codebases, APIs, libraries, and software architecture. It uses {% data variables.product.github %} search/exploration tools, web fetch/search, and local tools. Unlike the other agents, the research agent can only be invoked by using the `/research` slash command. It cannot be automatically triggered by the main agent.

* **rubber-duck** — A constructive critic that gives {% data variables.product.prodname_copilot_short %} a second opinion on its own plans, code, and tests. It runs on a different model from the one driving your session, so it brings a complementary perspective. It is designed to review proposed changes, not to make file changes itself. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/rubber-duck).

## Running agents as subagents

One of the benefits of using custom agents you have defined yourself—or the built-in agents—is that the main {% data variables.product.prodname_copilot_short %} agent can run them as subagents with a separate context window. This means that your custom agent, or built-in agent, can focus on a specific subtask without cluttering the context window of the main agent.
Expand Down
Loading
Loading