Contents
Application Help Tasks
This page is designed so you can:
- find a GNOME application that you want to document
- see the status of the project documentation
- get the project source files
- review the project's documentation bugs
- contact the project's documentation maintainer
If you're interested in contributing to an application's documentation, contact the documentation maintainer for that project, or send a note to the GNOME documentation mailing list.
Useful References
Reference
Example Mallard documents (from the Epiphany help)
#docs - just click on this link, select Mibbit. When it opens in your browser, type in a Nick you want to use in the field, and click Go. Here you can talk directly to the documentation team. For more info about irc, see here.
Docs status color indicators
This page uses different colors to give a general indication of the documentation status:
Up-to-date: |
Marked with [OK] and the version number. Used when the docs are maintained and are in good shape. |
Need to be refreshed: |
Marked with [REFRESH] and the version number from when the docs were current. Used when the docs may be a bit outdated and need to be reviewed and refreshed. |
Needs work: |
Marked with [NEEDSWORK] and the version number from when the docs were current (if known). Used when docs are significantly outdated. |
Viewing documentation
To view a project's current documentation, clone the project's software repository using the git or bzr command listed for each project, then enter the following into a terminal window:
yelp [project name]/help/C/ |
This will render the project documentation in yelp, the GNOME help browser.
High priority
These are projects that are priorities for the documentation team. We encourage new contributors to see the beginner documentation tasks.
Boxes |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
https://wiki.gnome.org/Apps/Boxes/Documentation/MallardBrainstorming |
|
Git repository: |
git clone git://git.gnome.org/gnome-boxes |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=gnome-boxes&component=documentation&resolution=--- |
|
Contact: |
Contacts |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Check before every release: the UI is in a state of flux |
|
Project git repository: |
git clone git://git.gnome.org/gnome-contacts |
|
Help git repository: |
git clone git://git.gnome.org/gnome-user-docs |
|
Documentation Bugs: |
In gnome-user-docs |
GNOME System Monitor |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Index needs reordering, pages with a "review" status need reviewing. Needs to be made nice for the website. Don't use Latin. |
|
Git repository: |
git clone git://git.gnome.org/gnome-system-monitor |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=system-monitor&component=general&resolution=--- |
|
Contact: |
Core
These projects are the priority for the Documentation Team.
Calculator |
Docs status: |
[OK] GNOME |
Notes: |
Some Gcalctool documentation bugs need fixing. |
|
Git repository: |
git clone git://git.gnome.org/gcalctool |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=gnome-calculator&component=docs&resolution=--- |
|
Contact: |
Empathy Instant Messaging |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Needs major review, but application is unmaintained anyway |
|
Git repository: |
git clone http://git.gnome.org/browse/empathy |
|
Documentation Bugs: |
||
Contact: |
Evince PDF Viewer |
Docs status: |
[NEEDSWORK] GNOME 3.24 |
Notes: |
Andre mostly updated it for 3.25 but some functionality bits remain to be covered |
|
Git repository: |
git clone git://git.gnome.org/evince |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=evince&resolution=---&component=User%20documentation |
|
Contact: |
gedit Text Editor |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
UI has been redesigned for 3.12 |
|
Git repository: |
git clone http://git.gnome.org/browse/gedit |
|
Documentation Bugs: |
||
Contact: |
Jim Campbell - Jim has started work on updates for 3.12 |
GNOME Terminal |
Docs status: |
[OK] GNOME 3.16 |
Notes: |
The Terminal docs are complete however the common problems section and the custom color themes topics need to be written. For 3.14: there are a couple of feature requests open on bugzilla. |
|
Git repository |
git clone http://git.gnome.org/browse/gnome-terminal |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=gnome-terminal&component=docs&resolution=--- |
|
Contact: |
Vino Desktop Sharing |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
|
|
Git repository: |
git clone git://git.gnome.org/vino |
|
Documentation Bugs: |
In gnome-user-docs. |
|
Contact: |
Web |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Idea for improvement, section "Improve my privacy" (Activate Don't track, Privilege use of HTTPS protocol, Untick "Allow Advertisement", Use duckduckgo to perform web search), Commons problems: page crashing, document Often-used websites from Homepage. |
|
Git repository: |
git clone git://git.gnome.org/epiphany |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=epiphany&component=Documentation&resolution=--- |
|
Contact: |
Games
Aisleriot |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
Conversion to Mallard not started. Problem with licensing: compromise with maintainer is CC-by-SA + GPL3 dual license, see terminal help for more info (not compatible with our other projects). Consider bug 338122 and bug 444411 and these bugs too |
|
Git repository |
git clone http://git.gnome.org/browse/aisleriot |
|
Documentation Bugs: |
||
Contact: |
five-or-more |
Docs status: |
[REFRESH] GNOME 3.16 |
Notes: |
Some screenshots use a custom background. Topics don't have descriptions. Need to remove references to the menu bar. |
|
Git repository |
git clone http://git.gnome.org/browse/five-or-more |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=gnome-games&component=docs&resolution=--- |
|
Contact: |
four-in-a-row |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
UI has changed, needs major review and rewrite. |
|
Git repository |
||
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=four-in-a-row&component=documentation&resolution=--- |
|
Contact: |
gnome-chess |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten. |
|
Git repository |
git clone http://git.gnome.org/browse/gnome-chess |
|
Documentation Bugs: |
||
Contact: |
gnome-klotski |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten. |
|
Git repository |
||
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=gnome-klotski&component=documentation&resolution=--- |
|
Contact: |
gnome-mahjongg |
Docs status: |
[REFRESH] GNOME 3.12 |
Notes: |
Simply need to remove references to the menu bar. |
|
Git repository |
||
Documentation Bugs: |
||
Contact: |
gnome-mines |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Topics don't have descriptions, need to remove references to the menu bar |
|
Git repository |
git clone http://git.gnome.org/browse/gnome-mines |
|
Documentation Bugs: |
||
Contact: |
gnome-nibbles |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Major UI redesign landing for 3.20; documentation will need to be refreshed all-around. |
|
Git repository |
||
Documentation Bugs: |
||
Contact: |
gnome-robots |
Docs status: |
[REFRESH] GNOME |
Notes: |
Need to remove references to the menu bar. |
|
Git repository |
git clone http://git.gnome.org/browse/gnome-robots |
|
Documentation Bugs: |
||
Contact: |
gnome-sudoku |
Docs status: |
[NEEDSWORK] GNOME 3.12 |
Notes: |
Needs significant updates due to major UI redesign |
|
Git repository |
git clone http://git.gnome.org/browse/gnome-sudoku |
|
Documentation Bugs: |
||
Contact: |
gnome-tetravex |
Docs status: |
[REFRESH] |
Notes: |
Need to remove references to the menu bar. |
|
Git repository |
||
Documentation Bugs: |
|
|
Contact: |
|
iagno |
Docs status: |
[REFRESH] |
Notes: |
In Mallard, needs refresh. Still references the menu bar.... |
|
Git repository |
git clone http://git.gnome.org/browse/iagno |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=iagno&component=documentation&resolution=--- |
|
Contact: |
lightsoff |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Need new screenshots and a new video; the seven-segment display on the bottom has been removed. Need to remove reference to the "arrow shaped buttons at the bottom of the game" which moved to the header bar. |
|
Git repository |
git clone http://git.gnome.org/browse/iagno |
|
Documentation Bugs: |
||
Contact: |
quadrapassel |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Need to remove references to the menu bar. Reconsider the style sheet; it looks different from all the other user help. Reconsider the full-color house icons and the home links. Reconsider the giant gold foot. Maybe reconsider the giant "PLAY PLAY PLAY!" heading. |
|
Git repository |
git clone http://git.gnome.org/browse/quadrapassel |
|
Documentation Bugs: |
||
Contact: |
swell-foop |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten. |
|
Git repository |
git clone http://git.gnome.org/browse/swell-foop |
|
Documentation Bugs: |
||
Contact: |
tali |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
Documentation has been converted to Mallard but the writing is from the Docbook help. Needs relicensed to GFDL and appropriate author credits added, or else rewritten. |
|
Git repository |
git clone http://git.gnome.org/browse/tali |
|
Documentation Bugs: |
||
Contact: |
Other applications/projects
Developer tools
Anjuta GNOME IDE |
Docs status: |
[OK] GNOME |
Notes: |
Mostly complete, but could use a review. |
|
Git repository |
git clone http://git.gnome.org/browse/anjuta |
|
Documentation Bugs: |
||
Contact: |
Gitg - git repository viewer |
Docs status: |
[NEEDSWORK] |
Notes: |
Conversion to Mallard not started. The UI and functionality are under heavy re-factoring and development hence the task of writing user help pages have been put on hold. |
|
Git repository: |
git clone http://git.gnome.org/browse/gitg |
|
Documentation Bugs: |
||
Contact: |
Files, folders and documents
Documents |
Docs status: |
[OK] GNOME |
Notes: |
TODO: new pages (password protection and sharing through Google Docs) |
|
Project git repository: |
git clone git://git.gnome.org/gnome-documents |
|
Documentation Bugs: |
||
Contact: |
|
File Roller Archive Manager |
Docs status: |
[OK] GNOME |
Notes: |
Docs are in good shape, but feel free to review for any updates or enhancements. |
|
Git repository: |
git clone http://git.gnome.org/file-roller |
|
Documentation Bugs: |
||
Contact: |
Simple Scan |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Complete. |
|
Git repository: |
git clone http://git.gnome.org/simple-scan |
|
Bugs (not documentation only): |
https://bugzilla.gnome.org/buglist.cgi?resolution=---&product=simple-scan |
|
Contact: |
Networking and web applications
Polari IRC client |
Docs status: |
[NEEDSWORK] GNOME |
Notes: |
New application |
|
Git repository: |
git clone git://git.gnome.org/polari |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?component=User%20Docs;product=polari |
|
Contact: |
Vinagre Remote Desktop Viewer |
Docs status: |
[REVIEW] GNOME 3.16 |
Notes: |
Complete. No plants to change UI in the near future. |
|
Git repository: |
git clone git://git.gnome.org/vinagre |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?component=Documentation;product=vinagre |
|
Contact: |
Multimedia applications
Banshee Media Player |
Docs status: |
[REFRESH] GNOME 3.16 |
Notes: |
Complete, but a few documentation bugs need fixing. Hasn't been updated in a while. Could do with a tidy up. |
|
Git repository: |
git clone http://git.gnome.org/banshee/ |
|
Documentation Bugs: |
||
Contact: |
Brasero Disc Burner |
Docs status: |
[OK] GNOME |
Notes: |
Complete, check if it needs a review. |
|
Git repository: |
git clone http://git.gnome.org/brasero |
|
Documentation Bugs: |
||
Contact: |
Cheese Photo Booth Application |
Docs status: |
[OK] GNOME 3.16 |
Notes: |
Updated for 3.12 |
|
Git repository: |
git clone http://git.gnome.org/cheese |
|
Documentation Bugs: |
||
Contact: |
Music |
Docs status: |
[NEEDSWORK] |
Notes: |
UI changes planned for 3.12, wait until these are done |
|
Git repository: |
||
Documentation Bugs: |
|
|
Contact: |
Photos |
Docs status: |
[NEEDSWORK] |
Notes: |
Sort of done. Needs some editing. Will be up on a branch soon. |
|
Git repository: |
||
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?resolution=---&component=documentation&product=gnome-photos |
|
Contact: |
Pitivi video editor |
Docs status: |
[REFRESH] |
Notes: |
Good coverage, but can always be extended, refined or translated. Needs to be updated for major changes for the next release. |
|
Git repository: |
git clone http://git.gnome.org/browse/pitivi |
|
Documentation Bugs: |
||
Contact: |
Rhythmbox Media Player |
Docs status: |
[REFRESH] GNOME |
Notes: |
These docs are a work-in-progress. Although Jim is working on them, this would be a good project for a beginner to help with. |
|
Git repository: |
git clone http://git.gnome.org/rhythmbox |
|
Documentation Bugs: |
||
Contact: |
Shotwell Photo Manager |
Docs status: |
[OK] GNOME |
Notes: |
Docs are complete and are maintained by the Shotwell developers |
|
Git repository: |
git clone git://yorba.org/shotwell |
|
Documentation Bugs: |
||
Contact: |
Totem Movie Player |
Docs status: |
[NEEDSWORK] GNOME 3.16 |
Notes: |
In a branch, needs review and completion. Some UI changes. |
|
Git repository: |
git clone git://git.gnome.org/totem |
|
Documentation Bugs: |
||
Contact: |
Tiffany Antopolski, Marta Bogdanowicz or Ekaterina Gerasimova |
Other Utilities
Bijiben, aka Notes |
Docs status: |
[OK] GNOME 3.15 |
Notes: |
Complete. Needs some minor language improvements. |
|
Git repository: |
git clone git://git.gnome.org/bijiben |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?component=Documentation&product=bijiben |
|
Contact: |
Dictionary |
Docs status: |
[OK] GNOME |
Notes: |
Complete except for pages on "Strategies" and installing a offline DICT server. |
|
Git repository: |
git clone http://git.gnome.org/gnome-dictionary |
|
Documentation Bugs: |
||
Contact: |
Disk Usage Analyzer |
Docs status: |
[OK] |
Notes: |
All bugs closed start of 3.15 cycle. Possibly add screenshot to intro. |
|
Git repository: |
git clone http://git.gnome.org/baobab |
|
Documentation Bugs: |
https://bugzilla.gnome.org/buglist.cgi?product=baobab&component=docs&resolution=--- |
|
Contact: |
|
Evolution Mail and Calendar |
Docs status: |
[OK] GNOME 3.26 |
Notes: |
Up-to-date for for 3.26; smaller Evolution documentation bugs welcome fixing. |
|
Git repository: |
git clone git://git.gnome.org/evolution |
|
Documentation Bugs: |
||
Contact: |
Gucharmap Character Map |
Docs status: |
[NEEDSWORK] |
Notes: |
Licensing issue with old help, rewrite from scratch. Low priority. |
|
Git repository: |
git clone http://git.gnome.org/gucharmap |
|
Documentation Bugs: |
||
Contact: |
|
Passwords and Keyrings |
Docs status: |
[OK] GNOME 3.14 |
Notes: |
Needs review. |
|
Git repository: |
git clone git://git.gnome.org/seahorse |
|
Documentation Bugs: |
||
Contact: |
Maps |
Docs status: |
[OK] GNOME |
Notes: |
Nothing to document here, move along |
|
Git repository: |
||
Documentation Bugs: |
|
|
Contact: |
|
