tests-always-included / wick

Bash-only IT automation, machine provisioning
Other
69 stars 12 forks source link

Docs confusion - How to get started #125

Open p-baum opened 6 years ago

p-baum commented 6 years ago

Either the example structure laid out at https://github.com/tests-always-included/wick/blob/master/doc/parents.md are erroneous or I am missing something.

You give the structure:

        wick
         |
   extended-wick
         |
   +-----+-----+
   |           |
client1     client 2

but the paths of files given are:

/home/user/client1/
/home/user/client2/
/home/user/extended-wick/
/home/user/wick/

They don't match.

It would be really helpful if you could add a short "Getting Started" section that shows where to install (per project install/symlink/path?) it and get going with some examples.

Thankyou for making this available.

p-baum commented 6 years ago

ah, now i realize that parent is not the parent directory but instead a symlink pointing to any chosen parent.

Sadly though I still do not know how to start. Do I need to run wick-inject?

You've put so much effort into the docs and I'm sure they will be valuable when one understands some basics. I've cloned the repo into my project dir but I don't how to start.

What is supposed to run locally and what on the target? I know you want to leave things flexible and leave implementation methods up to the user, but I highly recommend you add a getting started walk through with at least 1 example going from download to installing say nginx on a remote server.

Write it so that any pleb like me can just copy the walkthrough and bang, alt text