The terms in the hello-world docs need to be explained better

[alexellis]

When reading the hello-world docs (a link is shown from setup.sh at the end) - there are a few confusing references that could be explained better for new users.

1) Unexplained literal value in example

$ tink workflow create -t <template-uuid> -r ‘{“device_1”:“mac/IP”}’ <- is that the literal value, or does this need elaborating to say that you can replace it with the MAC or IP?

2) No context given on what the hardware UUID is or how it's meant to be generated

A few details to note:
* id is the hardware UUID

With the id - there is no explanation on what this is supposed to be used for. Is it just meant to be a randomly generated UUID with no relationship to anything? If so, why not provide that information to the user and a command to generate a uuid? i.e. uuid | tr "[:upper:]" "[:lower:]"

3) Is the link at the end of setup.sh still correct?

Also, should this be linking to somewhere on https://tinkerbell.org or to the docs here on GitHub?

We also have a rouge \n which should be removed

4) What does device_1 mean?

Initial impressions - is device_1 a magic or hard-coded reference? I can't see it mentioned anywhere in the blog post.

Potential solution, quote the template in the post, so that people can see that device_1 will be injected:

version: '0.1'
name: hello_world_workflow
global_timeout: 600
tasks:
- name: "hello world"
  worker: "{{.device_1}}"
  actions:
  - name: "hello_world"
    image: hello-world
    timeout: 60

At the same time, you could explain what the workflow does

https://github.com/tinkerbell/tink/blob/master/docs/examples/hello-world.tmpl

[gauravgahlot]

@alexellis I believe this can be closed now. Could you please verify?

[alexellis]

Which PRs fixed this? Can you link me to them so that I can verify it?

[gauravgahlot]

Related PRs:

• Fix for #120 (point 3) in setup.sh #123
• Sanitizing hardwares entry when creating a workflow tinkerbell.org#48
• Update the Hello world example in the website tinkerbell.org#63
• Fixed issue #41 - Added sample hardware data in setup guide tinkerbell.org#44

[parauliya]

@alexellis , The links are provided by @gauravgahlot fixed the same. You can go through them.
But most importantly, the link which was provided at the end of setup.sh has changed now. So you should go to the new link for the Hello world example (https://tinkerbell.org/examples/hello-world/) and see if everything, explained there are well descripted.

[gianarb]

Thanks Alex!
@DailyAlice updated the example and I think it is now 100 times better! if you have any suggestions feel free to open a PR!