Re: Moving the handbooks to the wiki
Sven Vermeulen <[email protected]> Wed, 10 Dec 2014 14:40:06 +0000
| Newsgroups | gmane.linux.gentoo.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Mon, Dec 08, 2014 at 10:43:55AM +0000, Sven Vermeulen wrote: > Just a heads-up for everybody - more information will follow of course. > > I have started copying the Gentoo handbooks to the Gentoo Wiki. Through > transclusion and semantic wiki, which is supported on Gentoo Wiki, we are > able to do similar reuse of blocks for the architectures. > > Given the low resources we are currently having, I think the move to the > wiki will help us with keeping the instructions up to date. > > For now, please do not touch anything in the "Handbook:" namespace of the > wiki as I'm going through the effort of migrating it. > > Information on translations and so on will follow. An update on this mini-project. I've made a page [1] on our project wiki space about the handbook development on the Wiki. It covers - how the architecture consolidation is done (the alternative of the GuideXML "include" elements to tie architecture-specific and architecture-agnostic information together) - how the parameters (the //value/key stuff in our main handbook XMLs) are used on the wiki - pointers about translating the handbook on the wiki [1] https://wiki.gentoo.org/wiki/Project:Documentation/HandbookDevelopment I have also copied the AMD64 handbook [2] (the one I have the most affinity with) already to the wiki to see how things work out. For now, everything is still marked with "Work in Progress". I am only going to remove that the moment that the XML files have been updated to point to the Wiki so that users are "less confused" about what handbook is now the active one. [2] https://wiki.gentoo.org/wiki/Handbook:AMD64 Comments are always welcome. During the copy, I do notice that there is some outdated information in the non-installation part of the handbook (perhaps also in the installation part, but that I can't tell for sure). I am *not* planning on fixing this before the wiki handbook goes live, although I do plan to update the handbook on the wiki afterwards. Yes, that also means that the bugs that are currently reported against the handbook will need to wait until the wiki move is done - I rather focus on one thing at a time. And I think that the move to the wiki will also help us in the sense that developers can then update the instructions themselves rather than having to go through bugzilla to reach us/me. Efficiency++ Larger changes will of course be communicated and suggested up front on this mailinglist. Wkr, Sven Vermeulen