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

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.

Core

These projects are the priority for the Documentation Team.

Boxes

Docs status:

[NEEDSWORK] GNOME 3.16

Notes:

https://wiki.gnome.org/Apps/Boxes/Documentation/MallardBrainstorming

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-boxes.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-boxes/issues?label_name[]=8.+User+Docs

Contact:

Mike Hill

Calculator

Docs status:

[OK] GNOME

Notes:

Some Gcalctool documentation bugs need fixing.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gcalctool.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-calculator/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

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 https://gitlab.gnome.org/GNOME/gnome-contacts.git

Help Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-user-docs.git

Documentation Bugs:

In gnome-user-docs

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 https://gitlab.gnome.org/GNOME/evince.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/evince/issues?label_name[]=8.+User+Docs

Contact:

gedit Text Editor

Docs status:

[NEEDSWORK] GNOME 3.16

Notes:

UI has been redesigned for 3.12

Git repository:

git clone https://gitlab.gnome.org/GNOME/gedit.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gedit/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/gnome-terminal.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-terminal/issues?label_name[]=8.+User+Docs

Contact:

Vino Desktop Sharing

Docs status:

[REVIEW] GNOME 3.16

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/vino.git

Documentation Bugs:

In gnome-user-docs.

Contact:

Ekaterina Gerasimova

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 https://gitlab.gnome.org/GNOME/epiphany.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/epiphany/issues?label_name[]=8.+User+Docs

Contact:

Kat

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 https://gitlab.gnome.org/GNOME/aisleriot.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/aisleriot/issues?label_name[]=8.+User+Docs

Contact:

five-or-more

Docs status:

[OK] GNOME 3.32

Notes:

Topics don't have descriptions

Git repository

git clone https://gitlab.gnome.org/GNOME/five-or-more.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/five-or-more/issues?label_name[]=8.+User+Docs

Contact:

four-in-a-row

Docs status:

[OK] GNOME 3.32

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/four-in-a-row.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/four-in-a-row/issues?label_name[]=8.+User+Docs

Contact:

gnome-chess

Docs status:

[OK] GNOME 3.32

Notes:

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-chess.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-chess/issues?label_name[]=8.+User+Docs

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

git clone https://gitlab.gnome.org/GNOME/gnome-klotski.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-klotski/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

gnome-mahjongg

Docs status:

[REFRESH] GNOME 3.12

Notes:

Simply need to remove references to the menu bar.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-mahjongg.git

Documentation Bugs:

Bug 618344

Contact:

Chris Beiser

gnome-mines

Docs status:

[OK] GNOME 3.29

Notes:

Topics don't have descriptions, need to cover themes

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-mines.git

Documentation Bugs:

Bug 618343

Contact:

Sophia Yu

gnome-nibbles

Docs status:

[NEEDSWORK] GNOME

Notes:

Major UI redesign landing for 3.20; documentation will need to be refreshed all-around.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-nibbles.git

Documentation Bugs:

Bug 665832

Contact:

Ekaterina Gerasimova

gnome-robots

Docs status:

[REFRESH] GNOME

Notes:

Need to remove references to the menu bar.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-robots.git

Documentation Bugs:

Bug 665833

Contact:

gnome-sudoku

Docs status:

[NEEDSWORK] GNOME 3.12

Notes:

Needs significant updates due to major UI redesign

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-sudoku.git

Documentation Bugs:

Bug 618342

Contact:

gnome-tetravex

Docs status:

[REFRESH]

Notes:

Need to remove references to the menu bar.

Git repository

git clone https://gitlab.gnome.org/GNOME/gnome-tetravex.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-tetravex/issues?label_name[]=8.+User+Docs

Contact:

iagno

Docs status:

[REFRESH]

Notes:

In Mallard, needs refresh. Still references the menu bar....

Git repository

git clone https://gitlab.gnome.org/GNOME/iagno.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-iagno/issues?label_name[]=8.+User+Docs

Contact:

Brian Grohe

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 https://gitlab.gnome.org/GNOME/lightsoff.git

Documentation Bugs:

Bug 665836

Contact:

Perumal Viravan

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 https://gitlab.gnome.org/GNOME/quadrapassel.git

Documentation Bugs:

Bug 618345

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 https://gitlab.gnome.org/GNOME/swell-foop.git

Documentation Bugs:

