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 618343 - gnomine: Convert documentation to Mallard format
gnomine: Convert documentation to Mallard format
Status: RESOLVED FIXED
Product: gnome-mines
Classification: Applications
Component: general
git master
Other Linux
: Normal enhancement
: ---
Assigned To: gnome-mines-maint
gnome-mines-maint
Depends on:
Blocks:
 
 
Reported: 2010-05-11 07:51 UTC by Robert Ancell
Modified: 2013-04-21 10:35 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
My initial effort on Mallard help for Gnomine (26.70 KB, patch)
2011-12-15 06:42 UTC, Sophia Yu
rejected Details | Review
Added <desc> elements and corrected a few sentences in faces.page (5.71 KB, patch)
2013-01-03 13:09 UTC, Aruna Sankaranarayanan
reviewed Details | Review

Description Robert Ancell 2010-05-11 07:51:23 UTC
Convert documentation to Mallard format
Comment 1 Tiffany Antopolski 2011-11-14 18:18:22 UTC
marking gnome-love
Comment 2 Baptiste Mille-Mathias 2011-12-08 14:22:02 UTC
I plan to work on that, nonetheless I'd accept help and direction to complete the work.
Comment 3 Sophia Yu 2011-12-15 06:42:43 UTC
Created attachment 203550 [details] [review]
My initial effort on Mallard help for Gnomine
Comment 4 Sophia Yu 2011-12-15 06:46:10 UTC
Please check my patch. As a GNOME intern I would like to contribute to Gnome Games all around.
Comment 5 Jason Clinton 2011-12-16 19:39:01 UTC
Looks good to me.

Do you have your git account now? If not, I can commit for you.

Have you looked in to how to disable build of old documentation and also how to coordinate with documentation team? I'm not sure what documentation team prefers for their transition.
Comment 6 Sophia Yu 2011-12-16 20:47:45 UTC
I don't have a git account so I need your help to commit this patch. 

I haven't had a chance to see how to use the new Mallard help. After this commit I will see. I think Tiffany is a good choice to talk to, since she is very active in documentation project.
Comment 7 Tiffany Antopolski 2011-12-17 13:37:46 UTC
I am just co-ordinating this work.  I will shortly review the patch, and send feedback.
Comment 8 Tiffany Antopolski 2011-12-18 04:02:49 UTC
Review of attachment 203550 [details] [review]:

The patch needs a topic-based approach, which requires a redesign from the original concept presented here.
Comment 9 Tiffany Antopolski 2011-12-31 18:48:01 UTC
New screenshots have been provided: https://bugzilla.gnome.org/show_bug.cgi?id=667065
Comment 10 Baptiste Mille-Mathias 2012-02-20 20:24:53 UTC
Hi Tiffany,

I've pushed some update to master, if you can review it that would be awesome.

--
Baptiste
Comment 11 Tiffany Antopolski 2012-02-21 13:10:39 UTC
Thanks!  Just had a quick look.  I think flags.page does not match the description of the most up to date gnomine version.  There are no preferences, and I can't see any way to enable these blue flags.  They are not enabled by default, but I don't see a way to invoke them.  I'll ask about this on #gnome-games.
Comment 12 Robert Ancell 2012-02-21 22:27:09 UTC
Whoops, the preferences menu item was accidentally removed in the port to GMenu.  I've added it back now.
Comment 13 Aruna Sankaranarayanan 2013-01-03 13:09:33 UTC
Created attachment 232633 [details] [review]
Added <desc> elements and corrected a few sentences in faces.page
Comment 14 Kat 2013-04-08 22:37:51 UTC
Comment on attachment 232633 [details] [review]
Added <desc> elements and corrected a few sentences in faces.page

Given that none of the pages currently have descriptions and all of the titles are relatively self explanatory as this is a simple game, I would prefer to see them left this way.

If you really think that they should have descriptions, please add them to all of the pages and tell us why you think they are needed :)
Comment 15 Aruna Sankaranarayanan 2013-04-13 15:16:49 UTC
Removed <desc> elements.

Pushed to master: https://git.gnome.org/browse/gnome-mines/commit/?id=02bd3fa1674ed8361094824dcd3c55c7facdeb5a

Looks like I forgot to add <credit type="editor">. :|
Comment 16 Kat 2013-04-17 22:02:46 UTC
The help has been ported, closing bug. For specific problems with the new help, please file a new bug.