hashicorp / hashicorp/hcl

Collection of practical examples?

Open
#405 0 comments 8 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
5.8k
Forks
657
Avg merge
20h 36m
Merged PRs (30d)
6

Description

I was hoping for a [Learn X in Y minutes](https://learnxinyminutes.com/) overview/breakdown, although with HCL2 that may be overly verbose to cover.

I looked at the top level of the project files and github wiki, there doesn't appear to be any examples beyond the brief snippets in the v1/v2 READMEs and then the granular spec document detailing syntax.

As someone unfamiliar with HCL, but experienced with various other data formats such as JSON/HJSON/TOML/YAML, seeing some more practical examples would be encouraging.

As this repo has a lot of Go code for handling HCL, what is the support for HCL parsing with other languages? (I am not sure how common/discoverable HCL2 support would be outside of Go) Is there a list maintained somewhere? Are there other projects beyond Hashicorp ones using HCL, are any large well known open-source projects?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by comparing the brief examples in the v1/v2 READMEs with the granular syntax specification and the existing GitHub wiki. Use the Learn X in Y minutes reference as a model while determining the scope for practical HCL examples and a maintained list of other-language and non-HashiCorp HCL users. Done means the proposed overview and ecosystem information are documented with a clear location.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.