Skip to content
This repository was archived by the owner on Jul 11, 2019. It is now read-only.

Additional YAML doc when mentioning it in workshops #281

Open
webknjaz opened this issue Feb 16, 2018 · 2 comments
Open

Additional YAML doc when mentioning it in workshops #281

webknjaz opened this issue Feb 16, 2018 · 2 comments

Comments

@webknjaz
Copy link
Member

This one is good for quick start: https://learnxinyminutes.com/docs/yaml/

@tima
Copy link
Collaborator

tima commented Feb 16, 2018

During a community presentation of this content @dagwieers suggested we also add links to the Wikipedia YAML page: https://en.wikipedia.org/wiki/YAML

@dagwieers
Copy link
Contributor

I really like the Wikipedia example as it is pretty straightforward and it gives 2 separate examples for the use of YAML that are easy to understand. One is for LASIK eye surgery (YAML describes a workflow for instructing the equipment, much like what a playbook does), whereas the other is a simple invoice for a shop.

So while YAML simply describes data-structures, how it is applied is up to the user.

I usually quickly go over the different data-types so they have an understanding how it works (also incl. JSON support), then show how YAML implies datatypes (so one understands when quotes are needed, and when not) and then go over both examples. It takes a few minutes but it is essential that people have this understanding before actually going into more complex examples.

The advantage of using the Wikipedia page is that people can quickly refresh their memory by going to Wikipedia, which is readily available. An accessible resource for something that is essential to get right.

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

No branches or pull requests

3 participants