summaryrefslogtreecommitdiff
path: root/coding-conventions.md
diff options
context:
space:
mode:
authorAmy Unruh <amyu@google.com>2015-12-03 15:53:33 -0800
committerAmy Unruh <amyu@google.com>2015-12-16 07:35:31 -0800
commit12e5ddcbac266b547c34e85e9a09f6e0acf30580 (patch)
tree8abc4fd4baa1d214e3474b2398788cbc23763078 /coding-conventions.md
parent8ecb41df7e8e98a90413409a13054ead8c04eb20 (diff)
config best practices doc edits
Diffstat (limited to 'coding-conventions.md')
-rw-r--r--coding-conventions.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/coding-conventions.md b/coding-conventions.md
index df9f63e7..d51278be 100644
--- a/coding-conventions.md
+++ b/coding-conventions.md
@@ -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