Repository: incubator-apex-core Updated Branches: refs/heads/master e5e59ee1b -> 5e932e281
APEXCORE-293 Adding readme and site gitignore Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/commit/0621bf7e Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/0621bf7e Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/0621bf7e Branch: refs/heads/master Commit: 0621bf7e01652dda54ca157e4955be240c6cd6ea Parents: 735ec93 Author: Sasha Parfenov <[email protected]> Authored: Fri Mar 4 17:38:21 2016 -0800 Committer: Sasha Parfenov <[email protected]> Committed: Fri Mar 4 17:38:21 2016 -0800 ---------------------------------------------------------------------- .gitignore | 1 + docs/README.md | 17 +++++++++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/0621bf7e/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index f03da71..6a5435c 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ node_modules/ x-java nb-configuration.xml gateway/src/main/htdocs +site/ http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/0621bf7e/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index c9fe8da..4663929 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,13 +22,22 @@ Guides on applying site-wide [configuration](http://www.mkdocs.org/user-guide/co ## Deployment -**Under Review**: Current deployment process is under review, and may change from the one outlined below. +Deployment is done in two steps. First all documentation is statically generatd into HTML files and then it is deployed to the apex website. For more details on how conversion to HTML works see [MkDocs documentation](http://www.mkdocs.org/). -Deployment is done from master branch of the repository by executing the following command: +1. Go to release branch of the repository and execute the following command to build the docs: ```bash -mkdocs gh-deploy --clean +# get project version +APEX_VERSION=3.3 + +# build docs under site foolder +mkdocs build --clean + +# copy docs from site into target folder on apex-site +cp -r site ../incubator-apex-site/docs/apex-${APEX_VERSION} + +# commit changes and deploy the website ``` -This results in all the documentation under [docs](docs) being statically generatd into HTML files and deployed as top level in [gh-pages](https://github.com/apache/incubating-apex-core/tree/gh-pages) branch. For more details on how this is done see [MkDocs - Deploying Github Pages](http://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages). \ No newline at end of file +2. Go to [apex-site repository](https://github.com/apache/incubator-apex-site#contributing) and add the new link to the [docs.md](https://github.com/apache/incubator-apex-site/blob/master/src/md/docs.md) and follow committer steps to commit and push these changes, and deploy the site.
