You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by pr...@apache.org on 2016/03/15 01:08:25 UTC
incubator-apex-core git commit: APEXCORE-382 #resolve Adding new
documentation steps to avoid build artifacts on in site master branch
Repository: incubator-apex-core
Updated Branches:
refs/heads/master 7c84e05e1 -> fb04f62dd
APEXCORE-382 #resolve Adding new documentation steps to avoid build artifacts on in site master branch
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/fb04f62d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/fb04f62d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/fb04f62d
Branch: refs/heads/master
Commit: fb04f62dde109ed5bae617dd827947c757e3c138
Parents: 7c84e05
Author: Sasha Parfenov <sa...@apache.org>
Authored: Mon Mar 14 16:22:52 2016 -0700
Committer: Sasha Parfenov <sa...@apache.org>
Committed: Mon Mar 14 16:22:52 2016 -0700
----------------------------------------------------------------------
README.md | 2 +-
docs/README.md | 11 +++++++----
2 files changed, 8 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/fb04f62d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 97c2b03..c16d993 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ Please visit the [documentation section](http://apex.incubator.apache.org/docs.h
[Malhar](https://github.com/apache/incubator-apex-malhar) is a library of application building blocks and examples that will help you build out your first Apex application quickly.
-Documentation build and hosting process is explained in [docs/README.md].
+Documentation build and hosting process is explained in [docs README](docs/README.md).
##Contributing
http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/fb04f62d/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 4663929..eecf8cf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -28,16 +28,19 @@ Deployment is done in two steps. First all documentation is statically generatd
1. Go to release branch of the repository and execute the following command to build the docs:
```bash
-# get project version
+# 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
-cp -r site ../incubator-apex-site/docs/apex-${APEX_VERSION}
-
-# commit changes and deploy the website
+cd ../incubator-apex-site
+git checkout asf-site
+cp -r ../incubator-apex-core/site docs/apex-${APEX_VERSION}
+git add -A
+git commit -m "Adding apex-${APEX_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.