Merge pull request #6532 from hashicorp/docs-fixup-command

Fixup for command section of website
hashicorp · Oct 30, 2019 · 32f64d3 · 32f64d3
2 parents 889ca90 + 0c359d1
commit 32f64d3
Show file tree

Hide file tree

Showing 84 changed files with 977 additions and 774 deletions.
diff --git a/website/source/docs/commands/acl.html.md.erb → website/source/docs/commands/acl.html.md b/website/source/docs/commands/acl.html.md.erb → website/source/docs/commands/acl.html.md
@@ -17,16 +17,16 @@ Usage: `nomad acl <subcommand> [options]`
 Run `nomad acl <subcommand> -h` for help on that subcommand. The following
 subcommands are available:
 
-* [`acl bootstrap`][bootstrap] - Bootstrap the initial ACL token
-* [`acl policy apply`][policyapply] - Create or update ACL policies
-* [`acl policy delete`][policydelete] - Delete an existing ACL policies
-* [`acl policy info`][policyinfo] - Fetch information on an existing ACL policy
-* [`acl policy list`][policylist] - List available ACL policies
-* [`acl token create`][tokencreate] - Create new ACL token
-* [`acl token delete`][tokendelete] - Delete an existing ACL token
-* [`acl token info`][tokeninfo] - Get info on an existing ACL token
-* [`acl token self`][tokenself] - Get info on self ACL token
-* [`acl token update`][tokenupdate] - Update existing ACL token
+- [`acl bootstrap`][bootstrap] - Bootstrap the initial ACL token
+- [`acl policy apply`][policyapply] - Create or update ACL policies
+- [`acl policy delete`][policydelete] - Delete an existing ACL policies
+- [`acl policy info`][policyinfo] - Fetch information on an existing ACL policy
+- [`acl policy list`][policylist] - List available ACL policies
+- [`acl token create`][tokencreate] - Create new ACL token
+- [`acl token delete`][tokendelete] - Delete an existing ACL token
+- [`acl token info`][tokeninfo] - Get info on an existing ACL token
+- [`acl token self`][tokenself] - Get info on self ACL token
+- [`acl token update`][tokenupdate] - Update existing ACL token
 
 [bootstrap]: /docs/commands/acl/bootstrap.html
 [policyapply]: /docs/commands/acl/policy-apply.html

diff --git a/website/source/docs/commands/acl/bootstrap.html.md.erb b/website/source/docs/commands/acl/bootstrap.html.md.erb
@@ -12,7 +12,7 @@ The `acl bootstrap` command is used to bootstrap the initial ACL token.
 
 ## Usage
 
-```
+```plaintext
 nomad acl bootstrap [options]
 ```
 
@@ -26,7 +26,7 @@ The `acl bootstrap` command requires no arguments.
 
 Bootstrap the initial token:
 
-```
+```shell
 $ nomad acl bootstrap
 Accessor ID  = 5b7fd453-d3f7-6814-81dc-fcfe6daedea5
 Secret ID    = 9184ec35-65d4-9258-61e3-0c066d0a45c5

diff --git a/website/source/docs/commands/acl/policy-apply.html.md.erb b/website/source/docs/commands/acl/policy-apply.html.md.erb
@@ -12,26 +12,26 @@ The `acl policy apply` command is used to create or update ACL policies.
 
 ## Usage
 
-```
+```plaintext
 nomad acl policy apply [options] <name> <path>
 ```
 
-The `acl policy apply` command requires two arguments, the policy name and path to file.
-The policy can be read from stdin by setting the path to "-".
+The `acl policy apply` command requires two arguments, the policy name and path
+to file. The policy can be read from stdin by setting the path to "-".
 
 ## General Options
 
 <%= partial "docs/commands/_general_options" %>
 
 ## Apply Options
 
-* `-description`: Sets the human readable description for the ACL policy.
+- `-description`: Sets the human readable description for the ACL policy.
 
 ## Examples
 
 Create a new ACL Policy:
 
-```
+```shell
 $ nomad acl policy apply my-policy my-policy.json
 Successfully wrote 'my-policy' ACL policy!
 ```
diff --git a/website/source/docs/commands/acl/policy-delete.html.md.erb b/website/source/docs/commands/acl/policy-delete.html.md.erb
@@ -12,7 +12,7 @@ The `acl policy delete` command is used to delete an existing ACL policies.
 
 ## Usage
 
-```
+```plaintext
 nomad acl policy delete <policy_name>
 ```
 
