-
- Notifications
You must be signed in to change notification settings - Fork 13
Documentation style guide #202
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
15 commits Select commit Hold shift + click to select a range
e66fa5f Added style guide stub page and referenced it
01bc5ac Added links to google examples
50ded99 kubernetes links and polishing
18e65bd removed comma
2ab4a9a minor formulation changes
12fc648 minor formulation changes
82ec7e2 Merge branch 'main' into style-guide
fhennig dd160b5 Update modules/contributor/pages/style_guide.adoc
fhennig bcf3524 Update modules/contributor/pages/style_guide.adoc
fhennig 50174ff Update modules/contributor/pages/style_guide.adoc
fhennig 1b84edf Update modules/contributor/pages/style_guide.adoc
fhennig 97851fb Update modules/contributor/pages/steps.adoc
fhennig bf3a075 minor formulation changes
cb761cd Removed my notes left here accidentally
8ccf817 Merge branch 'main' into style-guide
fhennig File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added style guide stub page and referenced it
- Loading branch information
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,14 @@ | ||
| # Documentation style guide | ||
| | ||
| // make this document a whole "How to contribute documentation" (?) | ||
| // just a style guide? | ||
| // should we document also stuff about the structure? | ||
| // what about graphics? | ||
| | ||
| // graphics and a whole "How to contribute docs" is not in the scope | ||
| // 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" | ||
fhennig marked this conversation as resolved. Outdated Show resolved Hide resolved | ||
| | ||
| For consistency and clarity, we provide some guidelines on how to write documentation. | ||
| | ||
| We follow the link:https://kubernetes.io/docs/contribute/style/style-guide/[Kubernetes documentation style guide] and the link:https://developers.google.com/style/[Google developer documentation style guide]. | ||
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.