I have made some changes to the AutoQA wiki page [1]. The idea is to have some kind of guidepost, where you easily find part relevant for you and continue to more detailed description at linked page.
I have tried to split our users to two parts - end users (using AutoQA website to see results or receive our notifications) and developers (which contribute to tests and AutoQA itself). I don't know if I have separated them (and described them) in an understandable way. If you have some improvements, please don't hesitate to adjust the page.
What we want to see included on the front page, what we don't want to see there? All suggestions welcome!
Thanks, Kamil
On Wed, 2009-11-18 at 09:33 -0500, Kamil Paral wrote:
I have made some changes to the AutoQA wiki page [1]. The idea is to have some kind of guidepost, where you easily find part relevant for you and continue to more detailed description at linked page.
I have tried to split our users to two parts - end users (using AutoQA website to see results or receive our notifications) and developers (which contribute to tests and AutoQA itself). I don't know if I have separated them (and described them) in an understandable way. If you have some improvements, please don't hesitate to adjust the page.
What we want to see included on the front page, what we don't want to see there? All suggestions welcome!
I like your simplified "what does it do" wording at the top. I wasn't too clear on the 'end users' and 'developers' section, but I think I see where that's going. If possible, I'd like to link that back to a specific personality from the use case page [1] (which still needs work -- any help appreciated).
I've adjusted your suggested page slightly and posted for review at https://fedoraproject.org/wiki/User:Jlaska/Draft. Let me know what you think.
Thanks, James
----- "James Laska" jlaska@redhat.com wrote:
I've adjusted your suggested page slightly and posted for review at https://fedoraproject.org/wiki/User:Jlaska/Draft. Let me know what you think.
The bullet points are probably easier to read than my continuous text.
In "Getting involved", splitting it between developer and administrator is good. I would move a few links, for example you have to install autotest (at least client) to have autoqa, so it doesn't really fit for me to have "install autotest" in administrator section, when you have whole "install autoqa" in developer section. But that will be worked out when we have enough documentation.
What I am missing is a section for a user, who: * doesn't want to develop test * doesn't want to run autoqa instance * just wants to see the results, subscribe to some of them, read some details how tests works, how often are results updates, etc - the general info That was what I called "end user" in my version of front page (probably not a good name). I think we should have some info prepared also for them.
On Wed, 2009-11-18 at 10:44 -0500, Kamil Paral wrote:
----- "James Laska" jlaska@redhat.com wrote:
I've adjusted your suggested page slightly and posted for review at https://fedoraproject.org/wiki/User:Jlaska/Draft. Let me know what you think.
The bullet points are probably easier to read than my continuous text.
In "Getting involved", splitting it between developer and administrator is good. I would move a few links, for example you have to install autotest (at least client) to have autoqa, so it doesn't really fit for me to have "install autotest" in administrator section, when you have whole "install autoqa" in developer section. But that will be worked out when we have enough documentation.
Yeah I agree, that wiki page doesn't yet exist. We'll likely need a page that addresses bullet#4.1 of https://fedoraproject.org/wiki/AutoQA_Use_Cases#Getting_Started_with_AutoQA.
I know we've got a few pieces of code still coming to facilitate that, but once that has landed hopefully we can outline the steps needed by test developers to write the tests.
What I am missing is a section for a user, who:
- doesn't want to develop test
- doesn't want to run autoqa instance
- just wants to see the results, subscribe to some of them, read some
details how tests works, how often are results updates, etc - the general info That was what I called "end user" in my version of front page (probably not a good name). I think we should have some info prepared also for them.
I see, yeah that makes sense. What should we call this personality. test results triager?
Thanks, James
On Wed, 2009-11-18 at 13:06 -0500, James Laska wrote:
On Wed, 2009-11-18 at 10:44 -0500, Kamil Paral wrote:
----- "James Laska" jlaska@redhat.com wrote:
I've adjusted your suggested page slightly and posted for review at https://fedoraproject.org/wiki/User:Jlaska/Draft. Let me know what you think.
The bullet points are probably easier to read than my continuous text.
In "Getting involved", splitting it between developer and administrator is good. I would move a few links, for example you have to install autotest (at least client) to have autoqa, so it doesn't really fit for me to have "install autotest" in administrator section, when you have whole "install autoqa" in developer section. But that will be worked out when we have enough documentation.
Yeah I agree, that wiki page doesn't yet exist. We'll likely need a page that addresses bullet#4.1 of https://fedoraproject.org/wiki/AutoQA_Use_Cases#Getting_Started_with_AutoQA.
I know we've got a few pieces of code still coming to facilitate that, but once that has landed hopefully we can outline the steps needed by test developers to write the tests.
What I am missing is a section for a user, who:
- doesn't want to develop test
- doesn't want to run autoqa instance
- just wants to see the results, subscribe to some of them, read some
details how tests works, how often are results updates, etc - the general info That was what I called "end user" in my version of front page (probably not a good name). I think we should have some info prepared also for them.
I've updated my draft with some links targeting the user you've suggested. I'd like to keep the page to as close to 1 page height of information as much as possible. Any larger, and my eyes start wonder.
https://fedoraproject.org/wiki/User:Jlaska/Draft
I'd almost like to clean it up further, but I could use feedback on the current content.
Thanks, James
----- "James Laska" jlaska@redhat.com wrote:
I've updated my draft with some links targeting the user you've suggested. I'd like to keep the page to as close to 1 page height of information as much as possible. Any larger, and my eyes start wonder.
https://fedoraproject.org/wiki/User:Jlaska/Draft
I'd almost like to clean it up further, but I could use feedback on the current content.
I would say that it is relevant to the current state of project development. When we have public results and more complete documentation, I expect the front page would be changed, but for the time being I see it well fit.
autoqa-devel@lists.fedorahosted.org
-
James Laska -
Kamil Paral