Skip to content

Commit

Permalink
Added rST styling instructions (#1587)
Browse files Browse the repository at this point in the history
* Added rST styling instructions

* Fixed spelling error

* Addressed Ivan and Pavan's review comments

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
  • Loading branch information
3 people committed Sep 3, 2022
1 parent 226f8ce commit 35977ce
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,13 @@ These guidelines are derived from the
[cheatsheet](https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md#cheatsheet-content-design-formatting-and-language)
in the Kubernetes community style guide. Take a look at some of their examples
[here](https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md#language-grammar-and-tone).

## reStructured Text Styling Guide

* Use `*` for bullet points.
* Section headers are created using underlines with text. Underlining hierarchy is:
* `*` for chapters
* `=` for sections
* `-` for subsections
* `^` for subsubsections
* `"` for paragraphs

0 comments on commit 35977ce

Please sign in to comment.