Skip to content
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

Fix formatting error in docs/README.md #153

Merged
merged 1 commit into from
Mar 19, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
-# 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 someone's 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.
# 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 someone's 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.