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 723024 - Add help entry in global menu
Add help entry in global menu
Status: RESOLVED FIXED
Product: polari
Classification: Applications
Component: User docs
unspecified
Other All
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Maintainers of Gnome user documentation
winterdocs
Depends on:
Blocks:
 
 
Reported: 2014-01-26 15:16 UTC by Baptiste Mille-Mathias
Modified: 2016-09-24 14:02 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Add item for help in global menu (2.06 KB, patch)
2014-01-26 15:16 UTC, Baptiste Mille-Mathias
none Details | Review
Initialization of documentation (3.00 KB, patch)
2014-01-26 15:40 UTC, Baptiste Mille-Mathias
none Details | Review
help: Initialize the documentation infrastructure (4.25 KB, patch)
2016-05-06 16:44 UTC, Florian Müllner
committed Details | Review

Description Baptiste Mille-Mathias 2014-01-26 15:16:03 UTC
Starting to add the infrasture needed to have user documentation
Comment 1 Baptiste Mille-Mathias 2014-01-26 15:16:05 UTC
Created attachment 267234 [details] [review]
Add item for help in global menu
Comment 2 Baptiste Mille-Mathias 2014-01-26 15:40:15 UTC
Created attachment 267235 [details] [review]
Initialization of documentation

the real patch
Comment 3 Kat 2014-01-27 15:29:42 UTC
Review of attachment 267235 [details] [review]:

I think you need a licence file and an index.page in this commit as well.

I'll leave it up to the maintainer to decide if they want the help in now. In my experience, it's safe to let docs be written on master, but we can also write it in a branch.
Comment 4 Florian Müllner 2014-01-29 18:06:11 UTC
(In reply to comment #3)
> I'll leave it up to the maintainer to decide if they want the help in now.

I don't like the idea of having broken links in the UI for an indefinite amount of time, but if you (or anyone) plan(s) to actually fill in documentation in the near future, I'm perfectly fine with this work happening now and on master.

In general, I'll be happy with whatever works best for you as far as documentation is concerned. I can get you a 'documentation' component if that's of any help, or just go ahead and push :-)
Comment 5 Baptiste Mille-Mathias 2014-01-29 18:20:20 UTC
Hello,

The patch is not intended to be pushed right now and off course has to wait some content to be commited.

I can create a tracker for the user documentation and add that block this bug.
Comment 6 Florian Müllner 2014-01-29 18:23:52 UTC
(In reply to comment #5)
> The patch is not intended to be pushed right now and of course has to wait
> some content to be committed.

Well, if you know that there'll be content in a week or so, I wouldn't have a problem with just going ahead now. But up to you really :-)


> I can create a tracker for the user documentation and add that block this bug.

Dto.
Comment 7 André Klapper 2014-01-29 22:48:21 UTC
Refering to the potential introduction of a new string after the freeze, you could comment out the code and the string for the time being and check if it still gets picked up by the po files. ;)
Comment 8 Florian Müllner 2014-01-29 22:56:09 UTC
(In reply to comment #7)
> Refering to the potential introduction of a new string after the freeze

I'd say if the user documentation misses string freeze, the actual string "Help" is the least problem - the documentation itself would be a massive freeze break, no?
Comment 9 André Klapper 2014-01-30 09:16:13 UTC
User documentation has never been under a string freeze.
Comment 10 Florian Müllner 2016-05-06 16:44:02 UTC
Created attachment 327408 [details] [review]
help: Initialize the documentation infrastructure

Updated patch, taking into account Kat's feedback in comment #3.

Should we just push this now, or do you usually wait until you have some content first?
Comment 11 Kunaal Jain 2016-05-15 05:17:29 UTC
(In reply to Florian Müllner from comment #10)
> Created attachment 327408 [details] [review] [review]
> help: Initialize the documentation infrastructure
> 
> Updated patch, taking into account Kat's feedback in comment #3.
> 
> Should we just push this now, or do you usually wait until you have some
> content first?

I think waiting for some content makes sense..
Comment 12 Florian Müllner 2016-05-15 07:29:54 UTC
Maybe. But then, getting a stub into place may increase the likelihood of content to appear in the first place.
Comment 13 Kunaal Jain 2016-05-15 08:16:54 UTC
(In reply to Florian Müllner from comment #12)
> Maybe. But then, getting a stub into place may increase the likelihood of
> content to appear in the first place.

Perhaps having some very basic docs like index page content and then pushing it.
Comment 14 Florian Müllner 2016-05-26 12:41:16 UTC
Attachment 327408 [details] pushed as 24ff9b0 - help: Initialize the documentation infrastructure

(In reply to Kunaal Jain from comment #13)
> Perhaps having some very basic docs like index page content and then pushing
> it.

Let's try to get out of the chicken/egg situation where everybody is waiting for somebody else to do the first step. If we don't have anything in time for 3.22, we can simply comment out the entry in the app menu ...
Comment 15 roopa 2016-09-24 13:46:45 UTC
Is anybody working on this patch?
Comment 16 Florian Müllner 2016-09-24 14:02:15 UTC
This patch has been pushed a while ago, so no. If you want to follow the current documentation status, you should track bug 722498 instead.