GSoD Project Report

Update GNOME Applications Help Documentation (Update App help) 

Technical Writer –  Pranali Deshmukh

Project Mentor – Shaun McCance

Important Links

Project description

Review and update the help documentation for a number of GNOME applications as tracked in https://wiki.gnome.org/DocumentationProject/Tasks/ApplicationHelp.

Even though GNOME is extremely user-friendly, it is a large and complex system, and thus, requires some learning to use to the fullest and to do so GNOME has provided some very useful documentation. This project proposed a review and updation of a number GNOME application Help documents. The status of these documents are tracked in the Application Help Wiki (https://wiki.gnome.org/DocumentationProject/Tasks/ApplicationHelp). 

Issues I contributed to: 

  1. https://gitlab.gnome.org/GNOME/gnome-boxes/-/issues/611

Update help docs for 3.38

Find and implement changes to the user help docs for Boxes to ensure that the documents are in sync with version 3.38

  • Update the Create Box Page
  • Remove the Share Clipboard option
  • Update the User Interface page
    • Remove the Share Clipboard switch reference from the General tab section
    • Add an entry about the 3D Acceleration switch to the General tab section
  • Create new pages for the following new features:
    • 3D acceleration
    • Identify an OS
    • Edit VM configuration/XML
  1. https://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185

Update help docs for 3.38

Find and implement changes to the user help docs for the calculator to ensure that the documents are in sync with version 3.38

  • Update the following help pages:
    • Update Superscript and Subscript
    • Update Using the Keyboard
    • Update Using the history view
  • We don’t appear to have a page explaining the modes. We should add one of those and link to it everywhere we mention a mode. Create new pages for the following features:
    • Modes Overview
    • Basic Mode
    • Advanced Mode
    • Financial Mode
    • Programming Mode
    • Keyboard Mode
  1. https://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84

Update help docs for 3.38

Find and implement changes to the user help docs for the GNOME Contacts app to ensure that the documents are in sync with version 3.38

Update the following help pages:

  • Update Contact add and remove
  • Update Starting Contacts for the first time
  • Update Connect with your contact
  • Update Edit contact details
  1. https://gitlab.gnome.org/GNOME/gedit/-/issues/349

Help: missing word in gedit-open-recent.page

In https://gitlab.gnome.org/GNOME/gedit/-/blob/master/help/C/gedit-open-recent.page is a string that starts with When hovering with the mouse a recently-used file from the menu, the full path to the file is displayed

here my guess is that the word over is missing, so that it really should start with When hovering with the mouse over a recently-used file

  1. https://gitlab.gnome.org/GNOME/swell-foop/-/issues/19

help: Zealous animation option mixed up

In https://gitlab.gnome.org/GNOME/swell-foop/-/blob/master/help/C/preferences.page is the string

To slow down the animations, uncheck the checkbox.

This feels wrong, as disabling the more advanced graphics probably would increase the speed. Should this be check the <gui style=\"checkbox\">Zealous Animation</gui> checkbox instead?

Furthermore the string before that is:

If it is too fast for you and you would like playing slower then this may be too fast for you.

The end of this string is always true if the start is, and it repeats itself, so it might be nice to change it a bit. Maybe shortening it to something like If it is too fast for you, then you might like playing slower.

  1. https://gitlab.gnome.org/GNOME/file-roller/-/issues/80

archive-edit.page: Add F2 key shortcut.

https://gitlab.gnome.org/GNOME/file-roller/-/blob/master/help/C/archive-edit.page#L48

<p>Right-click on the file and choose <gui style="menuitem">Rename…</gui>.

My suggestion:

<p>Right-click on the file and choose <gui style="menuitem">Rename…</gui> or press <key>F2</key>

  1. https://gitlab.gnome.org/GNOME/gnome-notes/-/issues/75

format-list.page in manual needs to be revised.

Link to original bug (#766195)

Description

While reading help/C/format-list.page however I noticed that the “Bullets” button has been moved to a popover, so this page needs to be revised as agreed in bug 766129.

  1. https://gitlab.gnome.org/GNOME/evince/-/issues/134

Consolidate the many Printing related pages in Evince user help

Those gazillions of pages are hard to maintain and unneededly cumbersome. Plus:

Both could be a simple <p>Please see <link xref="help:gnome-help/printing-*****" href="https://help.gnome.org/users/gnome-help/stable/printing-*****">the GNOME Desktop Help</link>.</p> but maybe we had standalone Windows users in mind here?

My Contributions:

Sr. No.AppIssueTitleStart DateEnd DateCommitsMerge Request
1EvinceUnlistedUpdated Contribution Guidelines02/07/2002/07/20https://gitlab.gnome.org/GNOME/evince/-/commit/e13339c8ee1dc0bf876d2af466f287215a2370a9https://gitlab.gnome.org/GNOME/evince/-/merge_requests/267
2Evincehttps://gitlab.gnome.org/GNOME/evince/-/issues/1344Consolidate the many Printing related pages in Evince user help02/07/2005/07/20https://gitlab.gnome.org/GNOME/evince/-/commit/6c4304598e92da50c3035953e82e12ddbc2e12dfhttps://gitlab.gnome.org/GNOME/evince/-/merge_requests/266
3Evincehttps://gitlab.gnome.org/GNOME/evince/-/issues/1345Update annotations-nav-to-page.png in user docs30/06/2030/06/20https://gitlab.gnome.org/GNOME/evince/-/commit/c8ae029bedeafe17d22928c0e805ff9b0329e246https://gitlab.gnome.org/GNOME/evince/-/merge_requests/265
4Bijibenhttps://gitlab.gnome.org/GNOME/gnome-notes/-/issues/75format-list.page in manual needs to be revised.10/07/2013/06/20https://gitlab.gnome.org/GNOME/gnome-notes/-/commit/642ce07665f3c1b9ad72e9afcf64de1fd2ace058https://gitlab.gnome.org/GNOME/gnome-notes/-/merge_requests/69
5File Rollerhttps://gitlab.gnome.org/GNOME/file-roller/-/issues/80archive-edit.page: Add F2 key shortcut20/07/2020/07/20https://gitlab.gnome.org/GNOME/file-roller/-/commit/5aa547f976754f4f5169e825db5aee5761185fd8https://gitlab.gnome.org/GNOME/file-roller/-/merge_requests/41
6Seahorsehttps://gitlab.gnome.org/GNOME/seahorse/-/issues/272Maybe change “date and time” to “date” in Expiration Date20/07/2020/07/20https://gitlab.gnome.org/GNOME/seahorse/-/commit/07f3a377a9adfb28ac5771235c7255c531c2f4b6https://gitlab.gnome.org/GNOME/seahorse/-/merge_requests/138
7SeahorseUnlistedhelp: Fix minor grammatical syntax27/07/2027/07/20https://gitlab.gnome.org/GNOME/seahorse/-/commit/de30c16489c014e568cfad89c4663e79005a50c2https://gitlab.gnome.org/GNOME/seahorse/-/merge_requests/139
8Swell-foophttps://gitlab.gnome.org/GNOME/swell-foop/-/issues/19help: Zealous animation option mixed up03/08/2003/08/20https://gitlab.gnome.org/GNOME/swell-foop/-/commit/5a741246df63a015dc59110df8866664c4e71aa8https://gitlab.gnome.org/GNOME/swell-foop/-/merge_requests/22
9Gedithttps://gitlab.gnome.org/GNOME/gedit/-/issues/349Help:missing word in gedit-open-recent-page03/08/2003/08/20https://gitlab.gnome.org/GNOME/gedit/-/commit/1767db62bb60a30952c94046ea095ce8f65abed9https://gitlab.gnome.org/GNOME/gedit/-/merge_requests/96
12Boxeshttps://gitlab.gnome.org/GNOME/gnome-boxes/-/issues/611Update help docs for GNOME 3.3825/09/2025/09/20https://gitlab.gnome.org/GNOME/gnome-boxes/-/commit/8f8d478f2107dd4680f1109cc2075e97d8fbebachttps://gitlab.gnome.org/GNOME/gnome-boxes/-/merge_requests/379
13Boxeshttps://gitlab.gnome.org/GNOME/gnome-boxes/-/issues/611Update help docs for GNOME 3.3803/10/2003/10/20https://gitlab.gnome.org/GNOME/gnome-boxes/-/commit/ca9aa0f710571d94cbad98b13e98d40f8e5213c7https://gitlab.gnome.org/GNOME/gnome-boxes/-/merge_requests/381
14Boxeshttps://gitlab.gnome.org/GNOME/gnome-boxes/-/issues/611Update help docs for GNOME 3.3804/10/2004/10/20https://gitlab.gnome.org/GNOME/gnome-boxes/-/commit/85d7b858f1c16e3a57dd880014d8a2f96525e104https://gitlab.gnome.org/GNOME/gnome-boxes/-/merge_requests/382
15Calculatorhttps://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185Update help docs for 3.3806/10/2006/10/20https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/3c05008cffb4a0cf6b4465795111f77713435921https://gitlab.gnome.org/GNOME/gnome-calculator/-/merge_requests/54
16Calculatorhttps://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185Update help docs for 3.3812/10/2012/10/20https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/7d45f8780ca1ef00e93605e756894b82c10905d0https://gitlab.gnome.org/GNOME/gnome-calculator/-/merge_requests/54
17Calculatorhttps://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185Update help docs for 3.3812/10/2012/10/20https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/e8459f5b490f6e920cca8a89bf98e3366b3632fchttps://gitlab.gnome.org/GNOME/gnome-calculator/-/merge_requests/54
18Calculatorhttps://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185Update help docs for 3.3812/10/2012/10/20https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/6175b699a78d9f75eebcff49239597379e49330chttps://gitlab.gnome.org/GNOME/gnome-calculator/-/merge_requests/55
19Calculatorhttps://gitlab.gnome.org/GNOME/gnome-calculator/-/issues/185Update help docs for 3.3829/10/2010/11/20https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/81a050a7fb581fa6f4bb859be41eaff1697fd793https://gitlab.gnome.org/GNOME/gnome-calculator/-/commit/0489e807e8b1781c781bdc3aeadbeff0cf699d64https://gitlab.gnome.org/GNOME/gnome-calculator/-/merge_requests/67
20Contactshttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84Update help docs for 3.3831/10/2031/10/20https://gitlab.gnome.org/GNOME/gnome-user-docs/-/commit/9ca74650e28047c9569017c76b4c8080e82a7b1chttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/merge_requests/81
21Contactshttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84Update help docs for 3.3802/11/2002/11/20https://gitlab.gnome.org/GNOME/gnome-user-docs/-/commit/8e8f613f7dcbabad43c150d6c78722ac148f3967https://gitlab.gnome.org/GNOME/gnome-user-docs/-/merge_requests/82
22Contactshttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84Update help docs for 3.3802/11/2002/11/20https://gitlab.gnome.org/GNOME/gnome-user-docs/-/commit/cefad457401016eb8cea6437dcd14188df7b9ee6https://gitlab.gnome.org/GNOME/gnome-user-docs/-/merge_requests/83
23Contactshttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84Update help docs for 3.3802/11/2002/11/20https://gitlab.gnome.org/GNOME/gnome-user-docs/-/commit/71ec9adcb64b85aeb73fba0ba69460b2c5f58812https://gitlab.gnome.org/GNOME/gnome-user-docs/-/merge_requests/84
24Contactshttps://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/84Update help docs for 3.3802/11/2002/11/20https://gitlab.gnome.org/GNOME/gnome-user-docs/-/commit/1e3d1241bc2e23d14bb0848b3e255d405c425d60https://gitlab.gnome.org/GNOME/gnome-user-docs/-/merge_requests/85

Summary of the current state of the project

Currently, core projects like Boxes, Calculator and Contacts have been updated to GNOME 3.38 which was the target version of GNOME for the scope of GSoD. While most of the Merge Requests have been merged, some are still under review.

Along with that I am going to continue my work on updating documents for GNOME and my next task is updating Evince.

Challenges:

  • The very first challenge was Applying for GSoD, choosing the project and preparing the proposal.
  • Learning Open Source project workflows and Technical Writing tools
  • Finding potential issues and working with developers to make sure that the App Help Documentation is complete, easy to access and easy to understand.
  • Understanding the existing documentation and creating new documentation from scratch.

Key Learnings:

  • Finding issues in existing documentation and creating Issues on Upstream of GitLab so others also can work on it and I will summarize my work under one issue.
  • How open source communities collaborate with each other remotely using communication Channels like IRC, BluJeans, Manage work through Version Control systems like GitLab which allows software projects to keep track of all versions and revert to previous versions if necessary.
  • Working as a technical writer for GNOME helped me to learn Technical writing tools like Mallard along with that I got to test applications like Boxes, Contacts and Calculator in detail, it also had a chance to Install Fedora 32 and 33 on my system which was a great learning experience.
  • With GSoD I not only learned Technical writing but also learned blog writing skills too. 

Plans after GSoD

GNOME User documentation for Core projects are up-to-date but there are other tasks which needs to be completed and I would love to continue my work with GNOME after GSoD as well along with that as I like what I am doing under GNOME and I noticed my university is not much involved with Open Source that much and students in my class were have very little understanding of Open Source I decided to continue my work with GNOME and take that as my final year project so I can write a paper about Open Source details from my experience. Which provided me with a chance to continue what I love to do in open source alongside my university while sharing my knowledge with others.

2 thoughts on “GSoD Project Report

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

Create your website with WordPress.com
Get started
%d bloggers like this: