Github user PramodSSImmaneni commented on a diff in the pull request: https://github.com/apache/apex-site/pull/42#discussion_r72340598 --- Diff: src/md/release.md --- @@ -150,6 +150,57 @@ mkdir svn-dist && cp *-source-* svn-dist/ svn import svn-dist https://dist.apache.org/repos/dist/dev/apex/${RNAME}-RC1 -m "Apache Apex v${rv}-RC1" ``` +## Build and Deploy Documentation + +The documentation will be generated as static HTML files and copied into the `apex-site` repository. It will be available at an alternate URL path until the release is promoted, at which time it will also be promoted to the main website location. + +Do the following setup steps before building and deploying the documentation. + +1. Clone the apex-site repository into a folder called ```apex-site``` at the same level as the current repository. + +2. Set the following environment variables. + + For -core releases: + + ``` + REPO_NAME=apex-core + DOC_NAME=apex + ``` + + For -malhar releases: + + ``` + REPO_NAME=apex-malhar + DOC_NAME=malhar + ``` + + The `REPO_NAME` variable above should match the folder name of the cloned apex module being built. + +To build and deploy the documentation, execute the following commands in the apex module folder specified in `REPO_NAME` above. **Note**: Until [mkdocs #859](https://github.com/mkdocs/mkdocs/issues/859) is resolved and available for download, use mkdocs built against [master](https://github.com/mkdocs/mkdocs). + +```bash +# build docs, they would be generated in a site sub-folder +mkdocs build --clean + +# Calculate the major.minor version +docv=`echo ${rv} | sed 's/\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\)/\1\.\2/'` + +# copy docs from site folder into target folder on apex-site +cd ../apex-site +git checkout asf-site +rm -rf docs/${DOC_NAME}-${docv} +cp -r ../${REPO_NAME}/site docs/${DOC_NAME}-${docv} +git add -A +git commit -m "Adding ${DOC_NAME}-${docv} documentation" +git push +``` + +The documentation is now accessible at the URL location below. For patch releases, however, the documentation would already be reflected in the regular website. --- End diff -- I will reword it.
--- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---