hashicorp / hashicorp/consul

Incorrect / inconsistent documentation: disable_host_node_id

Open
#23,128 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
30.1k
Forks
4.6k
Avg merge
1d 18h
Merged PRs (30d)
39

Description

#### Feature Description

Not a feature request, but not a bug either. I'd assume this is the "less urgent" channel.

Configuration for `disable_host_node_id` is available from [CLI ](https://developer.hashicorp.com/consul/commands/agent#_disable_host_node_id) and from [configuration file](https://developer.hashicorp.com/consul/docs/reference/agent/configuration-file/node#_disable_host_node_id).

The configuration file documentation incorrectly state that the default value is `false`. According to the CLI docs, the default value has been changed to `true` since Consul 0.8.5.

#### Use Case(s)

noop

Contributor guide

Open the contributing guide

Research direction

Compare the CLI documentation and configuration-file documentation linked in the issue for disable_host_node_id, starting with their stated default values. Update the configuration-file documentation to match the CLI documentation, then verify that both references consistently state the intended default.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.