Merge pull request #115 from jrasell/general-docs-fixes

docs: general fixes and additions based on read through.
jrasell · Dec 4, 2019 · f661bde · f661bde
2 parents 3202a59 + 43ef52f
commit f661bde
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 5 deletions.
diff --git a/docs/api/scale.md b/docs/api/scale.md
@@ -27,7 +27,7 @@ This endpoint can be used to scale a Nomad job group out, therefore increasing i
 
 ```
 $ curl \
-    --request PUT \
+    --request POST \
     --data @payload.json \
     http://127.0.0.1:8000/v1/scale/out/my-job/my-job-group?count=2
 ```
@@ -68,7 +68,7 @@ This endpoint can be used to scale a Nomad job group in, therefore decreasing it
 
 ```
 $ curl \
-    --request PUT \
+    --request POST \
     --data @payload.json \
     http://127.0.0.1:8000/v1/scale/in/my-job/my-job-group?count=2
 ```

diff --git a/docs/commands/README.md b/docs/commands/README.md
@@ -14,7 +14,7 @@ $ sherpa <subcommand> -h
 
 ## CLI Command Structure
 
-There are a number of command and subcommand options available. Construct your Vault CLI command such that the command options precede its and arguments if any:
+There are a number of command and subcommand options available. Construct your Sherpa CLI command such that the command options precede its and arguments if any:
 
 ```bash
 sherpa <command> <subcommand> [options] [args]

diff --git a/docs/commands/policy.md b/docs/commands/policy.md
@@ -4,6 +4,11 @@ The policy command groups subcommands for interacting with policies. Users can w
 
 ## Examples
 
+Create an example job group scaling policy:
+```bash
+$ sherpa policy init
+```
+
 List all policies:
 ```bash
 $ sherpa policy list
@@ -42,7 +47,8 @@ Usage:
 
 Available Commands:
   delete      Deletes a scaling policy from Sherpa
+  init        Creates an example job group scaling policy
   list        Lists all scaling policies
-  read        Details the scaling policy
+  read        Details scaling policies associated to a job
   write       Uploads a policy from file
 ```
diff --git a/docs/commands/server.md b/docs/commands/server.md
@@ -1,6 +1,6 @@
 # Server CLI
 
-The server command starts a Sherpa server that responds to API requests. Please see the [configuration documentation](../configuration/_readme.md) for all server configuration options.
+The server command starts a Sherpa server that responds to API requests. Please see the [configuration documentation](../configuration/README.md) for all server configuration options.
 
 ## Examples
 

diff --git a/docs/commands/system.md b/docs/commands/system.md
@@ -19,6 +19,11 @@ Output the latest metric data points for the running server:
 $ sherpa system metrics
 ```
 
+Get information about the backend HA status and leader:
+```bash
+$ sherpa system leader
+```
+
 ## Usage
 ```bash
 Usage:
@@ -28,5 +33,6 @@ Usage:
 Available Commands:
   health      Retrieve health information of a Sherpa server
   info        Retrieve information about a Sherpa server
+  leader      Check the HA status and current leader
   metrics     Retrieve metrics from a Sherpa server
 ```