From f0ef059f7c150e0862b8ecc0118dcace83f12e08 Mon Sep 17 00:00:00 2001 From: Thai Pangsakulyanont Date: Thu, 8 Oct 2020 22:35:04 +0700 Subject: [PATCH 1/2] Fix indentation inside Code Examples In the Code Examples section, the YAML shown looks like, but is not, a valid GitHub Actions workflow file. The `schedule:` section is inside the `on:`. This helps the reader understand the context better that `schedule:` is not a standalone block, but is supposed to be in the `on:` section. --- contributing/content-style-guide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index b7931f1eab45..0fef40387773 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -118,15 +118,15 @@ When code examples refer to a larger file, show the relevant section of the file ``` on: -schedule: - - cron: "40 19 * * *" + schedule: + - cron: "40 19 * * *" ``` - **Avoid:** ``` -schedule: - - cron: "40 19 * * *" + schedule: + - cron: "40 19 * * *" ``` ## Headers From b52750e6b258d80595c3d28bf62c58fe54f3967c Mon Sep 17 00:00:00 2001 From: Thai Pangsakulyanont Date: Fri, 16 Oct 2020 01:05:57 +0700 Subject: [PATCH 2/2] Remove leading indentation in Code Examples See discussion here: https://github.com/github/docs/pull/271/files#r502720912 --- contributing/content-style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 0fef40387773..3a34a55b02b8 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -125,8 +125,8 @@ on: - **Avoid:** ``` - schedule: - - cron: "40 19 * * *" +schedule: + - cron: "40 19 * * *" ``` ## Headers