From 7d465f492ea26a722042d8baa32f83f2dec99474 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 10 Dec 2020 15:12:04 -0800 Subject: [PATCH 1/3] this is a test - do not merge --- content/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/README.md b/content/README.md index 901427d4be71..f70350d0d611 100644 --- a/content/README.md +++ b/content/README.md @@ -1,5 +1,5 @@ # Content - +:octocat: The `/content` directory is where all the site's (English) Markdown content lives! See the [markup reference guide](/contributing/content-markup-reference.md) for more information about supported Markdown features. From d82f1d48f9de67d5dcd6bb3ae4be6065ee0b4a81 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 10 Dec 2020 15:13:24 -0800 Subject: [PATCH 2/3] add punctuation --- lib/rest/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/rest/README.md b/lib/rest/README.md index d2d1e7acd45c..b282bf737e50 100644 --- a/lib/rest/README.md +++ b/lib/rest/README.md @@ -13,13 +13,13 @@ Generated by `script/rest/update-files.js`: -* `lib/rest/static/dereferenced` - dereferenced OpenAPI schema file for each version of GitHub -* `lib/rest/static/decorated` - files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML +* `lib/rest/static/dereferenced` - dereferenced OpenAPI schema file for each version of GitHub. +* `lib/rest/static/decorated` - files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML. ## Rendering docs When the server starts, `middleware/contextualizers/rest.js` accesses the data exported from the static decorated JSON files, fetches the data for the current version and requested path, and adds it to the `context` object. The added property is: -* `req.context.currentRestOperations` - all operations with a category matching the current path +* `req.context.currentRestOperations` - all operations with a category matching the current path. Markdown files in `content/rest/reference` use Liquid to loop over these context properties. The Liquid calls HTML files in the `includes` directory to do most of the rendering. Writers can add content to the Markdown files alongside the Liquid. From 9fc25dae9a7559bd4b7ddd88c39e62fac864af53 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Thu, 10 Dec 2020 15:18:54 -0800 Subject: [PATCH 3/3] plural --- lib/rest/static/decorated/api.github.com.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index f5234c81ccac..70a96716d37e 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -6,7 +6,7 @@ "parameters": [], "x-codeSamples": [ { - "lang": "Shell", + "lang": "Shells", "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/", "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/
" },