learnxinyminutes-docs
learnxinyminutes-docs copied to clipboard
[hcl/en] Add guide for Terraform / HCL language
- [x] I solemnly swear that this is all original content of which I am the original author
- [x] Pull request title is prepended with
[language/lang-code]
- [x] Pull request touches only one file (or a set of logically related files with similar changes made)
- [x] Content changes are aimed at intermediate to experienced programmers (this is a poor format for explaining fundamental programming concepts)
- [x] Yes, I have double-checked quotes and field names!
@romaninsh Thank you very much for this contribution !! There are some tiny issues I flagged, maybe you can look them over
@mxschumacher - Apologies for not responding for a long time. I have now completed the guide, upgraded to include newly released 0.13 version language features and addressed all of the notes too. Please review again and let me know if anything else needs fixing.
Hey, do you know if this can be reviewed again? @mxschumacher
@mribeirodantas - any chance we could merge this? I keep sending people to my PR to read the guide :D I'm happy to clean up the guide if it needs anything.
@romans-ovo May you please check the .md in preparation with markdownlint for consistency?
Some time ago, I noticed there are entries of this compilation which do not fit well the website's presentation managed by a style file. This is an issue others equally observed; it may be resolved if lines of the .md file do not exceed the 80 characters per line threshold .and. an adjustment of the web browser's font parameters (see here).
Thus, I would like to invite you to check the .md in preparation, e.g., with the freely available open source checker markdownlint. Matching the threshold requested here in learnxinyminutes is the one the linter uses as (adjustable) default; the tool quickly reports this as error 13
back to the CLI, including a note which line should be revised.
If present, the tool equally will identify other issues which -- except for the header of the .md defining language, contributors, translators, filename -- may be improved breaking longer commands and comments into multiple lines, editing spaces/words/indentations. After application to an entry e.g., about AWK, I noticed if the web page is print to .pdf (simplified representation, as offered by Firefox), the web browser no longer shrinks the characters in size this much to squeeze overly long lines into a physical line, too.
At the end of the .md file, long entries with cross references to other resources / web pages seem to remain functional by substitution of a pattern like
## Further Reading
+ The current standard 2017 of language xy is documented in [the reference](the reference's address) especially outlining detail A and B.
+ In addition ...
by a "poly-line" pattern
## Further Reading
+ The current standard 2017 of language xy is documented in
[the reference](the reference's address)
especially outlining detail A and B.
+ In addition ...
because a new paragraph would require a new blank line, not just starting a new line.
It usually is mix of issues on may resolve quickly with regexes (e.g., sed -i "s/ *$//" example.markdown.html
to trim trailing spaces), and others which require manual intervention which either resolve the issues for good, or at least improve the .md file's format.
@romans-ovo @romaninsh I have proofread the guide and I'm going to merge it. If you ever get a chance, please proof-read it again and make a PR updating it. It talks about Terraform 0.13 but these days Terraform is on version 1.8.3.