Skip to content

Commit

Permalink
Incorporate review feedback from @schmichael
Browse files Browse the repository at this point in the history
* fix layout on guide for sidebar
* link downloads
* correct md formatting for links inside of monospace
* shorten title
  • Loading branch information
angrycub committed Nov 5, 2019
1 parent 19a69be commit 94e302f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 20 deletions.
34 changes: 17 additions & 17 deletions website/source/docs/configuration/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ testing.

## General Parameters

- `acl` `([ACL][acl]: nil)` - Specifies configuration which is specific to ACLs.
- `acl` `(`[`ACL`]`: nil)` - Specifies configuration which is specific to ACLs.

- `addresses` `(Addresses: see below)` - Specifies the bind address for
individual network services. Any values configured in this stanza take
Expand Down Expand Up @@ -130,10 +130,10 @@ testing.
Dev mode (`-dev`) defaults to localhost.
The value supports [go-sockaddr/template format][go-sockaddr/template].

- `client` `([Client][client]: nil)` - Specifies configuration which is specific
- `client` `(`[`Client`]`: nil)` - Specifies configuration which is specific
to the Nomad client.

- `consul` `([Consul][consul]: nil)` - Specifies configuration for
- `consul` `(`[`Consul`]`: nil)` - Specifies configuration for
connecting to Consul.

- `datacenter` `(string: "dc1")` - Specifies the data center of the local agent.
Expand Down Expand Up @@ -208,7 +208,7 @@ testing.
[data_dir](#data_dir) suffixed with "plugins", like `"/opt/nomad/plugins"`.
This must be an absolute path.

- `plugin` `([Plugin][plugin]: nil)` - Specifies configuration for a
- `plugin` `(`[`Plugin`]`: nil)` - Specifies configuration for a
specific plugin. The plugin stanza may be repeated, once for each plugin being
configured. The key of the stanza is the plugin's executable name relative to
the [plugin_dir](#plugin_dir).
Expand Down Expand Up @@ -241,18 +241,18 @@ testing.
with potentially multiple zones, which map to [datacenters](#datacenter) such
as `us-west` and `us-east`.

- `sentinel` `([Sentinel][sentinel]: nil)` - Specifies configuration for Sentinel
- `sentinel` `(`[`Sentinel`]`: nil)` - Specifies configuration for Sentinel
policies.

- `server` `([Server][server]: nil)` - Specifies configuration which is specific
- `server` `(`[`Server`]`: nil)` - Specifies configuration which is specific
to the Nomad server.

- `syslog_facility` `(string: "LOCAL0")` - Specifies the syslog facility to
write to. This has no effect unless `enable_syslog` is true.

- `tls` `([TLS][tls]: nil)` - Specifies configuration for TLS.
- `tls` `(`[`TLS`]`: nil)` - Specifies configuration for TLS.

- `vault` `([Vault][vault]: nil)` - Specifies configuration for
- `vault` `(`[`Vault`]`: nil)` - Specifies configuration for
connecting to Vault.

## Examples
Expand All @@ -277,13 +277,13 @@ http_api_response_headers {
}
```

[hcl]: https://github.com/hashicorp/hcl "HashiCorp Configuration Language"
[`ACL`]: /docs/configuration/acl.html "Nomad Agent ACL Configuration"
[`Client`]: /docs/configuration/client.html "Nomad Agent client Configuration"
[`Consul`]: /docs/configuration/consul.html "Nomad Agent consul Configuration"
[`Plugin`]: /docs/configuration/plugin.html "Nomad Agent Plugin Configuration"
[`Sentinel`]: /docs/configuration/sentinel.html "Nomad Agent sentinel Configuration"
[`Server`]: /docs/configuration/server.html "Nomad Agent server Configuration"
[`TLS`]: /docs/configuration/tls.html "Nomad Agent tls Configuration"
[`Vault`]: /docs/configuration/vault.html "Nomad Agent vault Configuration"
[go-sockaddr/template]: https://godoc.org/github.com/hashicorp/go-sockaddr/template
[consul]: /docs/configuration/consul.html "Nomad Agent consul Configuration"
[vault]: /docs/configuration/vault.html "Nomad Agent vault Configuration"
[tls]: /docs/configuration/tls.html "Nomad Agent tls Configuration"
[client]: /docs/configuration/client.html "Nomad Agent client Configuration"
[sentinel]: /docs/configuration/sentinel.html "Nomad Agent sentinel Configuration"
[server]: /docs/configuration/server.html "Nomad Agent server Configuration"
[acl]: /docs/configuration/acl.html "Nomad Agent ACL Configuration"
[plugin]: /docs/configuration/plugin.html "Nomad Agent Plugin Configuration"
[hcl]: https://github.com/hashicorp/hcl "HashiCorp Configuration Language"
5 changes: 3 additions & 2 deletions website/source/guides/install/windows-service.html.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: "docs"
layout: "guides"
page_title: "Nomad as a Windows Service"
sidebar_current: "guides-install-windows-service"
description: |-
Expand All @@ -17,7 +17,7 @@ to register the Nomad application with the Windows Service Control Manager using

## Register Nomad with Windows

Download the Nomad binary for your architecture.
[Download] the Nomad binary for your architecture.

Use the [`sc.exe`] command to create a Service named "Nomad". The binPath
argument should include the fully qualified path to the Nomad executable and any
Expand Down Expand Up @@ -72,4 +72,5 @@ The service automatically starts up during/after boot, so you don't need to
launch Nomad from the command-line again.

[`sc.exe`]: https://msdn.microsoft.com/en-us/library/windows/desktop/ms682107(v=vs.85).aspx
[Download]: /downloads.html
[logging]: /docs/configuration/index.html#log_file
2 changes: 1 addition & 1 deletion website/source/layouts/guides.erb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
</li>

<li<%= sidebar_current("guides-install-windows-service") %>>
<a href="/guides/install/windows-service.html">As a Windows Service</a>
<a href="/guides/install/windows-service.html">Windows Service</a>
</li>
</ul>
</li>
Expand Down

0 comments on commit 94e302f

Please sign in to comment.