Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 7 additions & 1 deletion .github/workflows/copilot-setup-steps.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,5 +57,11 @@ jobs:
run: npm run build

# Populate Elasticsearch with fixture data so search/language tests work.
# ELASTICSEARCH_URL is set inline in the run command because the
# Copilot/GHAS agent runtime executes these setup steps with its own
# injected environment and does not apply the workflow's `env:` blocks
# (job-level or step-level). The inline assignment is part of the run
# command, which the agent runs verbatim, so it is honored in both the
# agent context and normal workflow_dispatch runs.
- name: Index fixtures into the local Elasticsearch
run: npm run index-test-fixtures
run: ELASTICSEARCH_URL=http://localhost:9200/ npm run index-test-fixtures
12 changes: 12 additions & 0 deletions .github/workflows/notify-release-pms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,27 @@ on:

permissions:
contents: read
pull-requests: read

jobs:
notify:
name: Notify release PMs
if: github.repository == 'github/docs-internal'
runs-on: ubuntu-latest
steps:
- name: Get PR head branch
id: pr-ref
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ inputs.pr }}
run: |
ref=$(gh pr view "$PR_NUMBER" --repo github/docs-internal --json headRefName --jq '.headRefName')
echo "ref=$ref" >> "$GITHUB_OUTPUT"

- name: Checkout repository code
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
ref: ${{ steps.pr-ref.outputs.ref }}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The documentation repository is the place to discuss and collaborate on the docu

## Issues

[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.
[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.

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 -->

Expand All @@ -25,9 +25,9 @@ If you've found something in the documentation content, or something about the d

## Pull requests

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.
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.

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.
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.

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 %}.

Expand All @@ -41,7 +41,7 @@ For content changes, make sure that you:
* Review the content for technical accuracy.
* Check your changes for grammar, spelling, and adherence to the [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide).
* 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).
* 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).
* Check new or updated Liquid statements to confirm that versioning is correct. For more information, see [AUTOTITLE](/contributing/writing-for-github-docs/versioning-documentation).
* 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.
* If there are any failing checks in your pull request, troubleshoot them until they're all passing.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ To keep your local branches in sync with their remotes and avoid merge conflicts
* 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."

> [!NOTE]
> 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).
> 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).

* Make commit messages clear, detailed, and imperative. For example: "Add conceptual article about 2FA," not "Add info."
* 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ npm start

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.

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).
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).

```text
error parsing file: /Users/z/git/github/docs/content/dotcom/articles/troubleshooting-custom-domains-and-github-pages.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For more information, see [AUTOTITLE](/free-pro-team@latest/codespaces/quickstar

## Working on documentation in a codespace

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).
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).

1. Navigate to the open source repository for {% data variables.product.prodname_docs %}, [`github/docs`](https://github.com/github/docs).
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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ Often, it's helpful to group information in context to help people complete a co
## Examples of articles that combine multiple content types

* [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)
* [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
* [AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)
* [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode)
* [AUTOTITLE](/enterprise-cloud@latest/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)
* [AUTOTITLE](/free-pro-team@latest/billing/how-tos/manage-plan-and-licenses/upgrade-plan)
* [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Categories are organized around a feature or a discrete set of tasks within a to
* General or high-level enough to scale with future product enhancements.
* 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.
* Examples
* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github)
* [AUTOTITLE](/account-and-profile/how-tos)
* [AUTOTITLE](/pull-requests/committing-changes-to-your-project)

### Intros for categories
Expand All @@ -98,8 +98,8 @@ In general, avoid having a map topic within a map topic unless it is the best wa
* General or high-level enough to scale with future additions to the product.
* 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.
* Examples
* [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain)
* [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise)
* [AUTOTITLE](/code-security/concepts/supply-chain-security)
* [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise)

### Intros for map topics

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Headers of conceptual sections in articles start with "About [subject]”.

* Conceptual articles
* [About GitHub Sponsors](/free-pro-team@latest/sponsors/getting-started-with-github-sponsors/about-github-sponsors)
* [About Enterprise accounts](/enterprise-cloud@latest/admin/overview/about-enterprise-accounts)
* [About Enterprise accounts](/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/enterprise-accounts)
* Conceptual sections within other articles
* "About security policies" in [AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository#about-security-policies)
* "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode#about-maintenance-mode)
* "About security policies" in [AUTOTITLE](/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/add-security-policy#about-security-policies)
* "About maintenance mode" in [AUTOTITLE](/enterprise-server@latest/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode#about-maintenance-mode)
Original file line number Diff line number Diff line change
Expand Up @@ -112,11 +112,11 @@ Tables of contents are automatically generated. For more information see [Autoge

## Conceptual content

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.
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.

## Referential content

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.
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.

## Prerequisites

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

### Examples of articles with prerequisites sections

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

## How-to content

Expand All @@ -162,7 +162,7 @@ When an article describes one step in a larger process or has a logical next ste
- {% 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 %}."
```

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.
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.

```markdown
## Next steps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ For the how-to content template, see [AUTOTITLE](/contributing/writing-for-githu

## Examples of how-to content

{% ifversion fpt or ghec %}* [AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces){% endif %}
* [AUTOTITLE](/actions/using-workflows/using-starter-workflows)
{% ifversion fpt or ghec %}* [AUTOTITLE](/copilot/how-tos/copilot-on-github/customize-copilot/copilot-spaces/create-copilot-spaces){% endif %}
* [AUTOTITLE](/actions/how-tos/write-workflows/use-workflow-templates)
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ Contents of quickstarts:

## Examples of quickstarts

* [AUTOTITLE](/free-pro-team@latest/actions/quickstart)
* [AUTOTITLE](/free-pro-team@latest/actions/get-started/quickstart)
* [AUTOTITLE](/free-pro-team@latest/discussions/quickstart)
* [Quickstart for GitHub Educators](/free-pro-team@latest/education/quickstart)
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ For the reference content template, see [AUTOTITLE](/contributing/writing-for-gi
* Write a sentence or an entire conceptual section to introduce the reference content.
* Present the actual reference content clearly and consistently.
* For subjects with a single element to explain, use a list.
* Example: [AUTOTITLE](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#repository-roles-for-organizations)
* Example: [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#repository-roles-for-organizations)
* For subjects with multiple elements to explain, use a table.
* Example: [AUTOTITLE](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization#permissions-for-each-role)
* Example: [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role)
* For longer referential content, such as YAML syntax for workflows, use headers consistently.
* H2 headers for each distinct section.
* H3 headers for subsections, such as examples.
* Example: [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions)
* Example: [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax)

## Titles for referential content

Expand All @@ -44,9 +44,9 @@ For the reference content template, see [AUTOTITLE](/contributing/writing-for-gi

* Reference articles
* [AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization)
* [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)
* [AUTOTITLE](/free-pro-team@latest/rest/reference/billing) in the REST API documentation
* [AUTOTITLE](/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles)
* [AUTOTITLE](/rest/billing/billing) in the REST API documentation
* [AUTOTITLE](/graphql/reference) in the GraphQL API documentation
* Reference sections within other articles
* "Supported languages" in [AUTOTITLE](/free-pro-team@latest/get-started/using-github/github-mobile#supported-languages-for-github-mobile)
* "Hardware considerations" in [AUTOTITLE](/enterprise-server@latest/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations)
* "Hardware considerations" in [AUTOTITLE](/enterprise-server@latest/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws#hardware-considerations)
Loading
Loading