github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

config best practices doc edits

Browse Source
This commit is contained in:
Amy Unruh
2015-12-03 15:53:33 -08:00
parent 3415f1dfc2
commit b1f99ecdbf
6 changed files with 131 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/devel/coding-conventions.md
View File

@@ -72,7 +72,8 @@ Directory and file conventions
- Package directories should generally avoid using separators as much as possible (when packages are multiple words, they usually should be in nested subdirectories).
- Document directories and filenames should use dashes rather than underscores
- Contrived examples that illustrate system features belong in /docs/user-guide or /docs/admin, depending on whether it is a feature primarily intended for users that deploy applications or cluster administrators, respectively. Actual application examples belong in /examples.
- Examples should also illustrate [best practices for using the system](../user-guide/config-best-practices.md)
- Examples should also illustrate
[best practices for configuration and using the system](../user-guide/config-best-practices.md)
- Third-party code
- Third-party Go code is managed using Godeps
- Other third-party code belongs in /third_party