My favorites | Sign in
Project Logo
                
New issue | Search
for
| Advanced search | Search tips
Issue 23: Documentation Testing - Part 7
5 people starred this issue and may be notified of changes. Back to list
Status:  Completed
Owner:  vincent.untz
Closed:  Nov 2007
Documentation
ClaimedBy-patrick.hulin


Sign in to add a comment
 
Reported by vincent.untz, Nov 20, 2007
Benefits: Give our doc writer(s) a better idea where to focus concentration
Requirements: Computer running GNOME default

Our documentation is pretty out-of-date in a lot of areas. This task would
see the student reading through several GNOME manuals. For each item /
description / idea in the manual, ensure it is still valid (i.e. for
keyboard shortcuts, ensure the key-sequence is still valid) and report bugs
when they discover problems. Bonus marks for finding the updated sequence /
feature etc.

This task is about the manuals of the following applications: Configuration
Editor, GNOME Power Manager, GNOME Terminal, System Log Viewer, System Monitor

Links:
 Online Manuals: http://library.gnome.org/users/
Comment 1 by andre.klapper, Nov 20, 2007
(No comment was entered for this change.)
Status: Open
Comment 2 by patrick.hulin, Nov 28, 2007
I'll take this task.
Comment 3 by vincent.untz, Nov 28, 2007
Welcome on board!

The time limit for this task is one week. If you have any question, just ask :-)
We'll contact you to send you the list of mails.
Status: Claimed
Comment 4 by vincent.untz, Nov 28, 2007
(No comment was entered for this change.)
Labels: ClaimedBy-patrick.hulin
Comment 5 by patrick.hulin, Nov 28, 2007
So do you want me to submit a bug for each manual, for each issue, or one including
all the problems I find?
Comment 7 by patrick.hulin, Nov 28, 2007
I don't have a laptop with gnome installed, so it might be difficult to complete the
power manager manual review. However, I can submit the gconf changes, etc. just fine.
Comment 8 by DonScorgie, Nov 28, 2007
If there are several bugs that relate to each other, it would be better to group them
together as 1 bug (i.e. "all the keyboard shortcuts are wrong in this manual"), but
if the bugs are distinct and separate, it would be better to file separate bugs for them.
Comment 9 by DonScorgie, Nov 28, 2007
For the GNOME Power Manager, you're plan sounds reasonable and sufficient for the task.
Comment 10 by patrick.hulin, Nov 28, 2007
OK, thanks. I'll start filing bugs.
Comment 11 by patrick.hulin, Nov 28, 2007
Oof, the system monitor is way out of date. Do you want me to try to write the stuff
to be added or is that to be left to the doc writers? Should I just outline what
needs to be added?
Comment 12 by vincent.untz, Nov 29, 2007
Patrick: if you can write the missing pieces, that'd be fantastic! (although the
minimum requirement is probably only an outline)
Comment 13 by patrick.hulin, Nov 29, 2007
I have completed the review of all the manuals and submitted all the bugs. Anything
else you need me to do? You can search bugzilla for all the bugs I have submitted,
and I did rewrite large parts of the system-monitor docs and submitted a patch to
Bugzilla. Thank you for all the help.


Comment 14 by andre.klapper, Nov 29, 2007
see http://bugzilla.gnome.org/describeuser.cgi?login=patrick.hulin AT gmail.com (you
must be logged in to gnome bugzilla to view the page) for the 12 filed bug reports.

patrick, very good work. thanks a lot!

closing this ticket as "completed", guess that vuntz won't contradict :)
Status: Completed
Comment 15 by behdad.esfahbod, Nov 29, 2007
Good job!
Sign in to add a comment

Hosted by Google Code