Repository: apex-malhar Updated Branches: refs/heads/master 139d89fd3 -> 58201fbf9
Removed deployment documentation as it is included in the release documentation Project: http://git-wip-us.apache.org/repos/asf/apex-malhar/repo Commit: http://git-wip-us.apache.org/repos/asf/apex-malhar/commit/eb624518 Tree: http://git-wip-us.apache.org/repos/asf/apex-malhar/tree/eb624518 Diff: http://git-wip-us.apache.org/repos/asf/apex-malhar/diff/eb624518 Branch: refs/heads/master Commit: eb62451875ad1dbb5008124f45475284ca85ce55 Parents: 139d89f Author: Pramod Immaneni <[email protected]> Authored: Sat Jul 9 12:36:45 2016 -0700 Committer: Thomas Weise <[email protected]> Committed: Fri Sep 30 10:59:43 2016 -0700 ---------------------------------------------------------------------- docs/README.md | 24 ------------------------ 1 file changed, 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/apex-malhar/blob/eb624518/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index a001a1d..ec669bc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,27 +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: - -```bash -# set project version -APEX_MALHAR_VERSION=3.4 - -# build docs under site foolder -mkdocs build --clean - -# copy docs from site into target folder on apex-site -cd ../incubator-apex-site -git checkout asf-site -cp -r ../incubator-apex-malhar/site docs/malhar-${APEX_MALHAR_VERSION} -git add -A -git commit -m "Adding apex-${APEX_MALHAR_VERSION} documentation" -git push -``` - -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.
