From f48e0a5d8eeab6f666dcbf200f50ade7b035b630 Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Tue, 8 Dec 2020 16:29:46 +1000 Subject: [PATCH 1/4] Add READMEs for API content directories --- README.md | 2 ++ content/graphql/README.md | 10 ++++++++++ content/rest/README.md | 10 ++++++++++ 3 files changed, 22 insertions(+) create mode 100644 content/graphql/README.md create mode 100644 content/rest/README.md diff --git a/README.md b/README.md index 1b126769c8a4..2f0e3758d242 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,8 @@ There are a few more things to know when you're getting started with this repo: In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail: - [content/README.md](content/README.md) +- [content/rest/README.md](content/rest/README.md) +- [content/graphql/README.md](content/graphql/README.md) - [contributing/README.md](contributing/README.md) - [data/README.md](data/README.md) - [data/reusables/README.md](data/reusables/README.md) diff --git a/content/graphql/README.md b/content/graphql/README.md new file mode 100644 index 000000000000..7b26d5e4b1b7 --- /dev/null +++ b/content/graphql/README.md @@ -0,0 +1,10 @@ +# GraphQL + +The `/content/graphql` directory is where the GitHub GraphQL API docs live! + +* The `/content/graphql/guides` and `/content/graphql/overview` directories contain regular articles. These are human-editable. +* The `/content/graphql/reference` directory contains a skeleton structure for the GraphQL API reference. However, most GraphQL API content inserted using `include`s. + + The content for the `include`s are generated from the API source code internally in GitHub, and is processed using the scripts and static `json` files in the `/lib/graphql` directory. + + **As a result, we cannot accept contributions to GraphQL API reference content in this repository.** diff --git a/content/rest/README.md b/content/rest/README.md new file mode 100644 index 000000000000..bb03cbc82084 --- /dev/null +++ b/content/rest/README.md @@ -0,0 +1,10 @@ +# REST + +The `/content/rest` directory is where the GitHub REST API docs live! + +* The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable. +* The `/content/rest/reference` directory contains a skeleton structure for the REST API reference. However, each REST API endpoint's content is inserted using `include`s. + + The content for the `include`s are generated from the API source code internally in GitHub, and is processed using the scripts and static `json` files in the `/lib/rest` directory. + + **As a result, we cannot accept contributions to REST API reference content in this repository.** From 409d13007272293bee3916400470116bf6b04695 Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Wed, 9 Dec 2020 11:17:29 +1000 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Rachael Sewell --- content/graphql/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/graphql/README.md b/content/graphql/README.md index 7b26d5e4b1b7..47f4ccce5d0a 100644 --- a/content/graphql/README.md +++ b/content/graphql/README.md @@ -2,9 +2,9 @@ The `/content/graphql` directory is where the GitHub GraphQL API docs live! -* The `/content/graphql/guides` and `/content/graphql/overview` directories contain regular articles. These are human-editable. -* The `/content/graphql/reference` directory contains a skeleton structure for the GraphQL API reference. However, most GraphQL API content inserted using `include`s. +* The `/content/graphql/guides` and `/content/graphql/overview` directories contain articles that are human-editable. +* The `/content/graphql/reference` directory contains an article for each GraphQL data type used in the GitHub API. Most of the content in this directory is rendered using the `include` tag. - The content for the `include`s are generated from the API source code internally in GitHub, and is processed using the scripts and static `json` files in the `/lib/graphql` directory. + The content rendered by the `include` tag is sourced from the `lib/graphql/static` directory, which is automatically generated and should not be edited by a human. For more information, see the [`lib/graphql/README.md`](lib/graphql/README.md). **As a result, we cannot accept contributions to GraphQL API reference content in this repository.** From b3060cdf2591eeca2d24f1d2608f944b61a2356c Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Wed, 9 Dec 2020 13:53:10 +1000 Subject: [PATCH 3/4] Little fixes --- content/graphql/README.md | 4 ++-- content/rest/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/graphql/README.md b/content/graphql/README.md index 47f4ccce5d0a..f29fbc513144 100644 --- a/content/graphql/README.md +++ b/content/graphql/README.md @@ -3,8 +3,8 @@ The `/content/graphql` directory is where the GitHub GraphQL API docs live! * The `/content/graphql/guides` and `/content/graphql/overview` directories contain articles that are human-editable. -* The `/content/graphql/reference` directory contains an article for each GraphQL data type used in the GitHub API. Most of the content in this directory is rendered using the `include` tag. +* The `/content/graphql/reference` directory contains an article for each GraphQL data type used in the GitHub GraphQL API. Most of the content in this directory is rendered using `include` tags. - The content rendered by the `include` tag is sourced from the `lib/graphql/static` directory, which is automatically generated and should not be edited by a human. For more information, see the [`lib/graphql/README.md`](lib/graphql/README.md). + The content rendered by `include` tags is sourced from the `/lib/graphql/static` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/lib/graphql/README.md`](/lib/graphql/README.md). **As a result, we cannot accept contributions to GraphQL API reference content in this repository.** diff --git a/content/rest/README.md b/content/rest/README.md index bb03cbc82084..55aaa5edda1d 100644 --- a/content/rest/README.md +++ b/content/rest/README.md @@ -3,8 +3,8 @@ The `/content/rest` directory is where the GitHub REST API docs live! * The `/content/rest/guides` and `/content/rest/overview` directories contain regular articles. These are human-editable. -* The `/content/rest/reference` directory contains a skeleton structure for the REST API reference. However, each REST API endpoint's content is inserted using `include`s. +* The `/content/rest/reference` directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using `include` tags. - The content for the `include`s are generated from the API source code internally in GitHub, and is processed using the scripts and static `json` files in the `/lib/rest` directory. + The content rendered by `include` tags is sourced from the `/lib/rest/static` directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the [`/lib/rest/README.md`](/lib/rest/README.md). **As a result, we cannot accept contributions to REST API reference content in this repository.** From ae417c5acd14e93b6915322ed402c68a2f858a5b Mon Sep 17 00:00:00 2001 From: Lucas Costi Date: Wed, 9 Dec 2020 13:55:17 +1000 Subject: [PATCH 4/4] Make list alphabetical --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f0e3758d242..9a493e9e4576 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,8 @@ There are a few more things to know when you're getting started with this repo: In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail: - [content/README.md](content/README.md) -- [content/rest/README.md](content/rest/README.md) - [content/graphql/README.md](content/graphql/README.md) +- [content/rest/README.md](content/rest/README.md) - [contributing/README.md](contributing/README.md) - [data/README.md](data/README.md) - [data/reusables/README.md](data/reusables/README.md)