ingress-nginx-helm/docs
Manuel Alejandro de Brito Fontes 6403efe0d4 Merge pull request #1058 from sethpollack/rpm
add per minute rate limiting
2017-08-03 20:44:49 -04:00
..
dev Add common Env-Variable options to Dev Docs 2017-08-03 13:09:22 -05:00
faq Add websocket example 2017-06-09 12:46:47 -07:00
admin.md docs: use generic instead of OSS controller 2017-04-01 17:03:44 +02:00
annotations.md add per minute rate limiting 2017-08-01 23:24:48 -04:00
catalog.md Add Voyager to catalog 2017-05-25 14:52:59 -04:00
README.md Add nginx README and configuration docs back 2017-02-10 10:59:40 -08:00
troubleshooting.md Release nginx 0.9.0-beta.11 2017-07-15 13:56:38 -04:00

Ingress documentation and examples

This directory contains documentation.

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.