Skip to content

Commit 2b0a7a8

Browse files
authored
Merge branch 'main' into update-autofix-docs-python-support
2 parents 8aec09c + 6a94b2d commit 2b0a7a8

File tree

59 files changed

+287
-83
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+287
-83
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 'Check content-linter rules docs'
2+
3+
# **What it does**: Makes sure the content-linter-rules.md is up-to-date.
4+
# **Why we have it**: So what's automated doesn't fall behind
5+
# **Who does it impact**: Docs content.
6+
7+
on:
8+
workflow_dispatch:
9+
pull_request:
10+
paths:
11+
- 'src/content-linter/**'
12+
# In case imported markdownlint rules are updated
13+
- package-lock.json
14+
# In case manual changes are made to the content-linter-rules.md file
15+
- data/reusables/contributing/content-linter-rules.md
16+
# Self-test
17+
- .github/workflows/content-linter-rules-docs.yml
18+
19+
permissions:
20+
contents: read
21+
22+
jobs:
23+
check-content-linter-rules-docs:
24+
runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
25+
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
29+
30+
- uses: ./.github/actions/node-npm-setup
31+
32+
- name: Check that content-linter-rules.md is up-to-date
33+
run: npm run generate-content-linter-docs
34+
35+
- name: Fail if it isn't up-to-date
36+
run: |
37+
if [ -n "$(git status --porcelain)" ]; then
38+
git status
39+
git diff
40+
41+
# Some whitespace for the sake of the message below
42+
echo ""
43+
echo ""
44+
45+
echo "content-linter-rules.md is out of date."
46+
echo "Please run 'npm run generate-content-linter-docs' and commit the changes."
47+
exit 1;
48+
fi
Loading
Loading

content/apps/oauth-apps/building-oauth-apps/best-practices-for-creating-an-oauth-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ In the event that user access tokens are compromised, you should immediately rev
5858

5959
Your OAuth app can be accessed by users outside your organization or enterprise. If you intend an app to be used only by members of your organization or enterprise, you should check the user's membership status when the user signs in to your app.
6060

61-
To find the list of organizations a user is a member of, you can use the "List organizations for the authenticated user" endpoint. Then you can validate this list against a list of approved organizations for your app. For more information, see "[AUTOTITLE](/rest/orgs/orgs#list-organizations-for-the-authenticated-user)" in the REST API documentation.
61+
To find the list of organizations a user is a member of, you can use the "List organizations for the authenticated user" endpoint. Then you can validate this list against a list of approved organizations for your app. For more information, see "[AUTOTITLE](/rest/orgs/orgs#list-organizations-for-the-authenticated-user)."
6262

6363
{% data reusables.emus.oauth-app-note %}
6464

content/apps/using-github-apps/installing-a-github-app-from-a-third-party.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Anyone can install {% data variables.product.prodname_github_apps %} on their pe
3636

3737
Organization owners can install {% data variables.product.prodname_github_apps %} on their organization.
3838

39-
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}.
39+
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization permissions or the "repository administration" permission. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}.
4040

4141
Organization members who are not organization owners or repository admins can still select the organization during the install process. Instead of installing the app, {% data variables.product.company_short %} will send a notification to the organization owner to request the organization owner to install the app.
4242

content/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Organization owners can install {% data variables.product.prodname_github_apps %
4444

4545
For enterprises that pay by credit card, enterprise owners who are also organization owners can install {% data variables.product.prodname_github_apps %} on organizations within their enterprise.
4646

47-
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}.
47+
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_apps %} on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization permissions or the "repository administration" permission. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_apps %}.
4848

4949
The "app manager" role in an organization does not give a person the ability to install a {% data variables.product.prodname_github_app %} in the organization. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)."
5050

content/graphql/guides/forming-calls-with-graphql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ For a real-world example, see "[Example mutation](#example-mutation)."
114114

115115
## Working with variables
116116

