Re: Moving the handbooks to the wiki
Joseph Jezak <[email protected]> Sat, 13 Dec 2014 12:32:04 -0500
| Newsgroups | gmane.linux.gentoo.documentation |
|---|---|
| Message-ID | <[email protected]> |
On 12/12/2014 09:53 AM, Sven Vermeulen wrote: > On Wed, Dec 10, 2014 at 02:40:06PM +0000, Sven Vermeulen wrote: >> 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. > Hi all > > The move, content-wise, is finished. The entry point for all handbooks > (where each individual architecture handbook is linked at) is at > https://wiki.gentoo.org/wiki/Handbook:Main_Page > > All architectural handbooks have been moved to the Gentoo Wiki (except for > ARM as it was already marked as not up-to-date anymore). I did a quick > cross-check that there are no wrong blocks being included in the wrong > architecture, so things should work out fine. > > I also updated the book.dtd file so that in a few hours (days if people > start objecting) I can start updating the current handbooks to redirect to > the wiki, as well as update the site links to the handbook to point to the > wiki ones. > > I will also mail the gentoo-project mailinglist with information so people > are aware of the coming change. > > Wkr, > Sven Vermeulen > > Hey Sven, awesome work, it really looks great on the wiki! One problem that I'm seeing is that it seems that some combination of characters seem to be getting converted into other characters, like fi, ff, etc. I don't mind editing them for the PPC handbook, but I was wondering if that was something you had caught and were fixing already. Also, when would it be okay to update documentation again? I've got a bunch of PPC fixes that I hadn't had a chance to update, the wiki changeover seems like a good opportunity to brush everything up. Thanks again for your work, this will make our docs better! -Joe