From d8830b64fc825f9a88fede28341c59b534ec4ae7 Mon Sep 17 00:00:00 2001 From: Charles Smith Date: Thu, 4 Jan 2024 14:02:32 -0800 Subject: [PATCH] add style for table formatting to docs contribution (#15612) Co-authored-by: Benedict Jin Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com> --- docs/development/docs-contribute.md | 26 ++++++++++++++++++++++++++ website/.spelling | 1 + 2 files changed, 27 insertions(+) diff --git a/docs/development/docs-contribute.md b/docs/development/docs-contribute.md index 1edce05cf59..2c4bfab494f 100644 --- a/docs/development/docs-contribute.md +++ b/docs/development/docs-contribute.md @@ -169,6 +169,32 @@ HUMAN_READABLE_BINARY_BYTE_FORMAT(value[, precision]) HUMAN_READABLE_BINARY_BYTE_FORMAT(value, \[precision]) ::: +#### Markdown table format + +When editing or adding tables, do not include extra characters to "prettify" the table format within the Markdown source. +Some code editors may format tables by default. +See the developer [style guide](https://github.com/apache/druid/blob/master/dev/style-conventions.md) for more information. + +:::tip + +**Correct** + +```markdown +| Column 1 | Column 2 | Column 3 | +| --- | --- | --- | +| value 1 | val 2 | a-very-long-value 3 | +``` + +**Incorrect** + +```markdown +| Column 1 | Column 2 | Column 3 | +| -------- | -------- | ------------------- | +| value 1 | val 2 | a-very-long-value 3 | +``` + +::: + ### Style checklist Before publishing new content or updating an existing topic, you can audit your documentation using the following checklist to make sure your contributions align with existing documentation: diff --git a/website/.spelling b/website/.spelling index bb8d8009341..7561bcec965 100644 --- a/website/.spelling +++ b/website/.spelling @@ -131,6 +131,7 @@ InputFormat InputSource InputSources Integer.MAX_VALUE +IntelliJ ioConfig Istio JBOD