Gnome 42 documentation work plan
This is a meta issue for user docs work to be done in GNOME 42. This is a living document. You can use comments to ask questions or make suggestions, but the full work plan should remain in this description. Often things on this list should link to issues or MRs with more details. Checking things off the list will sometimes involve adding other things to the list.
Reviews
Record the status of reviewed pages using the revision element with the status
attribute set to gnome:42
.
For example, if a page is final for GNOME 42:
<revision version="gnome:42" status="final" date="2022-02-12"/>
Use yelp-check
to check the status of pages. For example:
yelp-check status --version gnome:42
Lessons
https://blogs.gnome.org/shaunm/2021/07/13/discovery-docs-part-2-templates-and-taxonomies/
GNOME Help
These are the modules we're focusing on, taken from gnome-build-meta:
gnome-user-docs (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review a11y
pages for correctness. Look for opportunities to use lessons. -
Review about
pages for correctness. Look for opportunities to use lessons. -
Review accounts
pages for correctness. Look for opportunities to use lessons. -
Review backup
pages for correctness. Look for opportunities to use lessons. -
Review bluetooth
pages for correctness. Look for opportunities to use lessons. -
Review clock
pages for correctness. Look for opportunities to use lessons. -
Review color
pages for correctness. Look for opportunities to use lessons. -
Review contacts
pages for correctness. Look for opportunities to use lessons. -
Review disk
pages for correctness. Look for opportunities to use lessons. -
Review display
pages for correctness. Look for opportunities to use lessons. -
Review files
pages for correctness. Look for opportunities to use lessons. -
Review get
pages for correctness. Look for opportunities to use lessons. -
Review gnome
pages for correctness. Look for opportunities to use lessons. -
Review hardware
pages for correctness. Look for opportunities to use lessons. -
Review help
pages for correctness. Look for opportunities to use lessons. -
Review keyboard
pages for correctness. Look for opportunities to use lessons. -
Review look
pages for correctness. Look for opportunities to use lessons. -
Review media
pages for correctness. Look for opportunities to use lessons. -
Review more
pages for correctness. Look for opportunities to use lessons. -
Review mouse
pages for correctness. Look for opportunities to use lessons. -
Review music
pages for correctness. Look for opportunities to use lessons. -
Review nautilus
pages for correctness. Look for opportunities to use lessons. -
Review net
pages for correctness. Look for opportunities to use lessons. -
Review power
pages for correctness. Look for opportunities to use lessons. -
Review prefs
pages for correctness. Look for opportunities to use lessons. -
Review printing
pages for correctness. Look for opportunities to use lessons. -
Review privacy
pages for correctness. Look for opportunities to use lessons. -
Review screen
pages for correctness. Look for opportunities to use lessons. -
Review session
pages for correctness. Look for opportunities to use lessons. -
Review sharing
pages for correctness. Look for opportunities to use lessons. -
Review shell
pages for correctness. Look for opportunities to use lessons. -
Review sound
pages for correctness. Look for opportunities to use lessons. -
Review status
pages for correctness. Look for opportunities to use lessons. -
Review tips
pages for correctness. Look for opportunities to use lessons. -
Review touchscreen
pages for correctness. Look for opportunities to use lessons. -
Review translate
pages for correctness. Look for opportunities to use lessons. -
Review user
pages for correctness. Look for opportunities to use lessons. -
Review video
pages for correctness. Look for opportunities to use lessons. -
Review wacom
pages for correctness. Look for opportunities to use lessons.
Apps covered in gnome-user-docs
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Handle freeze break 55. -
Handle freeze break 56. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Handle freeze break 53. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
-
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Replace this with more tasks as necessary.
Core apps with existing help
baobab (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
cheese (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
connections (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
eog (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
epiphany (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
evince (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-calculator (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-clocks (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-color-manager (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-logs (all user docs MRs) (all user docs issues) (users docs issues for 42)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-music (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-photos (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-system-monitor (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
gnome-text-editor (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
simple-scan (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
totem (all user docs issues) (users docs issues for 42) (all user docs MRs)
-
Review existing pages for correctness and opportunities to use lessons. -
Review NEWS for information on what's changed. -
Reach out to maintainers for things they think are important this cycle. -
Triage existing issues marked with 8. User Docs. -
Replace this with more tasks as necessary.
Core apps without existing help
- console
- gnome-calendar
- gnome-characters
- gnome-contacts
- gnome-font-viewer
- gnome-maps
- gnome-software
- gnome-weather
Dev tools
Games
- aisleriot:
- five-or-more:
- four-in-a-row:
- gnome-chess:
- gnome-klotski:
- gnome-mahjongg:
- gnome-mines:
- gnome-nibbles:
- gnome-robots:
- gnome-sudoku:
- gnome-taquin:
- gnome-tetravex:
- hitori:
- iagno:
- lightsoff:
- quadrapassel:
- swell-foop:
- tali
Other projects
-
file-roller
-
gnome-terminal
-
evolution
-
geary
-
seahorse
-
You can add things here, as long as they're following our release schedule.