@@ -26,7 +26,7 @@ The `acl policy delete` command requires the policy name as an argument.
 
 Delete an ACL Policy:
 
-```
+```shell
 $ nomad acl policy delete my-policy
 Successfully deleted 'my-policy' ACL policy!
 ```
diff --git a/website/source/docs/commands/acl/policy-info.html.md.erb b/website/source/docs/commands/acl/policy-info.html.md.erb
@@ -14,7 +14,7 @@ policy.
 
 ## Usage
 
-```
+```plaintext
 nomad acl policy info <name>
 ```
 
@@ -28,7 +28,7 @@ The `acl policy info` command requires the policy name.
 
 Fetch information on an existing ACL Policy:
 
-```
+```shell
 $ nomad acl policy info my-policy
 Name        = my-policy
 Description = <none>

diff --git a/website/source/docs/commands/acl/policy-list.html.md.erb b/website/source/docs/commands/acl/policy-list.html.md.erb
@@ -12,25 +12,24 @@ The `acl policy list` command is used to list available ACL policies.
 
 ## Usage
 
-```
+```plaintext
 nomad acl policy list
 ```
 
 ## General Options
 
 <%= partial "docs/commands/_general_options" %>
-#
-## List Options
 
-* `-json` : Output the policies in their JSON format.
+## List Options
 
-* `-t` : Format and display the policies using a Go template.
+- `-json` : Output the policies in their JSON format.
+- `-t` : Format and display the policies using a Go template.
 
 ## Examples
 
 List all ACL policies:
 
-```
+```shell
 $ nomad acl policy list
 Name      Description
 policy-1  The first policy

diff --git a/website/source/docs/commands/acl/token-create.html.md.erb b/website/source/docs/commands/acl/token-create.html.md.erb
@@ -12,7 +12,7 @@ The `acl token create` command is used to create new ACL tokens.
 
 ## Usage
 
-```
+```plaintext
 nomad acl token create [options]
 ```
 
@@ -24,20 +24,22 @@ The `acl token create` command requires no arguments.
 
 ## Create Options
 
-* `-name`: Sets the human readable name for the ACL token.
+- `-name`: Sets the human readable name for the ACL token.
 
-* `-type`: Sets the type of token. Must be one of "client" (default), or "management".
+- `-type`: Sets the type of token. Must be one of "client" (default), or
+  "management".
 
-* `-global`: Toggles the global mode of the token. Global tokens are replicated to all regions. Defaults false.
+- `-global`: Toggles the global mode of the token. Global tokens are replicated
+  to all regions. Defaults false.
 
-* `-policy`: Specifies a policy to associate with the token. Can be specified multiple times,
-    but only with client type tokens.
+- `-policy`: Specifies a policy to associate with the token. Can be specified
+  multiple times, but only with client type tokens.
 
 ## Examples
 
 Create a new ACL token:
 
-```
+```shell
 $ nomad acl token create -name="my token" -policy=foo -policy=bar
 Accessor ID  = d532c40a-30f1-695c-19e5-c35b882b0efd
 Secret ID    = 85310d07-9afa-ef53-0933-0c043cd673c7

diff --git a/website/source/docs/commands/acl/token-delete.html.md.erb b/website/source/docs/commands/acl/token-delete.html.md.erb
@@ -12,7 +12,7 @@ The `acl token delete` command is used to delete existing ACL tokens.
 
 ## Usage
 
-```
+```plaintext
 nomad acl token delete <token_accessor_id>
 ```
 
@@ -26,7 +26,7 @@ The `acl token delete` command requires an existing token's AccessorID.
 
 Delete an existing ACL token:
 
-```
+```shell
 $ nomad acl token delete d532c40a-30f1-695c-19e5-c35b882b0efd
 
 Token d532c40a-30f1-695c-19e5-c35b882b0efd successfully deleted

diff --git a/website/source/docs/commands/acl/token-info.html.md.erb b/website/source/docs/commands/acl/token-info.html.md.erb
@@ -12,7 +12,7 @@ The `acl token info` command is used to fetch information about an existing ACL
 
 ## Usage
 
-```
+```plaintext
 nomad acl token info <token_accessor_id>
 ```
 
@@ -26,7 +26,7 @@ The `acl token info` command requires an existing token's AccessorID.
 
 Fetch information about an existing ACL token:
 
