Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add some existing conventions to the docs style guide #13809

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add some existing conventions to the docs style guide #13809

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/doc-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,14 @@ General guidelines:

* Explain when you would want to use a feature.
* Provide working examples.
* Prefer to [embed files](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#embedding-external-files) from the `examples/` directory.
* Format code using back-ticks to avoid it being reported as a spelling error.
* Prefer 1 sentence per line of markdown
* Prefer 1 sentence per line of markdown.
* Internally, refer to "Argo Workflows" as "Argo", unless a disambiguation is needed (such as when integrating with Argo CD).
* Use relative links to other pages or sections
* For example, `[architecture](architecture.md)`
* When documenting a new feature, add an in-line version annotation
* For example, `> v3.6 and after`
* 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.
Expand Down
Loading