117-
[Variables](https://graphql.github.io/learn/queries/#variables) can make queries more dynamic and powerful, and they can reduce complexity when passing mutation input objects.
117+
[Variables](https://graphql.org/learn/queries/#variables) can make queries more dynamic and powerful, and they can reduce complexity when passing mutation input objects.
118118

119119
{% note %}
120120

@@ -398,7 +398,7 @@ You may notice that the `content` field value in the earlier example (where it's
398398
- When you use `content` directly in the mutation, the schema expects the value to be of type [`ReactionContent`](/graphql/reference/enums#reactioncontent), which is an _enum_, not a string. Schema validation will throw an error if you add quotes around the enum value, as quotes are reserved for strings.
399399
- When you use `content` in a variable, the variables section must be valid JSON, so the quotes are required. Schema validation correctly interprets the `ReactionContent` type when the variable is passed into the mutation during execution.
400400

401-
For more information on the difference between enums and strings, see the [official GraphQL spec](https://graphql.github.io/graphql-spec/June2018/#sec-Enums).
401+
For more information on the difference between enums and strings, see the [official GraphQL spec](https://spec.graphql.org/June2018/#sec-Enums).
402402

403403
{% endnote %}
404404

content/graphql/guides/introduction-to-graphql.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ The GitHub GraphQL API represents an architectural and conceptual shift from the
1818

1919
## Schema
2020

21-
A schema defines a GraphQL API's type system. It describes the complete set of possible data (objects, fields, relationships, everything) that a client can access. Calls from the client are [validated](https://graphql.github.io/learn/validation/) and [executed](https://graphql.github.io/learn/execution/) against the schema. A client can find information about the schema via [introspection](#discovering-the-graphql-api). A schema resides on the GraphQL API server. For more information, see "[Discovering the GraphQL API](#discovering-the-graphql-api)."
21+
A schema defines a GraphQL API's type system. It describes the complete set of possible data (objects, fields, relationships, everything) that a client can access. Calls from the client are [validated](https://graphql.org/learn/validation/) and [executed](https://graphql.org/learn/execution/) against the schema. A client can find information about the schema via [introspection](#discovering-the-graphql-api). A schema resides on the GraphQL API server. For more information, see "[Discovering the GraphQL API](#discovering-the-graphql-api)."
2222

2323
## Field
2424

25-
A field is a unit of data you can retrieve from an object. As the [official GraphQL docs](https://graphql.github.io/learn/schema/) say:
25+
A field is a unit of data you can retrieve from an object. As the [official GraphQL docs](https://graphql.org/learn/schema/) say:
2626
"The GraphQL query language is basically about selecting fields on objects."
2727

28-
The [official spec](https://graphql.github.io/graphql-spec/June2018/#sec-Language.Fields) also says about fields:
28+
The [official spec](https://spec.graphql.org/June2018/#sec-Language.Fields) also says about fields:
2929

3030
> All GraphQL operations must specify their selections down to fields which return scalar values to ensure an unambiguously shaped response.
3131
@@ -78,7 +78,7 @@ _Node_ is a generic term for an object. You can look up a node directly, or you
7878

7979
## Discovering the GraphQL API
8080

81-
GraphQL is [introspective](https://graphql.github.io/learn/introspection/). This means you can query a GraphQL schema for details about itself.
81+
GraphQL is [introspective](https://graphql.org/learn/introspection/). This means you can query a GraphQL schema for details about itself.
8282

8383
- Query `__schema` to list all types defined in the schema and get details about each:
8484

content/graphql/guides/migrating-from-rest-to-graphql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Migrating from REST to GraphQL represents a significant shift in API logic. The
2121

2222
To migrate your code from the [REST API](/rest) to the GraphQL API:
2323

24-
- Review the [GraphQL spec](https://graphql.github.io/graphql-spec/June2018/)
24+
- Review the [GraphQL spec](https://spec.graphql.org/June2018/)
2525
- Review GitHub's [GraphQL schema](/graphql/reference)
2626
- Consider how any existing code you have currently interacts with the GitHub REST API
2727
- Use [Global Node IDs](/graphql/guides/using-global-node-ids) to reference objects between API versions

content/graphql/guides/using-global-node-ids.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ When you run this query, you'll see that the `__typename` is [`User`](/graphql/r
107107

108108
## 3. Do a direct node lookup in GraphQL
109109

110-
Once you've confirmed the type, you can use an [inline fragment](https://graphql.github.io/learn/queries/#inline-fragments) to access the object by its ID and return additional data. In this example, we define the fields on `User` that we'd like to query:
110+
Once you've confirmed the type, you can use an [inline fragment](https://graphql.org/learn/queries/#inline-fragments) to access the object by its ID and return additional data. In this example, we define the fields on `User` that we'd like to query:
111111

112112
```graphql
113113
query {

0 commit comments

Comments
 (0)