hashicorp / hashicorp/consul-template

Transport configuration not documented

Open
#1,467 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Go
Stars
4.8k
Forks
801
Avg merge
4h 5m
Merged PRs (30d)
6

Description

Both Vault and Consul blocks support a transport block with various settings..

https://github.com/hashicorp/consul-template/blob/f87266ee0c36f4b57b8a62a694e454f9475b1611/config/transport.go#L38-L62

Need to add config documentation for these.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with config/transport.go at the linked lines to identify the transport settings supported by both Vault and Consul blocks. Locate the existing configuration documentation, add descriptions for those settings, and verify that every setting in the transport block is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.