apex-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t..@apache.org
Subject incubator-apex-core git commit: Updating docs
Date Tue, 22 Mar 2016 01:47:31 GMT
Repository: incubator-apex-core
Updated Branches:
  refs/heads/master 63fdfd0d0 -> 2047a8a8b


Updating docs


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/2047a8a8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/tree/2047a8a8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-core/diff/2047a8a8

Branch: refs/heads/master
Commit: 2047a8a8b02ed685976e282981cfb2ac84048fbd
Parents: 63fdfd0
Author: Sasha Parfenov <sashap@apache.org>
Authored: Mon Mar 21 18:40:45 2016 -0700
Committer: Sasha Parfenov <sashap@apache.org>
Committed: Mon Mar 21 18:43:39 2016 -0700

----------------------------------------------------------------------
 docs/README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-apex-core/blob/2047a8a8/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index eecf8cf..90efd5f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -25,7 +25,7 @@ Guides on applying site-wide [configuration](http://www.mkdocs.org/user-guide/co
 
 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:
+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
@@ -37,7 +37,10 @@ mkdocs build --clean
 # copy docs from site into target folder on apex-site
 cd ../incubator-apex-site
 git checkout asf-site
+rm -rf docs/apex-${APEX_VERSION}
 cp -r ../incubator-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


Mime
View raw message