BIRCH - Edit local documentation
Customize local documentation files
One of the most important aspects of a well-run bioinformatics
system is that the documentation should look be as specific as possible
about how things work on your
system. To accomplish this trick, many parts of the BIRCH documentation
can be customized, without losing your changes every time you update
BIRCH.
The following files in $BIRCH/local/public_html
need to be edited to tailor them to your local system.
- findinfo/findinfo.html - This file describes how to find
general system information, who to contact for support, and other
system-specific information.
- remote/remote.html - This file provides links to
information on remote connection, via Ethernet or dialup. Add system
specific-links here.
- setup/setup.html, setup.jds/setup.jds.html etc... - These
files should be edited with
specific instructions on how to set up one's Unix desktop on your
system. There is a different file for each desktop (eg. GNOME, CDE),
but it only makes sense to include links, on the BIRCH home page, to
setup instructions for desktops that are available on your system.
These files serve only as a starting point. They are specific for our
system at the University of Manitoba, but need to be tailored to your
system. Because they are in $BIRCH/local,
they will NOT be overwritten each time BIRCH is updated.
The BIRCH Home Page
The BIRCH Home Page ($birch/public_html/index.html) gets overwritten
each time you update BIRCH. If you were to make changes in this page,
they would be lost during the next update. However, many sections of
this page can be automatically replaced with your own HTML See Customizing the BIRCH HOME
page for complete details.
Please send suggestions of comments regarding
this page to frist@cc.umanitoba.ca