Update Document Procedures

There are different documents in different location need to be updated and are described as follows:

  • Repository:

    .Development PackageDevelopment Web Site
    Locationlexlx1:/export/home/lu/Development/LVG/lvg${YEAR} lexlx1:/usr/local/www/Apache/apache/docs/LexSysGroup/Projects/lvg/${YEAR}
    URLN/Ahttp://lexlx1.nlm.nih.gov/LexSysGroup/Projects/lvg/${YEAR}
    designDocCopied from Master copyMaster Copy
    apiDocMaster Copy, generated by ant javadocCopied from Master copy
    userDocCopied from Master copyMaster Copy
    ReadMe.txtMaster CopyN/A

  • 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 ${LVG_DIR}/docs/updateDoc (ant release)
    • ${LVG_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 ${LVG_DIR}/sources to ${LVG_DIR}/docs
      • Copy Java source code from ${LVG_DIR}/sources to web site

  • Test & Deploy:
    • Development: lexlx1
    • Internal test: lexdev
    • Public test: lexsrv2
    • Public deployment: lexsrv3