apex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tweise <...@git.apache.org>
Subject [GitHub] apex-site pull request #42: Added updating documentation to release process
Date Tue, 12 Jul 2016 19:21:49 GMT
Github user tweise commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/42#discussion_r70504409
  
    --- Diff: src/md/release.md ---
    @@ -150,6 +150,47 @@ 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 location until the release is promoted,
at which time it will also be promoted to the main website location.
    +
    +Do the following setup setups before building and deploying the documentation. Clone
the apex-site repository into a folder called ```apex-site``` at the same level as the current
repository. 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
    +```
    +
    +Execute the following commands to build and deploy the documentation. **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 the site folder
    +mkdocs build --clean
    +
    +# copy docs from site into target folder on apex-site
    +cd ../apex-site
    +git checkout asf-site
    +rm -rf docs/${DOC_NAME}-${rv}
    --- End diff --
    
    Documentation is always MAJOR.MINOR, so ${rv} is not correct here.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message