-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update docs 1. Simplify installation steps 2. Remove 'usage' section and promote its subsections to main sections 3. Add 'next step' to tutorial 4. Remove obsolete Helm instructions page 5. Remove redundant prefix in page titles 6. Update copyright info. in footer Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Add documentation style guide Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Address feedback Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Address Pavan's feedback Signed-off-by: Ivan Sim <ivan.sim@kasten.io> * Update docs/README.md Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
- Loading branch information
1 parent
3439902
commit 0c3c45d
Showing
17 changed files
with
127 additions
and
497 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## Kanister Documentation | ||
|
||
This folder contains the source of the Kanister documentation at | ||
https://docs.kanister.io | ||
|
||
## Building The Source | ||
|
||
The contents are written in the | ||
[reStructuredText](https://docutils.sourceforge.io/rst.html) format. | ||
|
||
To rebuild the documentation, run this command from the project root folder: | ||
|
||
```sh | ||
make docs | ||
``` | ||
|
||
The `docs` target uses the `ghcr.io/kanisterio/docker-sphinx` public image to | ||
generate the HTML documents and store them in your local `/docs/_build/html` | ||
folder. | ||
|
||
## Language, Grammar, and Tone | ||
|
||
When updating the documentation content, please follow these guidelines on the | ||
language, grammar, and tone style: | ||
|
||
* Documentation should be written in English. | ||
* Prefer an active voice and present tense when possible. | ||
* Use simple and direct language. | ||
* Use gender-neutral language. | ||
* Avoid personal pronouns ("I," "we," "us," "our," and "ours"). | ||
* Address the reader as "you" instead of "we". | ||
* Do not use Latin phrases. | ||
* Avoid jargon and idioms. | ||
* If using acronyms, ensure they are clearly defined in the same document. | ||
* If using an abbreviation, spell it out the first time it is used in the document unless it is commonly known. (example: TCP/IP) | ||
* When referring to a Kubernetes Group (SIG, WG, or UG) do not use the hyphenated form unless it is for a specific purpose such as a file-name or URI. | ||
|
||
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.