Doc Reviews

Documentation Reviews

 This page provides the list of documents that are currently in review and links to the threads where review feedback is being posted.

• Proposed docs community website architecture
   Given the planned transition from the current opensolaris.org web app to xwiki, I'd like to clean up the docs community site, retiring or replacing old pages and out-of-date info, deferring to some community sites that have more current info, and re-organizing the site around what I think the goals of the community are. To that end, I've captured a proposed layout for the docs community website I'd like to implement ahead of the xwiki content migration. Please leave comments on this  docs-discuss thread. Thanks in advance.
•  Getting Started With 2009.06 OpenSolaris (review)
   Please leave comments on this  docs integration meeting thread about the review copy of the new Getting Started Guide. Remember that this doc is posted both as HTML to support the binary distribution and is re-formatted and printed/bound for distribution at various public events. The target user is someone new to OpenSolaris who want to install it and get a basic development system operational. We assume they want to:
  • Get some background on OpenSolaris
  • Experiment with the Live CD
  • Install OpenSolaris
  • Set up basic development / computing environment
  • Learn concepts about using OpenSolaris that are unique to it
     Note that This document has been overhauled from previous versions and largely adheres to the outline posted in this thread.
•  "Release" wiki content strategy
   Please leave comments on this  docs integration meeting thread regarding the attached strategy to snapshot wiki content and freeze it in support of specific OpenSolaris releases and the users of those releases. (Essentially, to support the opensolaris.com user.)
•  2009.06 Getting Started Guide / Chapter 1 for Live CD
   Please leave comments in this  thread regarding chapter 1 of the Getting Started Guide for 2009.06. This chapter is distributed on the Live CD. It is also the part of the larger Getting Started Guide document that is published via HTML on the download center and published in hard copy an distributed at various OpenSolaris public events.
• 2009.06 Getting Started Guide / Minibook outline
   Please leave comments in the thread on the provided link regarding the proposed outline for material to be included in the next Getting Started Guide, which is both an OpenSolaris HTML deliverable and a hardcopy minibook (typically a hand out at various technical events.)
•  System Administration Guide: Network Services, excerpts from the sendmail chapters
   To provide feedback on the content of this document, post a reply to this  thread. This is the first review of recent documentation changes, so any and all comments are welcomed and appreciated.
• System Administration Guide: Newboot SPARC, ZFS Boot (builds 89-91)
   To provide feedback on the content of this document, post a reply to this  thread. This is the first review of recent documentation changes, so any and all comments are welcomed and appreciated.
• Documentation Style Guide for OpenSolaris, Chapter 7, "Writing for an International Audience"
   To provide feedback on the content of this document, post a reply to this thread. This is the alpha review of updates to Chapter 7 of the document, so any and all comments are welcomed and appreciated.
• Introduction to Operating Systems: A Hands-On Approch Using the OpenSolaris Project
   To provide feedback on the content of this document, post a reply to this thread. This is the beta review of v2.2 of the document, so any and all comments on content, style, grammar, and formatting are welcomed and appreciated.
   To get a copy of the source files for the book from the repository, use the instructions here.
• Configuring SSL for Coolstack
   This is the alpha review of the document, so please post any and all comments to this thread.
• Clearview Documentation
  Clearview is a project to rationalize, unify, and enhance the way network interfaces are handled in Solaris at the programmatic and administrative levels. Several components make up the project, thus multiple documents are required to describe administrative tasks. Clearview docmentation can be reviewed on the project's documentation page.
• Build Documentation
  We've added new build content to the Starter Kit and here is a beta draft of the procedure that we'll use as a basis (and link target) from the Developer HOWTO we're drafting on genunix.
  To provide feedback on the content of the documents above, post a reply to this thread.