Karanbir Singh
2007-Mar-17 11:08 UTC
[CentOS-docs] guidelines for version specific info on wiki pages
hi Guys, Just wondering if we should have some guidelines as to how version specific information should be handled on the wiki ? One way might be to have a version tag on each page on the top right and indicate what Versions that page is going to work with. Then in the body have a Grey bar to indicate version specific info. But this might get a bit messy. Any other ideas ? - KB -- Karanbir Singh : http://www.karan.org/ : 2522219 at icq
Ralph Angenendt
2007-Mar-17 11:55 UTC
[CentOS-docs] guidelines for version specific info on wiki pages
Karanbir Singh wrote:> hi Guys, > > Just wondering if we should have some guidelines as to how version > specific information should be handled on the wiki ? > > One way might be to have a version tag on each page on the top right and > indicate what Versions that page is going to work with. Then in the body > have a Grey bar to indicate version specific info. But this might get a > bit messy.If it is a larger text (like a HowTo) which is specific to a version, then mention it in the title. If it is something in the tips and tricks section and you have solutions for more than one version, make headlines for it: === Foo on CentOS 5 ===== Foo on CentOS 4 == Just my 2 cents, Ralph -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: application/pgp-signature Size: 189 bytes Desc: not available URL: <http://lists.centos.org/pipermail/centos-docs/attachments/20070317/f9ac0423/attachment-0002.sig>
Karanbir Singh
2007-Mar-17 12:00 UTC
[CentOS-docs] guidelines for version specific info on wiki pages
Ralph Angenendt wrote:> If it is a larger text (like a HowTo) which is specific to a version, > then mention it in the title. If it is something in the tips and tricks > section and you have solutions for more than one version, make headlines > for it: > > === Foo on CentOS 5 ==> === Foo on CentOS 4 ==>i think it might start getting a bit fuzzy when its a longish howto and bits of code need to be mentioned in various parts of the howto. so we'd need some easy way for people to tell what works where. Not sure how other wiki's handle the same issue. -- Karanbir Singh : http://www.karan.org/ : 2522219 at icq
Daniel de Kok
2007-Mar-17 12:11 UTC
[CentOS-docs] guidelines for version specific info on wiki pages
On Sat, 17 Mar 2007 12:55:36 +0100 Ralph Angenendt <ra+centos at br-online.de> wrote:> If it is a larger text (like a HowTo) which is specific to a version, > then mention it in the title. If it is something in the tips and > tricks section and you have solutions for more than one version, make > headlines for it: > > === Foo on CentOS 5 ==> === Foo on CentOS 4 ==Hmmm. If it is a longer HOWTO with just small version-specific snippets, I agree with Karanbir that it would be nice to have some indication at the top of the page. I user could instantly see that a HOWTO contains instructions for, say CentOS 3 and 4, but not for 5. How about making a comment marker (like ACLs) that contains this version information, and letting MoinMoin expand it to some visual marker at the top of the page. That would allow us to tinker with the appearance in the future without having to change all pages. (Yeah, I like metadata :p.) -- Daniel