After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 647085 - Provide user documentation for gitg
Provide user documentation for gitg
Status: RESOLVED OBSOLETE
Product: gitg
Classification: Applications
Component: gitg
0.2.x
Other Linux
: Normal enhancement
: ---
Assigned To: gitg-maint
gitg-maint
Depends on:
Blocks:
 
 
Reported: 2011-04-07 19:22 UTC by Adam Dingle
Modified: 2018-05-22 13:05 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Adam Dingle 2011-04-07 19:22:30 UTC 
As far as I can tell gitg has no documentation anywhere.  It's not immediately obvious how to use all of its features and preferences, and some features are also a little hard to discover (e.g. drag and drop).  So there should be documentation explaining how it all works from a user standpoint.
Comment 1 Guilhèm Bonnefille 2011-04-11 06:58:29 UTC 
I started to add a user manual against the v0.0.3. But this work was never merged nor completed.

Interested people can use my work:
https://github.com/guyou/gitg/tree/doc
Comment 2 Ignacio Casal Quinteiro (nacho) 2011-07-23 10:25:33 UTC 
Nice, although I'd rather have a mallard documentation.
Comment 3 Sindhu S 2013-04-12 18:08:28 UTC 
I could start working on this. I have previously written Terminal and Dictionary help pages using Mallard. If yes, is it OK for me to create a new branch on gitg repository?
Comment 4 Sindhu S 2013-04-13 13:32:18 UTC 
Hi! I have started working on the documentation. You can take a look at the first few pages I have written here:

HTML version: http://sindhus.bitbucket.org/docs/gitg/index.html
Repository: https://bitbucket.org/sindhus/gitg/commits/all
Comment 5 André Klapper 2014-01-25 21:45:00 UTC 
URL is now: https://github.com/sindhus/gitg/commits/wip/sindhus/interactive-rebase
Comment 6 Sindhu S 2014-01-26 07:03:41 UTC 
No no(In reply to comment #5)
> URL is now:
> https://github.com/sindhus/gitg/commits/wip/sindhus/interactive-rebase

That link is for my gsoc work! 
Like you commented yesterday indeed the gitg repo doesn't exist on bitbucket. I had a few pages of help written but now I have lost that work and more importantly, since UI has changed heavily it wouldn't hold good. I will start working on the mallard help if I get a go-ahead from any of the devs of the project as it initially a low priority task. 

I understand that now that gitg has been released, we can start on the user docs.
Comment 7 jessevdk@gmail.com 2015-08-09 16:58:10 UTC 
Has there been any progress on this?
Comment 8 vedicpartap 2017-05-15 17:09:09 UTC 
has there any progress on this ?
Comment 9 GNOME Infrastructure Team 2018-05-22 13:05:04 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gitg/issues/11.