hashicorp / hashicorp/consul

web tutorials should be versioned

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

Description

It'd be nice if the tutorials on the website were versioned. I'm still on 13.x so the configuration in these docs is incorrect for that version (and I learned it the hard way).

https://developer.hashicorp.com/consul/tutorials/security/tls-encryption-secure
https://developer.hashicorp.com/consul/tutorials/security-operations/tls-encryption-secure-existing-datacenter

It seems like the "documentation" is versioned, that is, this page:
https://developer.hashicorp.com/consul/docs

would be nice to have the same feature on the tutorials

Contributor guide

Open the contributing guide

Research direction

Start by comparing the two linked TLS tutorial pages with the versioned Consul documentation landing page at https://developer.hashicorp.com/consul/docs. Determine how version selection works for the documentation and whether the tutorials can use the same mechanism. Done means the tutorials provide version-appropriate content, including the configuration relevant to Consul 13.x.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.