#314: Decrease the volume of 'PASSED' email sent to maintainers from bodhi ---------------------------+------------------------------------------------ Reporter: tflink | Owner: tflink Type: task | Status: reopened Priority: major | Milestone: 0.5.0 Component: documentation | Resolution: Keywords: | ---------------------------+------------------------------------------------ Comment (by kparal):
Great job, I just have a few comments:
1. Do we want to have two separate autoqa.conf documentation places? The first is inside the file itself, the second is online. I am kind of reluctant to maintain it at two places, I don't see the benefit. OTOH I understand that our wiki allows us to express some ideas better - like the two tables you created, they are great.
2. The new page should be linked from somewhere, otherwise only a handful of people would find it.
I would propose following:
a) Let's keep as much as possible of our documentation inside autoqa.conf. Let's document online only those options that need very detailed explanation or for which a plain text format is not sufficient.
b) Let's link the extended documentation directly from autoqa.conf (put a hyperlink in the first few lines of that file).
We should also think about fpo wiki and trac wiki. Do we want to have all of our documentation at one place, or do we have some system of splitting up content, or are we fine with having it randomly distributed?