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
