2016-11-05 00:28:06 +00:00
|
|
|
# Ingress documentation and examples
|
|
|
|
|
|
2016-12-16 22:02:42 +00:00
|
|
|
This directory contains documentation.
|
2017-02-10 18:58:46 +00:00
|
|
|
|
|
|
|
|
## File naming convention
|
|
|
|
|
|
|
|
|
|
Try to create a README file in every directory containing documentation and index
|
|
|
|
|
out from there, that's what readers will notice first. Use lower case for other
|
|
|
|
|
file names unless you have a reason to draw someones attention to it.
|
|
|
|
|
Avoid CamelCase.
|
|
|
|
|
|
|
|
|
|
Rationale:
|
|
|
|
|
|
|
|
|
|
* Files that are common to all controllers, or heavily index other files, are
|
|
|
|
|
named using ALL CAPS. This is done to indicate to the user that they should
|
|
|
|
|
visit these files first. Examples include PREREQUISITES and README.
|
|
|
|
|
|
|
|
|
|
* Files specific to a controller, or files that contain information about
|
|
|
|
|
various controllers, are named using all lower case. Examples include
|
|
|
|
|
configuration and catalog files.
|
|
|
|
|
|
