Skip to content
Prev Previous commit
Next Next commit
kubernetes links and polishing
  • Loading branch information
Felix Hennig committed Jun 1, 2022
commit 50ded99fa420fd63399bfecf32785c3892fce90c
12 changes: 7 additions & 5 deletions modules/contributor/pages/style_guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,15 @@
// probably not to be done for now (even though it would be nice to have)
// it sucks a bit to have the style guide a bit in a vacuum, but I think for now it would be fine. I could make a ticket for writing "How to contribute docs"

This page provides guidelines on how to write documentation for the Stackable platform. Style guidelines are provided specifying things such as capitalization rules, which format to use for emphasis or how API objects and other components should be styled in the documentation - formatting and "superficial" aspects of text. There are also guidelines on grammar, tone and voice, making the texts across the documentation consistent and as clear as possible; for example using a conversational tone, using second person and using active voice.
This page provides guidelines on how to write documentation for the Stackable platform. Style guidelines specify things such as capitalization rules, which format to use for emphasis or how API objects and other components should be styled in the documentation - formatting and "superficial" aspects of text. Grammar, tone and voice guidelines, make the texts across the documentation consistent and as clear as possible; for example using a conversational tone, using second person and active voice.

For specific formatting, we follow the link:https://kubernetes.io/docs/contribute/style/style-guide/[Kubernetes documentation style guide]. The Stackable platform is built on Kubernetes and the documentation often refers to Kubernetes API objects, custom resources and snippets of resource specifications, as well as command line snippets to interact with Kubernetes clusters. How to format these in the documentation is covered in the Kubernetes documentation style guide.
For specific formatting, follow the link:https://kubernetes.io/docs/contribute/style/style-guide/[Kubernetes documentation style guide]. The Stackable platform is built on Kubernetes and the documentation often refers to Kubernetes API objects, custom resources and snippets of resource specifications, as well as command line snippets to interact with Kubernetes clusters. How to format these in the documentation is covered in the Kubernetes documentation style guide. Some examples:

// TODO link examples here
- link:https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects[Use upper camel case for API objects] such as ConfigMap or KafkaCluster
- link:https://kubernetes.io/docs/contribute/style/style-guide/#use-italics-to-define-or-introduce-new-terms[Use italics to define or introduce new terms]
- link:https://kubernetes.io/docs/contribute/style/style-guide/#use-code-style-for-filenames-directories-and-paths[Use code style for filenames, directories and paths]
- link:https://kubernetes.io/docs/contribute/style/style-guide/#use-code-style-for-object-field-names-and-namespaces[Use code style for object field names and namespaces]
- link:https://kubernetes.io/docs/contribute/style/style-guide/#use-normal-style-for-string-and-integer-field-values[Use normal style for string and integer field values]

For general formatting, language, grammar and tone guidelines we refer to the link:https://developers.google.com/style/[Google developer documentation style guide]. Some highlights:

Expand All @@ -24,6 +28,4 @@ For general formatting, language, grammar and tone guidelines we refer to the li

The Google guide also includes it's own list of link:https://developers.google.com/style/highlights[highlights].

// TODO link examples here

Lastly, these are guidelines and not strict rules to follow. Use your own judgement to clearly communicate and explain - after all this is what documentation is about.