OpenSolaris Documentation Community SketchPad

From Genunix

Welcome to the OpenSolaris Documentation Community SketchPad!

Contents

[edit]

Current Efforts and TODO List

This page includes in-progress documents for OpenSolaris, and items to be completed.

[edit]

Docs Repository Work

  • Fill out the Subversion repository (benr)
  • Work out a method with the ON Community by which to update the DevRef in the future (michelle)::::Update:I've got a contact for this update, when we're ready. Also, we found a utility today to convert pod to docbook, so this work will be getting underway in earnest next week.Michelle 14:41, 19 May 2006 (PDT)
  • Upload Makefile for DocBook to HTML toolchain using xsltproc (elowe)
[edit]

Conversion Work

  • DocBook-ify the Developer Reference (benr) ::::Update:I ran the POD source through my conversion tool and provided the output to Michelle to add to the SVN repository, along with a Makefile that generates HTML...ELowe 14 Jun 2006 ::::Update, DocBook files for Developer's Reference are included in the Docs consolidation, will try to populate Subversion repository in coming two weeks.Michelle 10:58, 10 July 2006 (PDT)
  • DocBook-ify the Crashdump Analysis book?
[edit]

Tools Work

  • We have a good DocBook to HTML path with xsltproc and Makefiles. We do not yet have a PDF toolchain. We need to build one. (elowe, Michelle)

- Some work has been done with the fop PS/PDF process Ben outlined. Some success, much more debugging to do. (rheilke)

[edit]

Wiki Work

  • Create a community SketchPad area on the wiki for the Docs community and others that need it. (benr - DONE!)(wahoo!)Michelle 16:35, 17 May 2006 (PDT)
[edit]

Style Guide Work

  • For the finishing touches on the documentation style guide, we need some content for a section that provides graphical tool recommendations, or at least a list of tools or practices for creating graphics for XML documents. We also need some recommendations for good illustration tools, particularly tools that enable layering. Also, we should include some tool that is good for creating flow charts. (unassigned)
[edit]

Big Doc List Work

  • Help to audit the documents that are posted on OpenSolaris.org and ensure that links to any new documents are included in the Big Doc List. (unassigned, might require the help of a few people who can spend a little time each week)
[edit]

Documentation Work

  • SMF FAQ
  • Put together instructions for quick-and-easy documentation tools. (ASCIIdoc - rheilke)(yay!)Michelle 16:35, 17 May 2006 (PDT)
  • Create an FAQ for the Documentation Community. (unassigned)Michelle 16:35, 17 May 2006 (PDT)
[edit]

Laptop Documentation

  • Document how to configure SMF services. TBD
  • Document how to use WEP on a laptop with following as a start: 
> I have WEP setup on my network. However, I don't see

> any docs/info on how to add WEP settings to an > inetmenu profile. Any suggestions?

I used wificonfig to add WEP to a profile. Then inetmenu uses it. I connect using a command like:

inetmenu -i iwi0 -W tobeornottobe -t

where tobeornottobe is the WEP enabled profile.

Other stuff to consider:

wificonfig.1m provides some good examples, but not the process prespective; need to cover the meta task as follows (from the laptop community page) with more details:

1. Scan available WLANs:

# wificonfig -i ath0 scan

2. Automatially connect to whatever WLAN:

# wificonfig -i ath0 autoconf

3. Create new configuration profile for WLAN "mywifi" protected with WEP:

# wificonfig -i ath0 createprofile essid=mywifi encryption=WEP wepkey1=12345

4. Connect using new profile: # wificonfig -i ath0 connect mywifi

Michelle 10:38, 10 July 2006 (PDT)

  • Create documentation that describes order of use:

Before you run 'autoconf', you should predefine a profile by 'createprofile' and place that profile in the preference list by 'setprefer'. Alternatively, after you define a profile and successfully connect to the WIFI network with that profile by 'connect' , then that profile will be recorded in the preference list automatically.--I think this is what is described above, what are benefits or doing it the former way? Michelle 10:42, 10 July 2006 (PDT)

  • Create documentation that describes configuration of X windows.

References: xwin-discuss and x windows community;

[edit]

Xorg Config for NVidia on Solaris

(from the nVnews.net forum...[[1]]) Although the NVidia readme says it supports Quadro cards only, I have it working like a champ on my GeForce FX 5200 card on Solaris10. Here is how to get it working;

1. As su, run /usr/X11/bin/xorgconfig. Answer the questions as appropriate and the program will create an xorg.conf in /etc/X11.

