Dave, Yes, I should have mentioned that the articles for both AI and DC will also be posted with other Open Solaris documentation in HTML format at: http://www.opensolaris.org/os/community/documentation/docs-index/ I'll cross-reference both documents and man pages in the Getting Started Guide on the Live CD. And, I'll add cross-references inside the docs that are in the AI and DC packages that mention that the docs are also posted on the web.
I'll also post .pdf copies on opensolaris.org at the project sites' files directory. Thanks for info about README, sounds like that's not a good option for these documents. We'll just go with the articles and man pages instead. No, this hasn't been done with other projects, I was just brainstorming on what we could do. Alan McClellan is working the larger issues of where OpenSolaris documentation will be available and how it will be delivered post-November. I think the larger issue of searchability of documentation will be a topic he'll be working on. Barbara On 09/24/08 11:11, Dave Miner wrote: > Barbara.Lundquist at Sun.COM wrote: > >> All, >> >> I've been talking to Jack and Karen about possible deliveries for Distro >> Constructor, in terms of >> how to deliver into the engineering package for DC and I have some >> suggestions that I think >> might work for both AI and DC document deliveries. >> >> 1 - Man Page: I deliver text file with man page to Jack for DC and to >> Sundar for AI. >> They post man page file in /usr/share/man for preinstall packages. Then >> they add command >> to source code (Ethan Quach can provide) to get the man page into >> post-install /usr/share/man/man.1m folder >> for display with man command. This method worked fine for Snap Upgrade >> man page in May. >> Cross-reference article in the man page. >> >> > > It actually will just be installed in /usr/share/man/man1m as part of > the package installation, though I don't expect either of these will be > on the live CD. > > >> 2 - Article: I deliver HTML files to Jack and Sundar with main articles >> for AI and DC. >> They post these HTML files in /usr/share/docs folder. Cross-reference >> man page in the article. >> >> > > Will these articles also be posted online somewhere? I'm concerned > about discoverability here; since Google (or other Internet) search is > such a prevalent means of locating documentation resources, how will > such users find the information? > > >> 3 - README: I deliver short text file to Jack and Sundar with filename >> of README.txt. >> They place this prominently in the package list of folders. Is there a >> usual place that >> you'd put a README? This README points readers to both the man pages and >> to the articles. >> >> > > README's aren't generally provided for installed binaries; they more > often correspond to source code deliveries, and there really isn't a > standard location. What info is intended to be here that wouldn't be > appropriate to put in either of the other two documents? Are there > other projects that are using this construction? > > Dave > _______________________________________________ > caiman-discuss mailing list > caiman-discuss at opensolaris.org > http://mail.opensolaris.org/mailman/listinfo/caiman-discuss > -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://mail.opensolaris.org/pipermail/caiman-discuss/attachments/20080924/e71ae199/attachment.html>
