OpenSolaris

Discussions Communities Projects Download Source Browser

Home » OpenSolaris Forums » documentation » discuss

Thread: wiki docs collaboration area

Welcome, Guest Help
Login Login
Guest Settings Guest Settings
Reply to this Thread Reply to this Thread Search Forum Search Forum Back to Thread List Back to Thread List

Permlink Replies: 1 - Last Post: Nov 13, 2009 12:42 PM by: alanm Threads: [ Previous | Next ]
alanm

Posts: 307
From: US

Registered: 5/1/08
wiki docs collaboration area
Posted: Nov 6, 2009 10:35 AM
To: Communities » documentation » discuss
  Click to reply to this thread Reply

Now that the docs community is running on a wiki, I would like to set up a collaboration area similar to the how tos and guides pages that have been hosted by the fine folks on the genunix site (e.g., http://wiki.genunix.org/wiki/index.php/HOWTOs_and_Guides).

I'm thinking generally that we'll want pages for the following:

* Wish list...a page where users can list things they want documentation help with.

* Dev list...a page that shows what folks are working on and status (so that don't have collisions with people duplicating effort).

* Templates...a page that provides basic elements of the kind of docs we want help with. For example, for a how to procedure, we can lay out an outline of required and optional elements that would make these consistent one to another (which ultimately makes it easier for users coming to the site for help).

* "How to" aggregation/toc" page....a page that lists the procedures that have actually been written. (I need to prove to myself we can do this, but I'm hoping we can use labels and automate the collection of these links on a single page.)

Would appreciate any inputs on this effort. I'll start assembling some of these pages as time allows.

-alan

alanm

Posts: 307
From: US

Registered: 5/1/08
Re: wiki docs collaboration area
Posted: Nov 13, 2009 12:42 PM   in response to: alanm
To: Communities » documentation » discuss
  Click to reply to this thread Reply

So, I've been able to get started on some of this work. I've made the most progress on a "How To" template that I think can serve as a starting place for any procedural documentation. Please take a look and let me know if any inputs:

http://hub.opensolaris.org/bin/view/Community+Group+documentation/How+To+Template

Note, there are some issues with the current xwiki implementation that is preventing the macros from displaying correctly. To see how the macros should look, you can use the following URL (which adds a reference to a style sheet that is under developement):

http://hub.opensolaris.org/bin/view/Community+Group+documentation/How+To+Template?skin=toucan

I'll post links to other pages when they're ready.

-alan




Terms of Use | Privacy | Trademarks | Copyright Policy | Site Guidelines
Your use of this web site or any of its content or software indicates your agreement to be bound by these Terms of Use.
Copyright © 1995-2005 Sun Microsystems, Inc.