4th version docs

claudiajs · Mar 22, 2016 · ed7d1b7 · ed7d1b7
1 parent 66e92a9
commit ed7d1b7
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 17 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -7,7 +7,7 @@ Deploy a Node.JS project to AWS as a lambda microservice, optionally updating AP
 claudia [command] {OPTIONS}
 ```
 
-## _COMMANDS_ are:
+## Supported commands
 
 * [`create`](create.md) Create the initial lambda function and related security role.
 * [`update`](update.md) Deploy a new version of the Lambda function using project files, update any associated web APIs
@@ -18,12 +18,14 @@ claudia [command] {OPTIONS}
 * [`test-lambda`](test-lambda.md) Execute the lambda function and print out the response
 * [`destroy`](destroy.md) Undeploy the lambda function and destroy the API and security roles
 
-## _OPTIONS_ are:
+## Options:
 
  * --help           print this help screen
  * --version        print out the current version
 
 Run with a command name to see options of a specific command
 
-For example: `claudia create --help`
-
+For example:
+```bash
+claudia create --help
+```
diff --git a/docs/add-s3-event-source.md b/docs/add-s3-event-source.md
@@ -8,7 +8,7 @@ Add a notification event to Lambda when a file is added to a S3 bucket, and set
 claudia add-s3-event-source {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--bucket`:  S3 Bucket name which will push notifications to Lambda
 *  `--prefix`:  _optional_ Prefix filter for S3 keys that will cause the event

diff --git a/docs/add-scheduled-event.md b/docs/add-scheduled-event.md
@@ -8,7 +8,7 @@ Add a recurring notification event
 claudia add-scheduled-event {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--event`:  Path to a JSON event file that will be sent to lambda periodically
 *  `--name`:  Name for the scheduled event rule that will be created

diff --git a/docs/add-sns-event-source.md b/docs/add-sns-event-source.md
@@ -8,7 +8,7 @@ Add a notification event to Lambda when a message is published on a SNS topic
 claudia add-sns-event-source {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--topic`:  the ARN of the SNS topic
 *  `--version`:  _optional_ Bind to a particular version

diff --git a/docs/create.md b/docs/create.md
@@ -8,7 +8,7 @@ Create the initial lambda function and related security role.
 claudia create {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--name`:  lambda function name
   * _For example_: awesome-microservice

diff --git a/docs/destroy.md b/docs/destroy.md
@@ -8,7 +8,7 @@ Undeploy the lambda function and destroy the API and security roles
 claudia destroy {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--source`:  _optional_ Directory with project files
   * _Defaults to_: current directory

diff --git a/docs/set-version.md b/docs/set-version.md
@@ -8,7 +8,7 @@ Create or update a lambda alias/api stage to point to the latest deployed versio
 claudia set-version {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--version`:  the alias to update or create
   * _For example_: production

diff --git a/docs/test-lambda.md b/docs/test-lambda.md
@@ -8,7 +8,7 @@ Execute the lambda function and print out the response
 claudia test-lambda {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--event`:  _optional_ Path to a file containing the JSON test event
 *  `--version`:  _optional_ A version alias to test

diff --git a/docs/update.md b/docs/update.md
@@ -8,7 +8,7 @@ Deploy a new version of the Lambda function using project files, update any asso
 claudia update {OPTIONS}
 ```
 
-## _OPTIONS_ are:
+## Options
 
 *  `--version`:  _optional_ A version alias to automatically assign to the new deployment
   * _For example_: development

diff --git a/src/util/doc-md.js b/src/util/doc-md.js
@@ -33,7 +33,7 @@ var fs = require('fs'),
 		lines.push('claudia ' + command.command + ' {OPTIONS}');
 		lines.push('```');
 		lines.push('');
-		lines.push('## _OPTIONS_ are:');
+		lines.push('## Options');
 		lines.push('');
 		command.doc.args.forEach(function (argDoc) {
 			var components = [], descLines;
@@ -69,7 +69,7 @@ var fs = require('fs'),
 		lines.push('claudia [command] {OPTIONS}');
 		lines.push('```');
 		lines.push('');
-		lines.push('## _COMMANDS_ are:');
+		lines.push('## Supported commands');
 		lines.push('');
 		Object.keys(commands).map(function (key) {
 			return commands[key];
@@ -87,15 +87,17 @@ var fs = require('fs'),
 			lines.push(components.join(''));
 		});
 		lines.push('');
-		lines.push('## _OPTIONS_ are:');
+		lines.push('## Options:');
 		lines.push('');
 		lines.push(' * --help           print this help screen');
 		lines.push(' * --version        print out the current version');
 		lines.push('');
 		lines.push('Run with a command name to see options of a specific command');
 		lines.push('');
-		lines.push('For example: `claudia create --help`');
-		lines.push('');
+		lines.push('For example:');
+		lines.push('```bash');
+		lines.push('claudia create --help');
+		lines.push('```');
 		lines.push('');
 		return lines.join('\n');
 	},