Skip to content

Commit

Permalink
docs: update style guidelines for documentation contributions (#11712)
Browse files Browse the repository at this point in the history
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
  • Loading branch information
Anton Gilgur authored Sep 14, 2023
1 parent 55bb518 commit c81fcdc
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Dataflow
DeleteObject
DevOps
Dex
EditorConfig
EtcD
EventRouter
FailFast
Expand Down Expand Up @@ -104,6 +105,7 @@ s3
SDKs
ServiceAccount
Sharding
shortcodes
Singer.io
Snyk
Sumit
Expand Down
12 changes: 7 additions & 5 deletions docs/doc-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

Docs help our customers understand how to use workflows and fix their own problems.

Doc changes are checked for spelling, broken links, and lint issues by CI. To check locally run `make docs`.
Doc changes are checked for spelling, broken links, and lint issues by CI. To check locally, run `make docs`.

General guidelines:

* Explain when you would want to use a feature.
* Provide working examples.
* Use simple short sentences and avoid jargon.
* Format code using back-ticks to avoid it being reported spelling error.
* Avoid use title-case mid-sentence. E.g. instead of "the Workflow", write "the workflow".
* Headings should be title-case. E.g. instead of "and", write "And".
* Format code using back-ticks to avoid it being reported as a spelling error.
* Follow the recommendations in the official [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/).
* Particularly useful sections include [Content best practices](https://kubernetes.io/docs/contribute/style/style-guide/#content-best-practices) and [Patterns to avoid](https://kubernetes.io/docs/contribute/style/style-guide/#patterns-to-avoid).
* **Note**: Argo does not use the same tooling, so the sections on "shortcodes" and "EditorConfig" are not relevant.

## Running Locally

Expand Down

0 comments on commit c81fcdc

Please sign in to comment.