-------- Original Message --------
Subject: [Fwd: [osol-announce] SMF Documentation project now open]
Date: Thu, 12 Apr 2007 14:06:08 -0700
From: Susan Weber <[email protected]>
To: Susan Weber <Susan.Weber at Sun.COM>
Liane Praza just announced a doc project for SMF.
I'm pleased to announce the opening of the SMF Documentation
project. http://opensolaris.org/os/project/smf-doc This project will
serve as a location for collaboration on current and future SMF
documentation. The first document available for comment and
collaboration is a very early draft of an SMF Developer Guide,
targeted for eventual distribution on docs.sun.com. Mailing list
discussion will occur on smf-discuss at opensolaris.org. liane -- Liane
Praza, Solaris Kernel Development liane.praza at sun.com -
http://blogs.sun.com/lianep
I like the README file that Liane posted with her book. See
http://opensolaris.org/os/project/smf-doc/smf-dev/README, and below.
The categories of information in this ReadMe might be useful with other
OpenSolaris/open source documentation:
0. License
1. Required Software
2. Building
3. Building behind a proxy
4. Contributing
It could be more generalized--
0. License
1. Documentation Format/Standard
2. Recommended Documentation Tools
2.1 Required Documentation Tools
3. Documentation Instructions
3.1. Special instructions
4. Contributing
I don't have the words well-crafted, but I hope you get the idea.
Helpful? I like the way Liane set up the project-- it's very simple.
Should it be sponsored(or co-sponsored) by the documentation community?
It looks like it is a child of SMF?
-Sue
Copyright 2007 Sun Microsystems, Inc. All rights reserved.
Use is subject to license terms.
0. License
The original documentation content included here is licensed under
the Public Documentation License. The PDL text is included as pdl.txt.
1. Required Software
To build this book, you'll need:
- Apache's FOP (0.93)
The binary distribution works on recent OpenSolaris bits.
http://xmlgraphics.apache.org/fop/
- docbook-xsl (1.72.0)
http://sourceforge.net/projects/docbook
- make, xsltproc, and xmllint in your default path.
By default, the Makefile assumes this software is available in /opt/DocBook.
2. Building
Type "make". Explicit targets are available for pdf, html, and
text output. The text output is ugly currently, so isn't built
by default. "make clean" will clean up generated files.
The build is not warning-free right now, but seems to produce
working PDF and HTML.
3. Building behind a proxy
Extra warnings appear when docbook.sourceforge.net is unreachable.
Unfortunately, fop doesn't appear to honor standard proxy directives.
You can modify the fop script directly to have it work through a
web proxy.
Insert the following line (modified with your proxy host and port)
before fop_exec_command in the fop script you installed:
PROXY="-DproxySet=true -DproxyHost=myproxy -DproxyPort=8080"
Modify the fop_exec_command line and insert "$PROXY" before the
"$LOGCHOICE".
4. Contributing
We welcome contributions to this document!
You'll need to sign a standard OpenSolaris contributor agreement
first. Next, send a your contributor agreement # and a pointer to
your changes to smf-discuss at opensolaris.org with a request for
review. After review by the community is complete, one of the
smf-doc project leaders will contact you with putback instructions.
Please realize that some contributors to this document use plain
text editors to edit the XML. If you use an XML editor, please
make sure that the files you're putting back are legible with a
plain text editor.
-------- Original Message --------
Subject: [osol-announce] SMF Documentation project now open
Date: Thu, 12 Apr 2007 10:46:36 -0700
From: Liane Praza <[email protected]>
To: opensolaris-announce at opensolaris.org
I'm pleased to announce the opening of the SMF Documentation project.
http://opensolaris.org/os/project/smf-doc
This project will serve as a location for collaboration on current and
future SMF documentation. The first document available for comment
and collaboration is a very early draft of an SMF Developer Guide,
targeted for eventual distribution on docs.sun.com.
Mailing list discussion will occur on smf-discuss at opensolaris.org.
liane
--
Liane Praza, Solaris Kernel Development
liane.praza at sun.com - http://blogs.sun.com/lianep
_______________________________________________
opensolaris-announce mailing list
opensolaris-announce at opensolaris.org
http://mail.opensolaris.org/mailman/listinfo/opensolaris-announce
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
<http://mail.opensolaris.org/pipermail/docs-discuss/attachments/20070412/8a0d3096/attachment.html>
