diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0195011ff988..c930eff3a2c4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ Thank you for contributing to this project! You must fill out the information be ### Why: -Closes: +Closes: @@ -16,7 +16,6 @@ If you made changes to the `content` directory, a table will populate in a comme ### Check off the following: -- [ ] I have reviewed my changes in staging, available via the **View deployment** link in this PR's timeline (this link will be available after opening the PR). - - - For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the `data` directory. -- [ ] For content changes, I have completed the [self-review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist). +- [ ] A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff. +- [ ] The changes in this PR meet [the docs fundamentals that are required for all content](http://docs.github.com/en/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals). +- [ ] All CI checks are passing. diff --git a/.github/review-template.md b/.github/review-template.md deleted file mode 100644 index 6aeb6e69d74b..000000000000 --- a/.github/review-template.md +++ /dev/null @@ -1,36 +0,0 @@ -## Author self-review - -- [ ] The changes in this PR meet the user experience and goals outlined in the content design plan. -- [ ] The changes in this PR adhere to our [style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide), [content model](https://docs.github.com/en/contributing/writing-for-github-docs/content-model), and "[Writing content to be translated](https://docs.github.com/en/contributing/writing-for-github-docs/writing-content-to-be-translated)." -- [ ] Compare this PR's source changes to the preview deployment and review for versioning issues, redirects, rendering problems, typos, and wonky screenshots. -- [ ] All screenshots in this PR adhere to the guidance in "[Creating screenshots](https://docs.github.com/en/contributing/writing-for-github-docs/creating-screenshots)." -- [ ] All checks are passing. -- [ ] For REST API content, verify that endpoints, parameters, and responses are correct and work as expected and provided curl samples below. - -For more information, check out our [review process](https://github.com/github/docs-team/blob/main/contributing-to-docs/review-process.md). - -## Review request - -### Summary - -_Help reviewers understand this project and its context by writing a paragraph summarizing its goals and intended user experience and explaining how the PR meets those goals._ -[Content design plan](LINK HERE) - -### Docs Content review - -_Give Docs Content any extra context, highlight areas for them to consider in their review, and ask them questions you need answered to ship the PR._ - -### Technical review - -_Ping in technical reviewers, asking them to review whether content is technically accurate and right for the audience._ -_Highlight areas for them to consider in their review and ask them questions you need answered to ship the PR._ - -### Content changes - -[PR on staging](LINK HERE) - -_Give a high-level overview of the changes in your PR and how they support the overall goals of the PR. Share links to important articles or changes in source and on staging. If your PR is large or complex, use a table to highlight changes with high user impact._ - -### Notes - -_Discuss test failures, versioning issues, or anything else reviewers should know to consider the overall user experience of the PR._ diff --git a/.github/workflows/add-review-template.yml b/.github/workflows/add-review-template.yml deleted file mode 100644 index c3490a191965..000000000000 --- a/.github/workflows/add-review-template.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Add review template - -# **What it does**: When a specific label is added to a PR, adds the contents of .github/review-template.md as a comment in the PR -# **Why we have it**: To help Docs Content team members ensure that their PR is ready for review -# **Who does it impact**: docs-internal maintainers and contributors - -on: - pull_request: - types: - - labeled - -permissions: - contents: read - -jobs: - comment-that-approved: - name: Add review template - runs-on: ubuntu-latest - if: github.event.label.name == 'add-review-template' && github.repository == 'github/docs-internal' - - steps: - - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - - # Jump through some hoops to work with a multi-line file - - name: Store review template in variable - run: | - TEMPLATE=$(cat .github/review-template.md) - echo "TEMPLATE<> $GITHUB_ENV - echo "$TEMPLATE" >> $GITHUB_ENV - echo "EOF" >> $GITHUB_ENV - - - name: Comment on the PR - run: | - gh pr comment $PR --body "$TEMPLATE" - env: - GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WORKFLOW_READORG }} - PR: ${{ github.event.pull_request.html_url }} - TEMPLATE: ${{ env.TEMPLATE }} diff --git a/.github/workflows/comment-release-note-info.yml b/.github/workflows/comment-release-note-info.yml index d1b6e4059a14..e34eacd0f323 100644 --- a/.github/workflows/comment-release-note-info.yml +++ b/.github/workflows/comment-release-note-info.yml @@ -25,7 +25,7 @@ jobs: with: issue-number: ${{ github.event.pull_request.number }} body: | - Thank you for updating our GitHub Enterprise Server release notes. A member of the `docs-content-enterprise` team will review your changes. + Thank you for updating our GitHub Enterprise Server release notes. Please request a technical review for your changes. Once the technical review is complete, a member of the `docs-content-enterprise` team will review your changes. - If the change is urgent, post in `#docs-content-enterprise` on Slack. - Review the [style guide for release notes](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide#release-notes). diff --git a/.github/workflows/hubber-contribution-help.yml b/.github/workflows/hubber-contribution-help.yml index ed876e629532..0df92207b0f2 100644 --- a/.github/workflows/hubber-contribution-help.yml +++ b/.github/workflows/hubber-contribution-help.yml @@ -44,11 +44,11 @@ jobs: - name: Comment on the PR if: steps.membership_check.outputs.result == 'false' run: | - gh pr comment $PR --body "Thanks so much for opening this PR and contributing to GitHub Docs! + gh pr comment $PR --body "### Next: add the review label - - When you're ready for the Docs team to review this PR, add the *ready-for-doc-review* label to your PR, and it will be automatically added to the [Docs Content review board](https://github.com/orgs/github/memexes/901?layout=table&groupedBy%5BcolumnId%5D=11024). **Please factor in at least 72 hours for a review, even longer if this is a substantial change.** - - If you're adding a release note, request a technical review. The Docs team will review the PR after the technical review is complete. - - If your updates to the docs are more than a simple fix, you might want to go back and open an [issue](https://github.com/github/docs-content/issues/new/choose) to ensure we've covered all areas of the docs in these updates. Not doing so may result in delays or inaccurate documentation." + **🛎️ Is this PR ready for review?** A PR is ready for a docs review _after_ the self-review checklist is complete. + + 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._ env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/assets/images/help/desktop/configure-custom-editor.png b/assets/images/help/desktop/configure-custom-editor.png deleted file mode 100644 index 859d7ec8e0c0..000000000000 Binary files a/assets/images/help/desktop/configure-custom-editor.png and /dev/null differ diff --git a/content/admin/overview/about-the-github-enterprise-api.md b/content/admin/overview/about-the-github-enterprise-api.md index cb2b91dd3cc2..80f00dc99fc4 100644 --- a/content/admin/overview/about-the-github-enterprise-api.md +++ b/content/admin/overview/about-the-github-enterprise-api.md @@ -16,11 +16,9 @@ shortTitle: GitHub Enterprise API --- With the APIs, you can automate many administrative tasks. Some examples include: -* Perform changes to the {% data variables.enterprise.management_console %}. For more information, see -{% ifversion management-console-manage-ghes-parity -%} -"[AUTOTITLE](/rest/enterprise-admin/manage-ghes)." -{%- else -%} -"[AUTOTITLE](/rest/enterprise-admin/management-console)." + +{%- ifversion management-console-manage-ghes-parity %} +* Perform a configuration run to apply changes to {% data variables.enterprise.management_console %} settings. For more information, see "[AUTOTITLE](/rest/enterprise-admin/manage-ghes)." {%- endif %} * Configure LDAP sync. For more information, see "[AUTOTITLE](/rest/enterprise-admin/ldap)." * Collect statistics about your enterprise. For more information, see "[AUTOTITLE](/rest/enterprise-admin/admin-stats)." diff --git a/content/contributing/collaborating-on-github-docs/self-review-checklist.md b/content/contributing/collaborating-on-github-docs/self-review-checklist.md index 1704462f4012..595daf78a906 100644 --- a/content/contributing/collaborating-on-github-docs/self-review-checklist.md +++ b/content/contributing/collaborating-on-github-docs/self-review-checklist.md @@ -9,7 +9,6 @@ Before you submit your changes to the {% data variables.product.prodname_docs %} * Changes meet the **content goals and user needs** in the content design plan, if one has been created. * Content has been **confirmed for accuracy** by a subject matter expert (SME) in the technical area. -* Content follows **quality guidelines** in "[AUTOTITLE](/contributing/writing-for-github-docs/best-practices-for-github-docs)" and "[AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated)." -* Content is **free of errors** such as typos and adheres to the "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide)." +* Content satisfies {% data variables.product.github %}'s **documentation fundamentals** that are required for all content. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals)." * The article **renders properly on staging** for each version of the article (Free Pro Team, GHEC, GHES). * All **pull request checks** are passing. diff --git a/content/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals.md b/content/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals.md new file mode 100644 index 000000000000..7aa2bd7d4dcb --- /dev/null +++ b/content/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals.md @@ -0,0 +1,33 @@ +--- +title: About GitHub's documentation fundamentals +shortTitle: Documentation fundamentals +intro: 'All content published on {% data variables.product.prodname_docs %} must meet these fundamental requirements.' +versions: + feature: 'contributing' +--- + +## About {% data variables.product.github %}'s documentation fundamentals + +These fundamentals are required for {% data variables.product.github %} documentation. Use the lists below to help ensure your contributions are accurate, accessible and inclusive, and consistent. + +## Accurate + +Documentation is correct and accurate. + +* Ensure that the content is free from factual errors. +* Ensure that the content is free from spelling and formatting errors. + +## Accessible and inclusive + +Documentation is up to date with the latest accessibility standards, and is written to be inclusive and translation-friendly. + +* Ensure content adheres to the accessibility and screenshot guidelines. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/creating-screenshots)." +* Ensure content can be successfully translated. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/writing-content-to-be-translated)." + +## Consistent + +Documentation maintains a consistent voice, tone, and style throughout, creating a cohesive experience for readers. + +* Ensure content adheres to the {% data variables.product.prodname_docs %} style guide. For more information, see "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide)." +* Apply consistent terminology and naming conventions. +* Use branding elements (for example, product and feature names, logos, color schemes) consistently in the content. diff --git a/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md b/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md index 32692ed5ee9a..2435f3a5da9a 100644 --- a/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md +++ b/content/contributing/writing-for-github-docs/best-practices-for-github-docs.md @@ -10,9 +10,10 @@ versions: At {% data variables.product.prodname_dotcom %}, we strive to create documentation that is accurate, valuable, inclusive, accessible, and easy to use. -Before contributing to {% data variables.product.prodname_docs %}, please take a moment to familiarize yourself with {% data variables.product.prodname_dotcom %}'s documentation philosophy and content design principles: +Before contributing to {% data variables.product.prodname_docs %}, please take a moment to familiarize yourself with {% data variables.product.prodname_dotcom %}'s documentation philosophy, fundamentals, and content design principles: * [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-philosophy) +* [AUTOTITLE](/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals) * [AUTOTITLE](/contributing/writing-for-github-docs/content-design-principles) ## Best practices for writing {% data variables.product.prodname_dotcom %} documentation diff --git a/content/contributing/writing-for-github-docs/index.md b/content/contributing/writing-for-github-docs/index.md index e2c648ea2eed..235a8f8cc97f 100644 --- a/content/contributing/writing-for-github-docs/index.md +++ b/content/contributing/writing-for-github-docs/index.md @@ -7,6 +7,7 @@ versions: children: - /best-practices-for-github-docs - /about-githubs-documentation-philosophy + - /about-githubs-documentation-fundamentals - /content-design-principles - /writing-content-to-be-translated - /making-content-findable-in-search diff --git a/content/github-models/prototyping-with-ai-models.md b/content/github-models/prototyping-with-ai-models.md index 93fe4bdc9e94..af5dd0df2810 100644 --- a/content/github-models/prototyping-with-ai-models.md +++ b/content/github-models/prototyping-with-ai-models.md @@ -6,7 +6,7 @@ versions: feature: github-models --- -If you want to develop a generative AI application, you can use {% data variables.product.prodname_github_models %} to find and experiment with AI models for free. Once you are ready to bring your application to production, you can switch to a token from a paid Azure account. See the [Azure AI](https://ai.azure.com/github/model/docs) documentation. +If you want to develop a generative AI application, you can use {% data variables.product.prodname_github_models %} to find and experiment with AI models for free. Once you are ready to bring your application to production, you can switch to a token from a paid Azure account. See the [Azure AI](https://aka.ms/azureai/github-models) documentation. See also "[AUTOTITLE](/github-models/responsible-use-of-github-models)." diff --git a/content/github-models/responsible-use-of-github-models.md b/content/github-models/responsible-use-of-github-models.md index 0ab3b65fe139..b50c2a565c20 100644 --- a/content/github-models/responsible-use-of-github-models.md +++ b/content/github-models/responsible-use-of-github-models.md @@ -9,4 +9,4 @@ type: rai With {% data variables.product.prodname_github_models %}, you build your understanding of AI model capabilities by experimenting with model settings and sending prompts through a chat interface. Additionally, you can directly interact with models through an SDK. Refer to a model's "Getting Started" tab for more information about how to use the SDK. Refer to a model’s "README" tab for more information on the model. Remember when interacting with a model you are experimenting with AI, so content mistakes are possible. -{% data variables.product.prodname_github_models %} is designed to allow for learning, experimentation and proof-of-concept activities. The feature is subject to various limits (including requests per minute, requests per day, tokens per request, and concurrent requests) and is not designed for production use cases. {% data variables.product.prodname_github_models %} employs a number of [content filters](https://azure.microsoft.com/en-us/products/ai-services/ai-content-safety). These filters cannot be turned off as part of the {% data variables.product.prodname_github_models %} experience. If you decide to employ models through [Azure AI](https://ai.azure.com/github/model/docs) or a paid service, please configure your content filters to meet your requirements. +{% data variables.product.prodname_github_models %} is designed to allow for learning, experimentation and proof-of-concept activities. The feature is subject to various limits (including requests per minute, requests per day, tokens per request, and concurrent requests) and is not designed for production use cases. {% data variables.product.prodname_github_models %} employs a number of [content filters](https://azure.microsoft.com/en-us/products/ai-services/ai-content-safety). These filters cannot be turned off as part of the {% data variables.product.prodname_github_models %} experience. If you decide to employ models through [Azure AI](https://aka.ms/azureai/github-models) or a paid service, please configure your content filters to meet your requirements. diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 8511c082c1b4..ebf810db3db8 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -44,13 +44,7 @@ autogenerated: rest ## Endpoint URLs -These endpoints -{% ifversion management-console-manage-ghes-parity -%} -—except Manage GitHub Enterprise Server API— -{%- else -%} -—except Management Console API— -{%- endif -%} - are prefixed with the following URL: +These endpoints{% ifversion ghes %}, except the Manage GitHub Enterprise Server API {% ifversion ghes < 3.15 %} and Management Console API{% endif %},{% endif %} are prefixed with the following URL: ```shell {% data variables.product.rest_url %} @@ -61,15 +55,11 @@ When endpoints include `{enterprise}`, replace `{enterprise}` with the handle fo {% endif %} {% ifversion ghes %} -{% ifversion management-console-manage-ghes-parity -%} -Manage GitHub Enterprise Server API -{%- else -%} -Management Console API -{%- endif %} -endpoints are only prefixed with a hostname: + +Endpoints for the Manage GitHub Enterprise Server API{% ifversion ghes < 3.15 %} and Management Console API{% endif %} are only prefixed with a hostname and administration port: ```shell -http(s)://HOSTNAME/ +http(s)://HOSTNAME:ADMINISTRATION-PORT/ ``` {% endif %} @@ -81,13 +71,7 @@ Your {% data variables.product.product_name %} installation's API endpoints acce OAuth tokens must have the `site_admin` [OAuth scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes) when used with these endpoints. -These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for the -{% ifversion management-console-manage-ghes-parity -%} -[AUTOTITLE](/rest/enterprise-admin/manage-ghes), -{%- else -%} -[AUTOTITLE](/rest/enterprise-admin/management-console), -{%- endif %} -which requires the [Management Console password](/admin/configuration/administering-your-instance-from-the-management-console). +These endpoints are only accessible to authenticated {% data variables.product.product_name %} site administrators, except for endpoints of the [AUTOTITLE](/rest/enterprise-admin/manage-ghes) API{% ifversion ghes < 3.15 %} and [AUTOTITLE](/rest/enterprise-admin/management-console) API{% endif %}, which allow authentication as a Management Console user. See "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console)." {% data reusables.enterprise_management_console.api-deprecation %} diff --git a/content/rest/enterprise-admin/manage-ghes.md b/content/rest/enterprise-admin/manage-ghes.md index 35af1e12ed8c..198546821609 100644 --- a/content/rest/enterprise-admin/manage-ghes.md +++ b/content/rest/enterprise-admin/manage-ghes.md @@ -53,7 +53,7 @@ By default, the response includes information from about all configured nodes fo | Query parameter | Description | | :- | :- | | `uuid` | Unique identifier for the node. | -| `cluster_role` | For nodes in a cluster, the roles that apply to the node. For more information, see "[AUTOTITLE)(/admin/enterprise-management/configuring-clustering/about-cluster-nodes)." | +| `cluster_role` | For nodes in a cluster, the roles that apply to the node. For more information, see "[AUTOTITLE](/admin/enterprise-management/configuring-clustering/about-cluster-nodes)." | You can specify multiple values for the query parameter by delimiting the values with a comma. For example, the following request uses curl to return any nodes with the `web-server` or `storage-server` role. diff --git a/data/features/dependabot-private-registries.yml b/data/features/dependabot-private-registries.yml deleted file mode 100644 index 92c86d8a2b1b..000000000000 --- a/data/features/dependabot-private-registries.yml +++ /dev/null @@ -1,5 +0,0 @@ -# Reference: Issue #8535 Dependabot does not access public registries when the user has configured private registries -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.8' diff --git a/data/features/dependabot-security-updates-npm.yml b/data/features/dependabot-security-updates-npm.yml deleted file mode 100644 index 3674b3983660..000000000000 --- a/data/features/dependabot-security-updates-npm.yml +++ /dev/null @@ -1,4 +0,0 @@ -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.8' diff --git a/data/features/dependabot-security-updates-unlock-transitive-dependencies.yml b/data/features/dependabot-security-updates-unlock-transitive-dependencies.yml deleted file mode 100644 index e1cab4855e28..000000000000 --- a/data/features/dependabot-security-updates-unlock-transitive-dependencies.yml +++ /dev/null @@ -1,5 +0,0 @@ -# Reference: Issue #7084 Dependabot unlocks parent dependencies on updates -versions: - fpt: '*' - ghec: '*' - ghes: '>=3.8' diff --git a/data/features/dependabot-updates-actions-reusable-workflows.yml b/data/features/dependabot-updates-actions-reusable-workflows.yml deleted file mode 100644 index 29fcb87506be..000000000000 --- a/data/features/dependabot-updates-actions-reusable-workflows.yml +++ /dev/null @@ -1,5 +0,0 @@ -# Reference: Issue #9693 - Dependabot Updates now can keep {% data variables.product.prodname_actions %} reusable workflows up to date - [GA] -versions: - fpt: '*' - ghec: '*' - ghes: '>3.8' diff --git a/data/features/dependabot-updates-paused.yml b/data/features/dependabot-updates-paused.yml deleted file mode 100644 index 4d82773e79f9..000000000000 --- a/data/features/dependabot-updates-paused.yml +++ /dev/null @@ -1,5 +0,0 @@ -# Reference: Issue #10199 - Dependabot: automatic, rolling opt-out for inactivity (Version updates, Security updates) - [GA] -versions: - fpt: '*' - ghec: '*' - ghes: '>3.9' diff --git a/data/reusables/actions/apply-configuration-and-enable.md b/data/reusables/actions/apply-configuration-and-enable.md deleted file mode 100644 index 6b5d01b81127..000000000000 --- a/data/reusables/actions/apply-configuration-and-enable.md +++ /dev/null @@ -1,5 +0,0 @@ -1. To apply the configuration and enable {% data variables.product.prodname_actions %} to connect to your external storage provider, enter the following command. - - ```shell copy - ghe-config-apply - ``` diff --git a/data/reusables/copilot/example-prompts/responses-are-examples.md b/data/reusables/copilot/example-prompts/responses-are-examples.md deleted file mode 100644 index ae9cc39d2762..000000000000 --- a/data/reusables/copilot/example-prompts/responses-are-examples.md +++ /dev/null @@ -1 +0,0 @@ -> [!NOTE] The following responses are examples. {% data variables.product.prodname_copilot_chat_short %} responses are non-deterministic, so you may get different responses from the ones shown here. diff --git a/src/landings/components/CategoryLanding.tsx b/src/landings/components/CategoryLanding.tsx index f004f3b844e0..8dac7779ef31 100644 --- a/src/landings/components/CategoryLanding.tsx +++ b/src/landings/components/CategoryLanding.tsx @@ -132,9 +132,9 @@ export const CategoryLanding = () => { /> -