[EMAIL PROTECTED] wrote:
Indiana Participants:

1) Please review the documentation that we are developing for OpenSolaris 2008.05 release, and email your edits and comments to us by Friday, 4/25. Feedback received after 4/25 may not be integrated in time for the May release.

The documentation is available for review in HTML and .pdf.

HTML format is available at:
http://dlc.sun.com/osol/docs/content/IPS/getst1.html

.pdf format is available at:
http://www.opensolaris.org/os/project/indiana/files/
Note: Please ignore the Sun logo on .pdf copy. The final documentation will be in the OpenSolaris HTML format.

This documentation includes three main sections:
     Getting Started with installing OpenSolaris 2008.05 (owner: Barbara)
     Image Packaging System documentation (owner: Jyothi)
     Upgrading and Managing Multiple Boot Environments (owner: Barbara)

2) We are looking for more examples for the "Creating an IPS Package" section. In particular, send us specific examples of creating an IPS package for a C application or a Web Stack application and publishing to an IPS repository.

3) Please also review and send suggestions about Michelle Olson's new main documentation hub at:

http://opensolaris.org/os/community/documentation/doc_splash/ This page replaces the "Gateway to Indiana" page on the Project Indiana site, although the "Gateway to Indiana" page will be updated for 2008.05.

Note: The documentation is developed in a prototype mercurial repository. For the May release, email us your edits. After the May release, we'll open this repository to interested contributers.

Barbara Lundquist
Jyothi Srinath




_______________________________________________
indiana-discuss mailing list
[EMAIL PROTECTED]
http://mail.opensolaris.org/mailman/listinfo/indiana-discuss



Barbara,

My comments are in the attached text file. The document looks very good and I think will be very helpful to new users. Much of what I have are simple nits. I tried to read through this with the perspective of a new user.

I still have to read through the last 10 pages or so and will do that tomorrow, Friday 4/25 AM

Joe VLcek


Issue 1:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=
I don't think the Getting Started guide matches the VirtualBox
documentation:

e.g.

The terminology used in the VB documentation Virtual Box runs on a a client
and runs guest operating systems.

See the VirtualBox documentation for their wording.
www.virtualbox.org/wiki/Documentation

Some examples of where I don't think the Getting Started guide matches
the VB documentation are:


p7  and 21

Based on the VirtualBox documentation I think:

How to mount the OpenSolaris 2008.05 release in a VirtualBox.

might better match the VirtualBox documentation if it were:

How to run the OpenSolaris 2008.05 release as a VirtualBox guest
operating system.

p8

to mount the OpenSolaris OS in a VirtualBox

might better match the VirtualBox documentation if it were:

to run the OpenSolaris OS as a VirtualBox guest

p9

...or mount the OpenSolaris ISO image in a VirtualBox environment

might better match the VirtualBox documentation if it were:

...or run the OpenSolaris ISO image as VirtualBox guest operating system

p21

Use these steps to set up OpenSolaris in VirtualBox:

might better match the VirtualBox documentation if it were:

Use these steps to set up OpenSolaris as a VirtualBox guest operating system.


Issue 2:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p8 

Describes how / is a ZFS file system I think a reference could be
added which contain a pointer to ZFS Opensolaris page.

opensolaris.org/os/community/zfs


Issue 3:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p8 

The following statement follows a paragraph about running the installer
so it may not be clear that this statement only applies when running
the pre-installed LiveCD.

"Note - If you are prompted to login, both the username
and password are jack.  The root password is opensolaris.

I also think this is important information and might be better placed
in a more obvious place and not as a Note: at the bottom of a table.

My suggested wording is:

"Note - When running the Live image, if you are prompted
to login, both the username and password are jack. The
root password is opensolaris. However Role Bassed Access Control (RBAC) 
prevents desktop login as root.[:w

Issue 4:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=
p10

If you will be setting up a multiboot environment instead of a Virtual Box,
review specifications for a Multiboot Environment.

I don't think the reference to Virtual Box is necessary here.
My suggested wording is:

If you will be setting up a multiboot environment,
review specifications for a Multiboot Environment.

Issue 5:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p11

We note Live Upgrade isn't supported. Perhaps we should note that new
BE tools are now available.

i.e. Under:

Limitations for the OpenSolaris 2008.05 Release

... this release does not support Live Upgrade.

Perhaps we should state something about:

how it does support the new Boot Environment tools...


Issue 6:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

I think the section on how to start the device driver utility is a little
confusing, to me anyway. :)

and it seems to have the wrong information on how to start the utility.
Where I found to run the utility was under System/About OpenSolars
and on the desktop when running the LiveCD.

This may be related to bug 1284.

It states in bold "How to Start the Device Driver Utility" then goes on
to describe the requirements... after which it contains the one line
of how to start the Utility. I find this a little confusing.

I would like to suggest removing the bold line: "How to Start the Device
Driver Utility" and replace what is below it with:

Before you begin to use the Device Driver Utility confirm the following
requirements are met:

   o OpenSolaris 2008.05 release installed on your system
   o Python Version 2.4x or later
   o Perl Version 5.8x or later
   o Internet connection
   o The internet connection enables you to connect your system ...

