1055223 - Convert Testopia documentation to .rst format

Status: RESOLVED FIXED

(Testopia :: General, enhancement)

Description

[u430950]

In order to take advantage of the new documentation format, as well as improve the quality of the Testopia documentation itself by making it easier to work with, Testopia should include an .rst version of its docs.

Comment 1

[u430950]

Attachment: testopia.diff

Comment 2

[Frédéric Buclin]

Comment on attachment 8474747 [details] [diff] [review]
testopia.diff

The doc compiles correctly. The URL to download Bugzilla doesn't work, but it can be fixed on checkin (typo in the URL). Requirements mention JSON 1.14, but I have JSON 2.59 on my machine and Testopia is working correctly, so I assume the recommended version could be bumped, or even left blank. Feel free to file a separate bug if needed. r=LpSolit

Do you still want the other Manual.* files in the repo, or should they be removed now that you have this RST file?

Comment 3

[Frédéric Buclin]

One more thing about your patch: lines are way too long and should be split (at around 80 characters per line), for readability. Do you want to submit a new patch to fix that?

Comment 4

[u430950]

I will submit a new patch with the changes you have suggested in comment 2 and comment 3. The document content is, for the most part, a copy/paste of the PDF file, with glaring mistakes corrected and proper formatting. I'm hoping to fix up some of the more lacking documentation areas (such as test environments) while working on bug 812482.

I would honestly keep the existing manual files in the system until Bugzilla 5.0 is the oldest version still being supported, as it will be the first version that would be able to utilize this new RST format.

Comment 5

[u430950]

Attachment: testopiav2.diff

Updated version of the Testopia rst file with changes requested in comment 2 and comment 3.

Comment 6

[Frédéric Buclin]

Comment on attachment 8475243 [details] [diff] [review]
testopiav2.diff

r=LpSolit

Comment 7

[Frédéric Buclin]

I cannot remember if you have commit privs to the git repos or not... Tell me if you want me to commit your patch.

Comment 8

[u430950]

I do not have commit privileges to the git repos, so, at least for the time being, any changes made by me will need to be pushed to git by someone else.

Comment 9

[Frédéric Buclin]

To ssh://[e-mail]/bugzilla/extensions/testopia.git
   567f865..f674204  master -> master