OpenSolaris

You are not signed in. Sign in or register.

OpenSolaris Project: Printable Many Page Solaris Manuals

View the leaders for this project
Project Observers

Endorsing communities

Documentation

Printable Many Page Solaris Manuals

To participate, join the dicussion forum!

Project Goals

The aim of this project is to create a set of one to five page printable Solaris manuals to cover different aspects of Solaris use and administration in a server and desktop environment. The initial focus distribution will be Solaris Community Express.

Roadmap

The initial manual will be based on the project leader's initial inspiration, the "One Page Linux Manual". The project leader aims to produce a production quality version of the "One Page Solaris Manual" by the end of March in 2007 if not sooner.

During this time, the project will solicit ideas of what manuals would be useful to new or seasoned system administrators in a printed (i.e. not online) format. The project will then assign writing tasks to different interested groups loosely modeled after a real publishing company which has writers, editors and technical reviewers.

Peer Projects and Communities

Two communities stand out as peers or especially related to this project:

  1. The Documentation Community
  2. The Immigrants Community

The project will ensure that the immigrants community is aware of its progress and finished products, whilst it will initially borrow some of the documentation community's resources, such as a mailing list, to conduct documentation specific discussions.

Technical Details

The format and layout of the pages is not yet set, however the following requirements must be met:

  1. The source must be able to reliably be transformed into print quality handouts or sheets
  2. The source must be in a truly open standard and preferably not a standard which allows the verbatim inclusion of older, closed standards as a standard "backward compatibility" measure
  3. No technical decision taken should be considered sacrosanct, i.e. if there is a truly better way to do it, then strive to do it that way

Legal Details

The intent of this project is to create printable manual pages whose:

  1. Source is available to download and distribute to any who will comply with its licensing conditions
  2. Product is licensed so that the distribution of a Sun operating system, such as Sun Solaris, can be made
  3. The project will not accept liability, in so far is it is legal, for its products but the license chosen will not prohibit a distributor of the product from accepting any liability