To run the Device Driver Utility Select the About OpenSolaris
icon under the System menu. Then click on the "Devices" button on the
About Opensoloris pop-up.

Issue 7:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p13
 Instruction on how to backup OSs other than windows could be helpful...

 Backing up your system contains a pointer to how to back up a windows
OS but there is no information about how to back up other possible installed
OSs.

Issue 8:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

I think the Note/warning "Sun is not responsible for the availability of
third-party web sites" should be at the beginning of the Getting started
guide.

Issue 9:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p15 the line "The installer begins." does not seem necessary.

Issue 10:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p15 I think there is a miss wording, "for" needs to be change to "on".

2 Complete any additional selections for the preliminary installation panels.

I think should be change to:

2 Complete any additional selections on the preliminary installation panels.

Issue 11:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p18 I don't think "then click Next" and "and click Next" on steps 5 & 6
is consistent with the other steps and is not necessary in the heading
for the step since it is mentioned at the end of each step.

Issue 12:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p19 It might be valuable to state were the installer log files are.

Issue 12:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p21 How to Download OpenSolaris" should also be explained earlier,
before section "Installing OpenSolaris 2008.05" since it would be
needed to do the Install.

Issue 13:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p27 It's not obviouse to me why the nwam man page is at the end of 
chapter 1. Being here it almost seems to be part of the section "How
to Install When Using Parallels"

Would it be better to have the nwam man page in an appendix?

Issue 14:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p32

The following Note doesn't make sense to me:
"Review the following specifications with respect to IPS in the 2008.05
release of Indiana."

Issue 15:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p33

Since there are 2 different man pages for the pkg command, pkg(1) and
pkg(5), I think the note on p33 should contain both:

From:
"Note - The pkg(5) man page describes the overall Image Packaging System.
 Man pages are also available for each of the IPS commands."

Suggested chagne to:
"Note - The pkg(1) man page describes the image package retrieval client.
        The pkg(5) man page describes the overall Image Packaging System.
        Man pages are also available for each of the IPS commands."



Issue 16:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p37 P38
"Example 2-7" TBD 
"Example 2-10" TBD 

I think these examples could be removed.


Issue 17:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p39  -> 42


I think the pkg examples may contain old output. The headeres seem to have
changed.

e.g.:

Example 2-11

$ pkg contents -t dir,file,link,hardlink -o 
action.name,mode,pkg.size,path,target SUNWbash
ACTION.NAME MODE PKG.SIZE PATH           TARGET
dir         0755          usr
dir         0755          usr/bin
file        0555   730604 usr/bin/bash
dir         0755          usr/gnu
dir         0755          usr/gnu/bin
link                      usr/gnu/bin/sh ../../bin/bash

Example 2-12


Issue 18:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p 41 the command is missing that produced the output for Example2-13

Issue 19:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p42 The statement "Switch to root user before executing this command."

I think it would be helpful to add:

"or use pfexec."

e.g.:

% pfexec pkg unset-authority <authority>


Issue 20:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

Fill in TBDs.

e.g.
p43:
   How to Install Java
   Use the following command to install the NetBeans package.
p44:
   To install the Sun Studio Express package, type:
   under "Next Steps" path-TBD, ... path-TBD,
p58
   How to Replace a Package in a IPS Repository With a
   Newer Version


Issue 21:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p45 How to Install Sun HPC ClusterTools 7.1

I think this section should have a pointer to the
"Sun HPC ClusterTools" site:
 http://www.sun.com/software/products/clustertools/

and to the "Download Sun HPC ClusterTools"
http://www.sun.com/software/products/clustertools/get.html

Issue 22:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

p45 "To install Sun HPC ClusterTools 7.1 locally on a single node, as root,
perform that following commands:"

I don't think the first line in this example is needed. Instead I think
it should descibe how to get the bits from:
http://www.sun.com/software/products/clustertools/get.html


Issue 23:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=

I think it might be better if section "Installing Developer Software (Tasks)"
came after section: "IPS For Developers (Tasks)" in chapter 2.

This way the IPS sections would be grouped together.

Suggested organization change for Chapter 2

From:
   Chapter 2:
   ----------
   IPS Overview
   IPS for End Users (Tasks) 
   Installing Developer Software (Tasks) 
   IPS for Developers (Commands) 
   IPS For Developers (Tasks) 
   Further Information 
   pkg(1) Command Reference
   Glossary

To:
   Chapter 2:
   ----------
   IPS Overview
   IPS for End Users (Tasks) 
   IPS for Developers (Commands) 
   IPS For Developers (Tasks) 
   Installing Developer Software (Tasks) 
   Further Information 
   pkg(1) Command Reference
   Glossary

Issue 24:
+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=+-=
p53-54

It is not clear to me what the difference is between:

How to Create Your Own OpenSolaris Repository Using
the pkg.depotd Command

   and

How to Create Your Own OpenSolaris Repository Using
smf Commands

Do these two approaches really produce the same result?



_______________________________________________
pkg-discuss mailing list
[email protected]
http://mail.opensolaris.org/mailman/listinfo/pkg-discuss

Reply via email to