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 701881 - [help] Port documentation to mallard
[help] Port documentation to mallard
Status: RESOLVED WONTFIX
Product: nemiver
Classification: Other
Component: general
0.9.x
Other Linux
: Normal enhancement
: ---
Assigned To: Nemiver maintainers
Nemiver maintainers
gnome[unmaintained]
Depends on:
Blocks:
 
 
Reported: 2013-06-08 22:49 UTC by Baptiste Mille-Mathias
Modified: 2020-03-10 11:56 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Baptiste Mille-Mathias 2013-06-08 22:49:00 UTC
I'm working to port documentation to mallard format, and refactor the way the documentation is presented.

As first iteration I'm trying to have something similar than the current help.

My branch is available at https://github.com/bmillemathias/nemiver/ and the branch is called "mallard-docs", if someone want to look at it.
Comment 1 Dodji Seketeli 2013-06-22 17:12:52 UTC
Thank you for undertaking this!  It's very appreciated.

I see that you are not only moving the format to Mallard, but also
enhancing the content of the documentation itself.  This is much
needed.  When you feel you are ready, please do not hesitate to sent
patches to nemiver-list@gnome.org for review an inclusion.

I am thinking maybe you could start send patches to just do the
conversion to mallard.  Then when they are committed, send patches to
improve the content, progressively?

What do you think?
Comment 2 Baptiste Mille-Mathias 2013-06-26 17:08:33 UTC
(In reply to comment #1)

> I see that you are not only moving the format to Mallard, but also
> enhancing the content of the documentation itself.  This is much
> needed. 

Actually my first intention was just to port the documentation to Mallard, but due to licensing issue (that I don't get that much) I couldn't use the verbatim wording, so I started from scratch.

> When you feel you are ready, please do not hesitate to sent
> patches to nemiver-list@gnome.org for review an inclusion.
> 

Okay, I'm doing when I'm in idle mode, so it's likely it'll take months to complete.

> I am thinking maybe you could start send patches to just do the
> conversion to mallard.  Then when they are committed, send patches to
> improve the content, progressively?
> 
> What do you think?

Yep, that would be great, and Mallard fits that way of working perfectly well, as each section can be a page that you link to the guide above, but I would like to reach a milestone where the documentation is almost equal than the previous one.
Comment 3 Baptiste Mille-Mathias 2013-08-27 06:41:02 UTC
The documentation is done, and located in the branch mallard-docs on GNOME git, so anyone can review it.
Comment 4 Baptiste Mille-Mathias 2013-12-22 20:21:54 UTC
Hey Dodji,

any news of that ?

Regards
Comment 5 André Klapper 2020-03-10 11:56:34 UTC
Closing all open Nemiver tasks as this project does not seem to be maintained anymore. Please see https://gitlab.gnome.org/Infrastructure/Infrastructure/issues/235#note_732192 for further information. Thanks!