Bug 664951

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 https://gitlab.gnome.org/GNOME/tali.git

Documentation Bugs:

Bug 665835

Contact:

Other applications/projects

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 https://gitlab.gnome.org/GNOME/gnome-documents.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-documents/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/file-roller.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/file-roller/issues?label_name[]=8.+User+Docs

Contact:

Simple Scan

Docs status:

[REVIEW] GNOME 3.16

Notes:

Complete.

Git repository:

git clone https://gitlab.gnome.org/GNOME/simple-scan.git

Bugs (not documentation only):

https://gitlab.gnome.org/GNOME/simple-scan/issues?label_name[]=8.+User+Docs

Contact:

Robert Ancell

Networking and web applications

Polari IRC client

Docs status:

[NEEDSWORK] GNOME

Notes:

New application

Git repository:

git clone https://gitlab.gnome.org/GNOME/polari.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/polari/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/vinagre.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/vinagre/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Multimedia applications

Brasero Disc Burner

Docs status:

[OK] GNOME

Notes:

Complete, check if it needs a review. Note that Brasero is unmaintained as of 2019.

Git repository:

git clone https://gitlab.gnome.org/GNOME/brasero.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/brasero/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Cheese Photo Booth Application

Docs status:

[OK] GNOME 3.16

Notes:

Updated for 3.12

Git repository:

git clone https://gitlab.gnome.org/GNOME/cheese.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/cheese/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Music

Docs status:

[NEEDSWORK]

Notes:

UI changes planned for 3.12, wait until these are done

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-music.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-music/issues?label_name[]=8.+User+Docs

Contact:

Photos

Docs status:

[NEEDSWORK]

Notes:

Sort of done. Needs some editing. Will be up on a branch soon.

Git repository:

git clone gits://git.gnome.org/browse/gnome-photos.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-photos/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/pitivi.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/pitivi/issues?label_name[]=8.+User+Docs

Contact:

Jeff Fortin

Rhythmbox Media Player

Docs status:

[OK] GNOME 3.32

Notes:

Updated for 3.4.3, released in January 2019.

Git repository:

git clone https://gitlab.gnome.org/GNOME/rhythmbox.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/rhythmbox/issues?label_name%5B%5D=8.+User+Docs

Contact:

Jim Campbell

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.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/shotwell/issues?label_name[]=8.+User+Docs

Contact:

Shotwell developers

Totem Movie Player

Docs status:

[OK] GNOME 3.32

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/totem.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/totem/issues?label_name[]=8.+User+Docs

Contact:

Ekaterina Gerasimova

Other Utilities

GNOME Notes

Docs status:

[OK] GNOME 3.15

Notes:

Complete. Needs some minor language improvements.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-notes.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-notes/issues?label_name%5b%5d=8.+User+Docs

Contact:

Dictionary

Docs status:

[NEEDSWORK] 3.26

Notes:

UI has radically changed; needs pages on "Strategies" and installing a offline DICT server.

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-dictionary.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-dictionary/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/baobab.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/baobab/issues?label_name[]=8.+User+Docs

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 https://gitlab.gnome.org/GNOME/evolution.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/evolution/issues?label_name[]=8.+User+Docs

Contact:

Andre Klapper

Characters

Docs status:

[NEEDSWORK]

Notes:

Git repository:

git clone https://gitlab.gnome.org/GNOME/gnome-characters.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-characters/issues?label_name[]=8.+User+Docs

Contact:

Passwords and Keyrings

Docs status:

[OK] GNOME 3.14

Notes:

Needs review.

Git repository:

git clone https://gitlab.gnome.org/GNOME/seahorse.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/seahorse/issues?label_name[]=8.+User+Docs

Contact:

Jim Campbell

Maps

Docs status:

[OK] GNOME

Notes:

Nothing to document here, move along

Git repository:

git clone gits://git.gnome.org/browse/gnome-maps.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-maps/issues?label_name[]=8.+User+Docs

Contact:

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 https://gitlab.gnome.org/GNOME/gnome-system-monitor.git

Documentation Bugs:

https://gitlab.gnome.org/GNOME/gnome-system-monitor/issues?label_name[]=8.+User+Docs

Contact:

Mike Hill

CategoryDocumentationProject

DocumentationProject/Tasks/ApplicationHelp (last edited 2019-03-02 21:01:20 by AndreKlapper)