-```
+```shell
 $ nomad acl token info d532c40a-30f1-695c-19e5-c35b882b0efd
 Accessor ID  = d532c40a-30f1-695c-19e5-c35b882b0efd
 Secret ID    = 85310d07-9afa-ef53-0933-0c043cd673c7

diff --git a/website/source/docs/commands/acl/token-list.html.md.erb b/website/source/docs/commands/acl/token-list.html.md.erb
@@ -12,25 +12,24 @@ The `acl token list` command is used to list existing ACL tokens.
 
 ## Usage
 
-```
+```plaintext
 nomad acl token list
 ```
 
 ## General Options
 
 <%= partial "docs/commands/_general_options" %>
-#
-## List Options
 
-* `-json` : Output the tokens in their JSON format.
+## List Options
 
-* `-t` : Format and display the tokens using a Go template.
+- `-json` : Output the tokens in their JSON format.
+- `-t` : Format and display the tokens using a Go template.
 
 ## Examples
 
 List all ACL tokens:
 
-```
+```shell
 $ nomad acl token list
 Name             Type        Global  Accessor ID
 Bootstrap Token  management  true    32b61154-47f1-3694-1430-a5544bafcd3e

diff --git a/website/source/docs/commands/acl/token-self.html.md.erb b/website/source/docs/commands/acl/token-self.html.md.erb
@@ -9,11 +9,12 @@ description: >
 
 # Command: acl token self
 
-The `acl token self` command is used to fetch information about the currently set ACL token.
+The `acl token self` command is used to fetch information about the currently
+set ACL token.
 
 ## Usage
 
-```
+```plaintext
 nomad acl token self
 ```
 
@@ -25,7 +26,7 @@ nomad acl token self
 
 Fetch information about an existing ACL token:
 
-```
+```shell
 $ export NOMAD_TOKEN=d532c40a-30f1-695c-19e5-c35b882b0efd
 
 $ nomad acl token self

diff --git a/website/source/docs/commands/acl/token-update.html.md.erb b/website/source/docs/commands/acl/token-update.html.md.erb
@@ -12,7 +12,7 @@ The `acl token update` command is used to update existing ACL tokens.
 
 ## Usage
 
-```
+```plaintext
 nomad acl token update [options] <token_accessor_id>
 ```
 
@@ -24,20 +24,22 @@ The `acl token update` command requires an existing token's accessor ID.
 
 ## Create Options
 
-* `-name`: Sets the human readable name for the ACL token.
+- `-name`: Sets the human readable name for the ACL token.
 
-* `-type`: Sets the type of token. Must be one of "client" (default), or "management".
+- `-type`: Sets the type of token. Must be one of "client" (default), or
+  "management".
 
-* `-global`: Toggles the global mode of the token. Global tokens are replicated to all regions. Defaults false.
+- `-global`: Toggles the global mode of the token. Global tokens are replicated
+  to all regions. Defaults false.
 
-* `-policy`: Specifies a policy to associate with the token. Can be specified multiple times,
-    but only with client type tokens.
+- `-policy`: Specifies a policy to associate with the token. Can be specified
+  multiple times, but only with client type tokens.
 
 ## Examples
 
 Update an existing ACL token:
 
-```
+```shell
 $ nomad acl token update -name="my updated token" -policy=foo -policy=bar d532c40a-30f1-695c-19e5-c35b882b0efd
 Accessor ID  = d532c40a-30f1-695c-19e5-c35b882b0efd
 Secret ID    = 85310d07-9afa-ef53-0933-0c043cd673c7

diff --git a/website/source/docs/commands/agent-info.html.md.erb b/website/source/docs/commands/agent-info.html.md.erb
@@ -14,7 +14,7 @@ is connected to. This is useful for troubleshooting and performance monitoring.
 
 ## Usage
 
-```
+```plaintext
 nomad agent-info [options]
 ```
 
@@ -27,15 +27,15 @@ nomad agent-info [options]
 Depending on the agent queried, information from different subsystems is
 returned. These subsystems are described below:
 
-* client  - Status of the local Nomad client
-* nomad   - Status of the local Nomad server
-* serf    - Gossip protocol metrics and information
-* raft    - Status information about the Raft consensus protocol
-* runtime - Various metrics from the runtime environment
+- client  - Status of the local Nomad client
+- nomad   - Status of the local Nomad server
+- serf    - Gossip protocol metrics and information
+- raft    - Status information about the Raft consensus protocol
+- runtime - Various metrics from the runtime environment
 
 ## Examples
 
-```
+```shell
 $ nomad agent-info
 raft
   commit_index = 0