Repository: apex-core Updated Branches: refs/heads/master 7ca1ed12d -> cba9a6abd
Removed deployment documentation as it is included in the release documentation Project: http://git-wip-us.apache.org/repos/asf/apex-core/repo Commit: http://git-wip-us.apache.org/repos/asf/apex-core/commit/b01f1f78 Tree: http://git-wip-us.apache.org/repos/asf/apex-core/tree/b01f1f78 Diff: http://git-wip-us.apache.org/repos/asf/apex-core/diff/b01f1f78 Branch: refs/heads/master Commit: b01f1f783822057f0fffc99b2ad285d84a90df56 Parents: c03f05d Author: Pramod Immaneni <[email protected]> Authored: Sat Jul 9 12:38:33 2016 -0700 Committer: Pramod Immaneni <[email protected]> Committed: Sat Jul 9 12:38:33 2016 -0700 ---------------------------------------------------------------------- docs/README.md | 28 ---------------------------- 1 file changed, 28 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/apex-core/blob/b01f1f78/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 3137ed7..c497213 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,31 +19,3 @@ For additional details see [writing your docs](http://www.mkdocs.org/user-guide/ ## Site Configuration Guides on applying site-wide [configuration](http://www.mkdocs.org/user-guide/configuration/) and [themeing](http://www.mkdocs.org/user-guide/styling-your-docs/) are available on the MkDocs site. - -## Deployment - - -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/). - -1. Go to release branch of the repository and execute the following command to build the docs. **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 -# set project version -APEX_VERSION=3.3 - -# build docs under site foolder -mkdocs build --clean - -# copy docs from site into target folder on apex-site -cd ../apex-site -git checkout asf-site -rm -rf docs/apex-${APEX_VERSION} -cp -r ../apex-core/site docs/apex-${APEX_VERSION} -# Set this to be latest available docs version -cd docs && ln -nsf apex-${APEX_VERSION} apex -git add -A -git commit -m "Adding apex-${APEX_VERSION} documentation" -git push -``` - -2. Go to [apex-site repository](https://github.com/apache/apex-site#contributing) and add the new link to the [docs.md](https://github.com/apache/apex-site/blob/master/src/md/docs.md) and follow committer steps to commit and push these changes, and deploy the site.
