begin cargo make docs

[ala-mode]

WIP, cargo-make documentation

[nachog00]

typo: missing "-" between "image" and "tag". Not a big deal, but if people copy and run int, it wont work

[nachog00]

Wording is a bit off here (i think). I would say the volumes are mounted on the container.
Also, maybe listing all the volumes would be good? it mounts the zaino source code (the repo clone), the target directory and a .cargo that isn't the global one, but a dedicated location to avoid messing with your global cargo stuff.

[nachog00]

I would also explain the flow followed by this command to get your image:

1. it gets the image tag described in cargo make compute-image-tag
2. it checks if the local docker daemon has that image available
3. if not, it tries to pull the image from Dockerhub
4. if not available there either, it builds it (using the build-image) task
5. after all that (or just some of that, if any step finds the image already), it runs:

cargo nextest run --profile ci

User can pass in extra arguments too, for example

cargo make test zebrad::get::address

will result in the container running

cargo nextest run --profile ci zebrad::get::address

[nachog00]

i would'nt say that base script runs tests. It just sources the helpers and computes the TAG

[nachog00]

This current setup is a bit limiting since it only makes it easy to do cargo nextest run commands with the container, but we probably want to extend it so people can start the container, keep it running and pass whatever nextest command they want, and maybe even regular cargo commands too.

[zancas]

Because the makers tooling is so new, and so many changes are incoming, I have marked this low-priority.. we should circle back to documentation when we onboard someone new AND more than 4 weeks have passed.

[zancas]

I think this PR has likely been superceded. Is it still providing relevant documentation @ala-mode ?