<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, May 14, 2013 at 12:04 PM, Kashyap Chamarthy <span dir="ltr"><<a href="mailto:kchamart@redhat.com" target="_blank">kchamart@redhat.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div class="im">On 05/14/2013 09:37 PM, Daryl Walleck wrote:<br>
>>From my experience, doing a plain text test plan for applications with the complexity of Nova doesn't scale well. I tried that, but without ways to intelligently sort/search/group test cases, it became unmanageable when I actually needed to pull data from it. I've been tinkering with a test management tool based on Google's ACC methodology (<a href="http://code.google.com/p/test-analytics/wiki/AccExplained" target="_blank">http://code.google.com/p/test-analytics/wiki/AccExplained</a>) that's solved some of my issues with managing test cases. It's definitely not perfect, but I'd be open to sharing what I've worked on and how I've broken out my test cases.<br>
<br>
</div>Sure, interested to see your experience.<br>
<br>
When someone mentioned test-analytics, my quick attempt kept me waiting at<br>
"Loading project list".<br>
<br>
Meanwhile, I recently came across ASCII doc -- -- <a href="http://asciidoc.org/" target="_blank">http://asciidoc.org/</a>, and<br>
heard some very good reviews in community<br>
<br>
Reviews comparing it w/ various light weight markup languages:<br>
<br>
"I had the opportunity to seriously evaluate and contrast the serious<br>
lightweight markup languages: reStructuredText (and its complement Sphinx),<br>
Textile and AsciiDoc. Hands down, AsciiDoc is the winner. If there's such a<br>
thing as a sure thing in software, AsciiDoc is it."<br>
<br>
- <a href="https://community.jboss.org/message/721016" target="_blank">https://community.jboss.org/message/721016</a><br>
- <a href="https://plus.google.com/114112334290393746697/posts/CdXJt6hVn5A" target="_blank">https://plus.google.com/114112334290393746697/posts/CdXJt6hVn5A</a><br>
<br>
Of-course, we don't *have* to take it on its face, but maybe doesn't hurt to<br>
evaluate?<br>
<br>
My 02 cents on why plain text ? (these are plain obvious, but just spelling<br>
out):<br>
<br></blockquote><div style><br>Plain text is great, and asciidoc is a clear winner from the OpenStack docs perspective due to our existing build tools being able to handle it. It converts to docbook easily. However, I'm not sure if this document you are talking about needs to be published in any other format other than plain text? If you just need a web page to point to, you might not need to go through the trouble of publishing and could just use github's markdown and point to the github page. <a href="https://help.github.com/articles/github-flavored-markdown">https://help.github.com/articles/github-flavored-markdown</a></div>
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
Pros:<br>
<br>
(1) Text file are fast, easy to manage. I bet, they'll still be here 50 years<br>
later! These bulky "management systems" - I doubt that.<br>
<br>
(2) Works well over bad internet connections/remotely (I often work w/ a 2GB<br>
usb internet card). We can use tmux/screen session on a remote machine & work<br>
peacefully.<br>
<br>
(3) You can send patches, and apply them via the venerable git (and do all<br>
other magic).<br>
<br>
(4) Most (linux) developers are averse to clicky things. I've never seen<br>
someone review. However, they're (some) happy to contribute tests if they're<br>
text based approach somewhere in git files.<br>
<br>
(5) OpenStack uses rST (for all its README & docs & everywhere else).<br>
But, I'm aware, it's not the same as tests.<br>
<br>
(6) Add your own..<br>
<br>
<br>
Cons:<br>
<br>
(1) Integration with Jenkins, etc ?<br>
- That's only needed for automation tests.<br>
<br></blockquote><div><br></div><div style>We can integrate and build API docs starting with asciidoc, markdown, or rst. API docs so far are in docbook, WADL, or markdown. We have the High Availability guide in asciidoc.</div>
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
(2) Reporting (although we could write scripts, but it's difficult).<br>
<br>
(3) Maintanability ?<br>
- git ?<br>
<br>
(4) I haven't seen any eamples of folks using text file based approach (that<br>
doesn't mean it shouldn't be explored.<br></blockquote><div><br></div><div style>Take a look at the <a href="http://github.com/openstack/">github.com/openstack/</a><project>-api repositories to see how API docs are being maintained now.</div>
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
(5) .. ?<br></blockquote><div><br></div><div style>(5) Tables are difficult to create and maintain in nearly all plain text markups (if you need to add a column it's a pain, for example.)</div><div style> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
<br>
Don't hesitate to call me crazy, if I'm so. Thoughts ?<br>
<br>
PS: Just to explore rST, I recently wrote some quick instructions while testing<br>
nested virtualization w/ upstream kvm --<br>
<a href="https://raw.github.com/kashyapc/nvmx-haswell/master/SETUP-nVMX.rst" target="_blank">https://raw.github.com/kashyapc/nvmx-haswell/master/SETUP-nVMX.rst</a> (not the<br>
most beautifully formatted, but I don't hate it either):<br>
<br>
Thanks.<br>
<span class=""><font color="#888888">--<br>
/kashyap<br>
</font></span><div class=""><div class="h5"><br>
_______________________________________________<br>
openstack-qa mailing list<br>
<a href="mailto:openstack-qa@lists.openstack.org">openstack-qa@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-qa" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-qa</a><br>
</div></div></blockquote></div><br></div></div>