Michelle Olson wrote: > I've drafted a list of procedures and steps below to help new and existing > community members understand how to collaborate on documentation for > OpenSolaris. This could be added to the How To Participate page, or could be > separate page or doc.
Seems like this should be in the How To Participate page, not buried off somewhere else. This is good stuff, please don't hide it. > This is a work in progress (and it presumes that a Review page exists--I > think we could use one, what do you think?) I'm sure I haven't covered > everything, but this a start at least. Everything's a work in progress until it becomes obsolete. :) > Instructions for Open Information Development > ------------------------------------------------------------------- > > The purpose of this document is to describe the instructions for > collaborative > documentation development in the OpenSolaris project. Not needed if you put it on the How To Contribute page itself. > Collaborative Documentation Development Tasks > ------------------------------------------------------------------- > > Write a new document > Request to view a document > Request a change to a document > Send review feedback for a document > Send URL for a requested or new document > Respond to a documentation change request > Communicate changes and contributions to a document > License the source for a document > Add text to an existing document > File and fix a documentation bug or RFE > Post a document > Post source for a document > Submit a patch to an open source document > Introduce yourself Each one of these hyperlinked to an anchor tag below, I assume [snip] > 2-Request to view a document: Send email to docs-discuss at opensolaris.org Huh? I'm confused by this one. If I wanted to view a document wouldn't I just open it in my browser? ;) > 3-Request a change to a document: File a doc bug at > http://bugs.opensolaris.org and specify Doc as the subcategory. "to a document" --> "to an existing document" [snip] > 7-Communicate changes and contributions: Post changed documents to > docs-discuss at opensolaris.org and cc: the bug submitter or contributor with > a brief description of the change and under what heading it appears in the > updated review copy. Feel free to also provide any addtional review details > that might be appropriate. Until docs has a SCM repository folks are also welcome to submit a request to have their document posted on an existing or new muskoka project page unless they already have a place to hang it elsewhere. [snip] > 12-Post the source for a document: Source that is published in the Doc > Consolidation must adhere to the Documentation Style Guide for OpenSolaris > and the terminology guidelines provided in the Sun Global Glossary. The > source must also be licensed according to appropriate guidelines outlined at > http://opensolaris.org/os/community/documentation/license and be provided in > an acceptable format for collaboration (currently DocBook5 XML for manuals, > TBD for man pages). Other source files may be uploaded to the /tmp directory > on the docs community site, just request a leader to do so by sending mail to > docs-discuss at opensolaris.org. Interesting, this goes back to "is it a style guide for documentation or a documentation standard for OpenSolaris" argument again.. but this is the wrong thread. :) Looks good overall, this will be a nice addition to the community pages. It seems like you hit on all the salient points; I can't think of anything you have omitted, but hopefully other folks will also think about what might be missing. Cheers - Eric
