Hi all,

I've read through some of the proposals for collaboration and I think its 
awesome how much energy and interest we have in this community, so I want to 
enable it to be unleashed and get some great projects going around docs for new 
technologies that are appearing in OpenSolaris. [insert pompoms here]

I know some folks want Solbook, but it requires an expensive editor (Epic) and 
part of the goal is to keep barriers to entry low as possible. We use a command 
to publish our SGML source as XML for docs.sun.com--I don't know much more than 
that, because I don't have to.  The output is a single .book file with size 
about 500K for a 200 pg book. So, we could potentially open source the .book 
file for the doc community in order to do collaborative work. Community members 
could use any editor they choose and use the DocBook DTD to check validity. 
Thoughts?

For the publishing of the .book files, HTML is the most reasonable output I can 
figure. We could just link in a style sheet or get a bit more sophisticated 
with an XSLT script to transform to HTML. Thoughts?

We could provide Solbook templates for doc community use and publish new 
documents in HTML on the doc community pages. Use of the templates, when we get 
them created,  would not be required and we can accept any formats for *new 
documentation. [insert open invitation to send us stuff here] Thoughts?

For *existing documentation that is published on docs.sun.com, we have more 
process steps:
1-formal request for a sponsor, sent to request-sponsor at opensolaris.org (I 
now see that we don't outline how to complete this step on our How To 
Participate page, so I will add that tomorrow).
2-signed, returned Sun Contributor Agreement
3-adherance to the published style guidelines, term guidelines, and DocBook 
rules
4-participation in technical and editorial reviews
5-TBD for the unforseen :)

This strawman outline of a plan gets us a way to collaborate on existing docs 
(XML) or create new docs using SGML/other format and publish with HTML. There 
are still several issues that need to be overcome (source control, linking, 
workspace locations and management), but I wanted to post this outline in 
response to the 'most viewed' docs-discuss thread, since I haven't responded 
yet, but I am starting to get a vision of how we can all work together. 

Let me know what you think, if there are requirements I've missed or other 
things we'll need.

Thanks,
Michelle
OpenSolaris Doc Community
This message posted from opensolaris.org

Reply via email to