Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add style for table formatting to docs contribution (#15612) 

Co-authored-by: Benedict Jin <asdf2014@apache.org>
Co-authored-by: 317brian <53799971+317brian@users.noreply.github.com>
This commit is contained in:
Charles Smith 2024-01-04 14:02:32 -08:00 committed by GitHub
parent c937068625
commit d8830b64fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/development/docs-contribute.md
View File

@ -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:

1
website/.spelling
View File

@ -131,6 +131,7 @@ InputFormat
InputSource
InputSources
Integer.MAX_VALUE
IntelliJ
ioConfig
Istio
JBOD