2. Run kdmconfig and change from the xsun server to xorg server.

3. Download the NVidia driver for Solaris from their website [[2]]

4. Read the README and run the file as per instructions

5. Run /usr/X11/bin/scanpci and check the pci id of your NVidia card.

6. run the command update_drv -a -i '"pcixxxx,xxx"' nvidia where the xxxs are filled by the values you got from scanpci command. Don't forget the quotes ' and ". One thing to note here,scanpci gave me a PCI ID for my GeForce 5200 as 0x10de 0x0322. Entering it as '"pci10de,0322"' failed. I had to go into /etc/driver_aliases and drop the 0 in 0322. Finicky eh?

7.Edit the /etc/X11/xorg.conf file anc change the entry that reads "nv" to "nvidia"

8. Finally as root run the following command # reboot -- -r and enjoy NVidia 3d acceleration in all its glory on Solaris. Dont forget to run nvidia-settings and check your options there including cursor shadow

TS: In order to get this working on my Dell Inspiron 5150 (Nvidia GeForce Go5200), I had to run /usr/X11/bin/scanpci and take the line corresponding to the card and append the details to /etc/driver_alias. The actual values were 0×10de, 0×0324

TS: To correct slow behavior of xorg when app is run or CD inserted:

eeprom "atapi-cd-dma-enabled=1"

from the command line.

Your optical drive is using PIO instead of DMA to do I/O.

[edit]

855resolution patch directions

[[3]] this is for ubuntu, is there Solaris equivalent?

OR

915resolution port for Solaris: [[4]]

[edit]

Tested Laptops

  • Create a list of new laptops that run latest Nevada builds with following qualities:

nVidia driver

A list extsts here, for cardbus usage: www.opensolaris.org/os/community/laptop/wireless/cardbus/

[edit]

Security Configuration Documentation

  • Document Apache + SSL using this starting point:

There are two ways to do this. The first, and arguably correct way, is to get a certificate from the Sun PKI. The second is just to create a self signed cert.

Taking the self-signed route do this:

  1. cd /etc/apache
  2. openssl req -newkey rsa:2048 -nodes -new -keyout

/etc/apache/ssl.key/server.key -out /etc/apache/ssl.crt/server.crt -days 1825 -x509 Generating a 2048 bit RSA private key ..+++ ..........................................+++ unable to write 'random state' writing new private key to '/etc/apache/ssl.key/server.key'

You are about to be asked to enter information that will be incorporated into your certificate request. What you are about to enter is what is called a Distinguished Name or a DN. There are quite a few fields but you can leave some blank For some fields there will be a default value, If you enter '.', the field will be left blank.

Country Name (2 letter code) []: State or Province Name (full name) []: Locality Name (eg, city) []: Organization Name (eg, company) []: Organizational Unit Name (eg, section) []: Common Name (eg, YOUR name) []:mix.sfbay.sun.com Email Address []:


The only field you need to fill in is Common Name, here you MUST put the hosts FQDN and that MUST match ALL of the ServerName entries in /etc/apache/httpd.conf.

Now restart apache using /etc/init.d/apache start and you should be able to go to https://your.fqdn.sun.com (unassigned) Michelle 16:48, 18 May 2006 (PDT)

[edit]

OpenSolaris Website Documentation

  • Document processes for finding the best bug categories; I fouind this string on website-discuss: 
>>>>>"Hugh" == Hugh McIntyre <lists@mcintyreweb.com> writes:


Hugh> While I tend to agree a single set of categories is probably OK
Hugh> (rather than a "user view" and "developer view"), there's
Hugh> definitely scope for a "guide to choosing the right category",
Hugh> either as a document on the web or otherwise.

Yes, a written guide would be very helpful.

There's support in Bugster for a documentation string that appears in
the product/category/subcategory choosers, but in many cases this string
is not being used.  We need to fix that, too.

mike
[edit]

OpenSolaris 2008.11 Doc Deliverables

Create list of desired doc deliverables from community discussions and known development activities. Status: Done. See this table. 08/04/08 alanm


[edit]

OpenSolaris Information Strategy

Organize and launch a working group to help define large-scale information product deliverables, processes, authoring and delivery channels, etc. as they pertain to OpenSolaris, .com and .org sites, Solaris 10 work, et al. See Information Strategy Working Group 08/04/08 alanm

Retrieved from "http://www.genunix.org/wiki/index.php/OpenSolaris_Documentation_Community_SketchPad"