Export to GitHub

google-highly-open-participation-gnome - issue #23

Documentation Testing - Part 7


Posted on Nov 20, 2007 by Grumpy Panda

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

Posted on Nov 20, 2007 by Swift Wombat

(No comment was entered for this change.)

Comment #2

Posted on Nov 28, 2007 by Massive Lion

I'll take this task.

Comment #3

Posted on Nov 28, 2007 by Grumpy Panda

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.

Comment #4

Posted on Nov 28, 2007 by Grumpy Panda

(No comment was entered for this change.)

Comment #5

Posted on Nov 28, 2007 by Massive Lion

So do you want me to submit a bug for each manual, for each issue, or one including all the problems I find?

Comment #6

Posted on Nov 28, 2007 by Massive Lion

Comment deleted

Comment #7

Posted on Nov 28, 2007 by Massive Lion

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

Posted on Nov 28, 2007 by Helpful Panda

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

Posted on Nov 28, 2007 by Helpful Panda

For the GNOME Power Manager, you're plan sounds reasonable and sufficient for the task.

Comment #10

Posted on Nov 28, 2007 by Massive Lion

OK, thanks. I'll start filing bugs.

Comment #11

Posted on Nov 29, 2007 by Massive Lion

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

Posted on Nov 29, 2007 by Grumpy Panda

Patrick: if you can write the missing pieces, that'd be fantastic! (although the minimum requirement is probably only an outline)

Comment #13

Posted on Nov 30, 2007 by Massive Lion

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

Posted on Nov 30, 2007 by Swift Wombat

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 :)

Comment #15

Posted on Nov 30, 2007 by Happy Camel

Good job!

Status: Completed

Labels:
Documentation ClaimedBy-patrick.hulin