Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hello-world example should direct users on how to fulfill prerequisites #200

Closed
tstromberg opened this issue Mar 10, 2021 · 2 comments
Closed
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@tstromberg
Copy link
Contributor

If you stumble into https://docs.tinkerbell.org/workflows/hello-world-workflow/ the wrong way, you will get very confused as it assumes knowledge of the provisioner & worker, and that it is already setup. We provide no guidance to users who do not meet the prerequisites.

As there is already a lot of new terminology for users sort out, we can reduce the cognitive overhead of learning Tinkerbell through copious use of hyperlinks.

My thoughts lean something toward:

## A Hello-World Workflow

The "Hello World" example uses an example <a href="?">hardware data</a>, <a href="?"> template</a>, and <a href="?">workflow</a> to show off some basic Tinkerbell functionality, and the interaction between a <a href="?">Provisioner</a> and a <a href="?">Worker</a>. It uses the hello-world docker image as an example task that could be performed on a Worker as part of a workflow.

Prerequisites

This tutorial assumes that you already Tinkerbell up and running. If you do not yet, please check-out our <a href="?>Getting Started guide.

This tutorial also assumes that you have a Worker that has not yet been brought up, or can be restarted.

@tstromberg tstromberg added kind/documentation Categorizes issue or PR as related to documentation. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jul 27, 2021
@tstromberg
Copy link
Contributor Author

This should be an easy quality of life improvement to make. Any volunteers?

@tstromberg tstromberg added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Aug 27, 2021
@jacobweinstock
Copy link
Member

this example section has been removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests

2 participants