GNOME Bugzilla – Bug 335968
Fold gnome-desktop/desktop-docs/gnome-feedback into the User Guide
Last modified: 2013-02-23 11:23:03 UTC
The files in CVS under desktop-docs/gnome-feedback could be folded into the GNOME Desktop User Guide, and expanded into a more general section on contributing to GNOME and joining the project. If someone can take care of the technical side of things I'm happy to do the writing.
What's involved on the technical side? :-)
Um... I was hoping you'd know! :) I imagine... * making sure anything that links to this documentation goes to the new location * weird arcane CVS stuff * getting the translations moved too * other stuff I don't know about Also, would we want to do this for 2.14.1, or wait till we're working on 2.15? I'm trying to avoid having two branches of the User Guide as long as possible.
(In reply to comment #2) > Um... I was hoping you'd know! :) > I imagine... > * making sure anything that links to this documentation goes to the new > location Errr... The only things that link to this documentation is yelp (maybe) and other docs, I believe. > * weird arcane CVS stuff I can do this. > * getting the translations moved too Since the number of translations is low, it shouldn't be too hard. > * other stuff I don't know about > > Also, would we want to do this for 2.14.1, or wait till we're working on 2.15? > I'm trying to avoid having two branches of the User Guide as long as possible. I'd say it can wait for 2.15. But I'm not the one working on docs :-) And what about moving the GPL/LGPL/FDL too?
let's hold off on this until after the 2.14.1 release, since I'm going to basically apply everything that joachim is doing on HEAD to the gnome-2-14 branch before the 2.14.1 release. I really shouldn't have branched...
(In reply to comment #3) > And what about moving the GPL/LGPL/FDL too? > I think Shaun said something about those going into doc-utils. Not sure on the details though, best check with him.
I'm happy to work on this for 2.14.1 -- my only concern was the various freezes in place that might prevent it. Also, I wondered if the bug report tool links here?
This is a 2.15/2.16 thing. It's far too big of a change to put onto a stable branch.
Can we work on it now, and how do we go about it?
(In reply to comment #8) > Can we work on it now, and how do we go about it? Yes. I don't know :-) Shaun should know, I guess. Shaun?
I don't think we should even try moving stuff around in CVS. We should just add new pertinent information to the UG, and then kill gnome-feedback. There is no plan to move stand-alone license files to gnome-doc-utils. We could move these as-is over to gnome-user-docs though. I think that makes sense.
Ok. I've copied over all the material from gnome-desktop/desktop-docs/gnome-feedback/ to the user guide, expanding the appendix I put in for 2.14. It's now in a new file, gosfeedback.xml. I don't know what we're doing about the translations, so I've put comments to translators in the DocBook explaining that they can copy over existing translations from the old module. The new DocBook ids are: feedback-bugs -- Reporting bugs feedback-wishlist -- Suggestions and comments feedback-docs -- Documentation Comments Over to someone else to do the necessary linking and whatever :)
To put it more clearly, these are the changes to ids that need to be made throughout GNOME: ghelp:gnome-feedback -> ghelp:user-guide?feedback ghelp:gnome-feedback?index -> ghelp:user-guide?feedback ghelp:gnome-feedback?feedback-main -> ghelp:user-guide?feedback ghelp:gnome-feedback?bugreports -> ghelp:user-guide?feedback-bugs ghelp:gnome-feedback?wishlist -> ghelp:user-guide?feedback-wishlist ghelp:gnome-feedback?docs -> ghelp:user-guide?feedback-docs
Status update: I've notified the i18n and we're waiting now for translations to be moved. I spoke to Shaun in IRC and he mentioned the possibility of setting up a redirect in yelp -- basically, a hack, as it's unlikely we'll change all ids in time for 2.16 (and manuals for applications outside of GNOME may be linking to it too).
Shaun, you said something on IRC about putting a redirect in Yelp?
Now sounds like a good time to fix this for 2.18 :-)
I've done my bit. I've also been updating the links in user manuals that I come across. Shaun -- did you do the redirect? Has the translation team moved the translations? Someone needs to commit the patch for Bug 353087.
Don tells me this depends on bug 452323.
Brief overview of why this depends on bug 452323: In current yelps (<2.20), yelp uses gnome_program_locate to find the relevant ghelp: file. This basically takes the name and looks in <prefix>/share/gnome/help/ for it and returns the language-specific filename. In the new pager system, we depend on Rarian which works differently. It uses the meta-data filename to determine the ghelp name (i.e. feedback.document becomes ghelp:feedback) and the filename is extracted from there. This means in order to do the redirect, you only need to change the <filename> element in the omf (or whatever the correct element is). This is where it gets clever ;) Rarian, during scrollkeeper-update will take the feedback.omf and turn it into feedback.document and ensure it's picked up correctly by yelp. Of course, this depends on us getting our act together and getting the new pager system in place soon (to be in time for 2.20). Otherwise, we will need to hack in a special "if requestedname == feedback: redirect to wherever" part. But we will get the new pager system into 2.20, even if it involves us locking shaunm in a dungeon with only the source until it's done.
The master page <http://www.gnome.org/learn/admin-guide/2.14/> still says <ghelp:gnome-feedback>. It causes yelp to display a blank page with a message box "Incorrect URL parameter". dpkg -s 'gnome-user-guide' [[ Package: gnome-user-guide Version: 2.20.0+svn20071003ubuntu2 ]]
So what? This seems still problematic. BTW, what are the correct replacements for ghelp:[gpl|fdl] links? Should we set a gnome goal to replace the obsolete links everywhere?
So the broken link on the master page should be fixed. I do not know about 'everywhere'. As soon as this link is fixed and I find another one, I shall report that one as well.
OK, I've just corrected the links (rev 836) to GNOME Feedback Page in the "About this document" section of the 3 guides.
Oups... I still need to test the links in sysadmin-guide and accessibility-guide (as soon as I get home).
Links corrected in guides. The problem with ghelp:gpl (and co) not showing is a Ubuntu-specific bug, as we discussed it with Matthew and Vincent on #docs. Now we should still correct ghelp:gnome-feedback links in all other docs... unless Don is able to do a redirection before that!
No such folder "gnome-feedback" in http://git.gnome.org/browse/gnome-desktop/tree/desktop-docs , and blindly moving reports to different products and even setting a completely bogus version number (3.4) doesn't help. OBSOLETE.