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 580246 - Add edit option like monodoc
Add edit option like monodoc
Product: devhelp
Classification: Applications
Component: General
git master
Other All
: Normal enhancement
: ---
Assigned To: devhelp-maint
Depends on:
Reported: 2009-04-26 01:07 UTC by Javier Jardón (IRC: jjardon)
Modified: 2019-12-23 17:40 UTC
See Also:
GNOME target: ---
GNOME version: Unversioned Enhancement

Description Javier Jardón (IRC: jjardon) 2009-04-26 01:07:56 UTC
In monodoc you can do corrections in the documentation api and send it upstream. This should be a killer feature for devhelp

Also, I think it would improve the gtk/gnome documentation a lot
Comment 1 Christian Kirbach 2009-04-26 01:24:09 UTC
Can you elaborate a bit more on how the workflow is for sending corrections? 
Comment 2 Javier Jardón (IRC: jjardon) 2009-04-26 01:27:57 UTC
You can see how works in monodoc here: and here:
Comment 3 Javier Jardón (IRC: jjardon) 2009-05-06 17:21:03 UTC
Here a explanation of how works MonoDoc (the equivalent of devhelp for mono):

The MonoDoc Documentation Browser ("MonoDoc") provides access to API documentation and code samples. The documentation browser uses wiki-style content management, allowing developers to edit and improve the documentation.

The procedure is easy, browse to the part of the documentation you want to contribute and click on the [Edit] link to start writing the documentation. You can also look for the parts that are listed as To be added or as Documentation for this section has not yet been entered. 

If you are not happy with a contribution, you can delete it using the Restore button when editing it.

Once you are done, you can submit your contributions directly from the MonoDoc Documentation Browser. Use the menu File --> Contributions --> Upload contributions. If you had never contributed before, you will have to register in mono servers. The process can be performed inside the program. You will recieve an email with a password the program will remember once you enter it. All the process lasts only a couple of minutes.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2009-05-30 18:04:54 UTC
I've been thinking about this on gtk-doc level.

The main problem I see is the merging workflow. People make changes. This results in a patch. Now two questions:

1) What documentation do we show in e.g. / devhelp? The edited documentation (which has not yet been verified?). This is less of a problem in devhelp (as its local).

2) What do we do with the patch? 
a) Submit do bugzilla (this needs a special permission for devhelp/lgo to submit tickets),
b) Apply to a doc-fixes branch in git (this needs permission in the git repo and is vcs specific).

Imho the editing part is not so difficult. But I'd like to know how to close the loop before even starting such a project.
Comment 5 Javier Jardón (IRC: jjardon) 2009-06-13 16:46:40 UTC
There are some related work here:

and here
Comment 6 Sébastien Wilmet 2018-01-21 17:26:42 UTC
I would argue that this is implementable in JavaScript, so all of what Devhelp needs to do is to show the HTML page. Problem solved :-) (for Devhelp).
Comment 7 Sébastien Wilmet 2019-12-23 17:40:33 UTC
Out of scope.