From d81f9a00429b58581a552ec61d4a59d8676df540 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:33:35 -0700 Subject: [PATCH 1/2] Update audit log event data (#43456) --- src/audit-logs/lib/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 997ad271b638..f6f22d6ffc4a 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "014ee19105fa3d00686ecb66731fe68aa3e7e8cd" + "sha": "a9c6b05784cb6785a49d9d120bf25a7dd4e75f02" } \ No newline at end of file From 580a7dd9ccd78a45341931b18889384c9cb7dbb8 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 28 Sep 2023 09:45:28 -0700 Subject: [PATCH 2/2] Add info about pipes in table rows to contributing docs (#43402) Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com> --- .../using-markdown-and-liquid-in-github-docs.md | 10 ++++++++++ .../writing-for-github-docs/style-guide.md | 2 ++ 2 files changed, 12 insertions(+) diff --git a/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md b/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md index 30009330d56d..58f78c16c05b 100644 --- a/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md +++ b/content/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs.md @@ -302,6 +302,16 @@ Reusable strings (commonly called content references or conrefs) contain content For longer strings, we use reusables, and for shorter strings, we use variables. For more information about reusables and variables, see "[AUTOTITLE](/contributing/writing-for-github-docs/creating-reusable-content)." +## Table pipes + +Every row of a table in the {% data variables.product.prodname_docs %} must start and end with a pipe, `|`. + +```markdown +| Where is the table located? | Does every row end with a pipe? | +| --- | --- | +| GitHub Docs | Yes | +``` + ## Table row headers If you create a table where the first column contains headers for the table rows, wrap your table in the Liquid tag {% raw %}`{% rowheaders %} {% endrowheaders %}`{% endraw %}. For more information on using markup for tables, see "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#use-proper-markup-for-row-and-column-headers)." diff --git a/content/contributing/writing-for-github-docs/style-guide.md b/content/contributing/writing-for-github-docs/style-guide.md index 5c7428f3e7ef..171ab7227a06 100644 --- a/content/contributing/writing-for-github-docs/style-guide.md +++ b/content/contributing/writing-for-github-docs/style-guide.md @@ -951,6 +951,8 @@ TEXT ## Tables +Tables are added to the {% data variables.product.prodname_docs %} using Markdown. Because tables can be challenging to read and maintain, make sure that the data in a table is best represented in a table and not another format, like a list, before creating a table. Every row in a table must begin and end with a pipe, `|`. + ### Use tables only for presenting tabular information Tables work best for presenting tabular data, such as information that needs to be compared or values with multiple attributes. Do not use tables for simple lists - see the "[Lists](#lists)" section of this document.