search

freebsd / kyua

Port/Package build and test system
https://github.com/freebsd/kyua/wiki
BSD 3-Clause "New" or "Revised" License
149 stars 42 forks source link

Add a Kyua quickstart guide #132

Closed rodrigc closed 9 years ago

rodrigc commented 10 years ago

I have talked to a few people, and they have all told me that the documentation for kyua is oriented towards discussing how kyua was implemented, and not so focused on quickly bootstrapping someone who wants to use kyua.

I wrote this quickstart guide to kyua:

https://github.com/rodrigc/kyuawiki2/commit/e4c9b1e5019d1c6f6b18a619e3a2bcce3e1c5611

I tried to keep it as minimal as possible. I've gotten some positive feedback about it. Please incorporate it into the main kyua wiki.

You can see the rendered form of the quickstart guide here:

https://github.com/rodrigc/kyua/wiki/Quickstart-Guide

rodrigc commented 9 years ago

@jmmv: can you incorporate this into the Kyua wiki docs?

jmmv commented 9 years ago

Oh yes. Last time I looked, I did not feel the guide was well-organized, but now it looks much better! Do you mind if I tweak the style and wording a bit when doing so?

rodrigc commented 9 years ago

Do what you have to do. Let's get this in.

rodrigc commented 9 years ago

Can you accept this patch as it is, and then fixup the wiki to your requirements later? I understand that you are busy with implementing parallel test execution, but I submitted this patch 5 months ago. It would be good to get this in, to improve the docs.

jmmv commented 9 years ago

Let's do this now. I apologize again for the delays. I had separated my OSS email to a different account with the idea to look at it only when I had "free" time but the experiment has utterly failed... so I'm reverting that.

jmmv commented 9 years ago

Merged your Quickstart Installation contents into the regular Installation page. There shouldn't be two.

jmmv commented 9 years ago

Alright, I think I have imported everything. Let me know if I missed anything.

I have also wiped the front page of the wiki and reduced it to some links, and moved the contents to the sidebar for cleaner looks.

rodrigc commented 9 years ago

@jmmv: thanks for doing this. I hear ya regarding free time. I don't think there is such a thing as free time any more....:)

jmmv commented 9 years ago

Heh, indeed. Well, more than "free time" I was intending to treat Kyua as "work" and explicitly setting aside time for it either at home or in the office (20% time, etc. etc.). But because doing the latter is hard, I have been missing all project notifications... which is certainly not good for anyone.

Anyway: no, thank you for writing this up and contributing it!