Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo sync #35421

Merged
merged 6 commits into from
Nov 25, 2024
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
9 changes: 4 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for contributing to this project! You must fill out the information be

### Why:

Closes:
Closes:

<!-- If there's an existing issue for your change, please link to it above.
If there's _not_ an existing issue, please open one first to make it more likely that this update will be accepted: https://github.com/github/docs/issues/new/choose. -->
Expand All @@ -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.
36 changes: 0 additions & 36 deletions .github/review-template.md

This file was deleted.

39 changes: 0 additions & 39 deletions .github/workflows/add-review-template.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/comment-release-note-info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/hubber-contribution-help.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
Binary file not shown.
8 changes: 3 additions & 5 deletions content/admin/overview/about-the-github-enterprise-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions content/contributing/writing-for-github-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/github-models/prototyping-with-ai-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)."

Expand Down
2 changes: 1 addition & 1 deletion content/github-models/responsible-use-of-github-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
26 changes: 5 additions & 21 deletions content/rest/enterprise-admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand All @@ -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 %}
Expand All @@ -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 %}

Expand Down
2 changes: 1 addition & 1 deletion content/rest/enterprise-admin/manage-ghes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
5 changes: 0 additions & 5 deletions data/features/dependabot-private-registries.yml

This file was deleted.

4 changes: 0 additions & 4 deletions data/features/dependabot-security-updates-npm.yml

This file was deleted.

This file was deleted.

This file was deleted.

5 changes: 0 additions & 5 deletions data/features/dependabot-updates-paused.yml

This file was deleted.

5 changes: 0 additions & 5 deletions data/reusables/actions/apply-configuration-and-enable.md

This file was deleted.

This file was deleted.

Loading
Loading