atomisthq / docs

End-user documentation sources and generator
https://docs.atomist.com
GNU General Public License v3.0
7 stars 28 forks source link

Some notes on setting up goals #293

Closed gjtorikian closed 5 years ago

gjtorikian commented 5 years ago

This is a doc that walks through, from start to finish, the notions of how to set up and establish tasks and goals and how to execute them.

I realized a bit too late that providing a running code sample would be a bit difficult, primarily because this tutorial has a section on executing a deployment, which is somewhat impossible for a reader to implement unless they have something set up on their end. So, there's probably a bit of hand-waving going on in the code samples, and instead, I tried to focus on the concepts themselves. If it's preferable that the SDM at least be bootable, I can definitely add some real code for the missing functions like quoteLinter.

I couldn't think of a snappy conclusion (😞) so I stole some "talk to us!" text I had seen elsewhere in the docs.

gjtorikian commented 5 years ago

Should I just merge this one in?

jessitron commented 5 years ago

I'm sorry this one sat for so long. It is helpful to have it. You could put real code in the sample-sdm and link to it. I don't know whether that's the most useful thing to do, though.