Update Document Procedures
There are different documents in different location need to be updated and are described as follows:
- Repository:
- Procedures:
- apiDoc: automatically generated by ant javadoc (ant release)
- userDoc: manually updated
- designDoc: manually updated
- apiDoc, userDoc, and designDoc are placed to the right location (after updated) by ${TC_DIR}/docs/updateDoc (ant release)
- ${TC_DIR}/docs/updateDoc:
- Copy desginDoc from development web site to development package
- Copy userDoc from development web site to development package
- Copy images from development web site to development package
- Copy apiDoc from development package to development web site
- Copy Java source code from ${TC_DIR}/sources to ${TC_DIR}/docs
- Copy Java source code from ${TC_DIR}/sources to web site
- Test & Deploy:
- Development: lexlx1
- Internal test: lexdev
- Public test: lexsrv2
- Public deployment: lexsrv3
. | Development Package | Development Web Site | |||
---|---|---|---|---|---|
Location | lexlx1:${DEV}/TC/tc${YEAR} | lexlx1:${APACHE}/docs/LexSysGroup/Projects/tc/${YEAR} | |||
URL | N/A | http://lexlx1.nlm.nih.gov/LexSysGroup/Projects/tc/${YEAR} | |||
designDoc | Copied from Master copy | Master Copy | |||
apiDoc | Master Copy, generated by ant javadoc | Copied from Master copy | |||
userDoc | Copied from Master copy | Master Copy
ReadMe.txt | Master Copy | N/A
| |