You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by th...@apache.org on 2016/07/28 21:56:40 UTC
apex-site git commit: from 18264a780c0287cd9b1f4e2af236c7fa4ae1738d
Repository: apex-site
Updated Branches:
refs/heads/asf-site 10511d9ed -> 62a203a66
from 18264a780c0287cd9b1f4e2af236c7fa4ae1738d
Project: http://git-wip-us.apache.org/repos/asf/apex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/apex-site/commit/62a203a6
Tree: http://git-wip-us.apache.org/repos/asf/apex-site/tree/62a203a6
Diff: http://git-wip-us.apache.org/repos/asf/apex-site/diff/62a203a6
Branch: refs/heads/asf-site
Commit: 62a203a666b62caabf9c1cf587e72edb58cff1f5
Parents: 10511d9
Author: Thomas Weise <th...@datatorrent.com>
Authored: Thu Jul 28 14:56:28 2016 -0700
Committer: Thomas Weise <th...@datatorrent.com>
Committed: Thu Jul 28 14:56:28 2016 -0700
----------------------------------------------------------------------
content/announcements.html | 4 +--
content/community.html | 4 +--
content/contributing.html | 4 +--
content/docs.html | 4 +--
content/downloads.html | 4 +--
content/index.html | 4 +--
content/maturity.html | 4 +--
content/people.html | 4 +--
content/powered-by-apex.html | 6 ++---
content/release.html | 56 ++++++++++++++++++++++++++++++++++++---
content/roadmap.html | 8 +++---
content/verification.html | 4 +--
12 files changed, 78 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/announcements.html
----------------------------------------------------------------------
diff --git a/content/announcements.html b/content/announcements.html
index c264636..c9ce0fc 100644
--- a/content/announcements.html
+++ b/content/announcements.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/community.html
----------------------------------------------------------------------
diff --git a/content/community.html b/content/community.html
index 67d5203..3c7524e 100644
--- a/content/community.html
+++ b/content/community.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/contributing.html
----------------------------------------------------------------------
diff --git a/content/contributing.html b/content/contributing.html
index bf75db3..2564f50 100644
--- a/content/contributing.html
+++ b/content/contributing.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/docs.html
----------------------------------------------------------------------
diff --git a/content/docs.html b/content/docs.html
index 40451fc..1865380 100644
--- a/content/docs.html
+++ b/content/docs.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/downloads.html
----------------------------------------------------------------------
diff --git a/content/downloads.html b/content/downloads.html
index 28ec80f..7616bdc 100644
--- a/content/downloads.html
+++ b/content/downloads.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/index.html
----------------------------------------------------------------------
diff --git a/content/index.html b/content/index.html
index 22554b7..b4e41e0 100644
--- a/content/index.html
+++ b/content/index.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/maturity.html
----------------------------------------------------------------------
diff --git a/content/maturity.html b/content/maturity.html
index 37c0e5e..52a79b5 100644
--- a/content/maturity.html
+++ b/content/maturity.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/people.html
----------------------------------------------------------------------
diff --git a/content/people.html b/content/people.html
index 9e920ee..75090c8 100644
--- a/content/people.html
+++ b/content/people.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/powered-by-apex.html
----------------------------------------------------------------------
diff --git a/content/powered-by-apex.html b/content/powered-by-apex.html
index f88fb98..7b81827 100644
--- a/content/powered-by-apex.html
+++ b/content/powered-by-apex.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
@@ -124,7 +124,7 @@
<li>ElasticSearch</li>
</ul>
<h2 id="universities-research-institutes">Universities & Research Institutes</h2>
-<p>Apache Apex is under reserach at</p>
+<p>Apache Apex is under research at</p>
<ul>
<li>University of California San Diego</li>
<li>Dresden University of Technology</li>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/release.html
----------------------------------------------------------------------
diff --git a/content/release.html b/content/release.html
index df7d545..8dffac8 100644
--- a/content/release.html
+++ b/content/release.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
@@ -158,7 +158,41 @@ gpg --yes --armor --output ${RNAME}-source-release.zip.asc --detach-sig ${RNAME}
<pre><code class="lang-bash">mkdir svn-dist && cp *-source-* svn-dist/
svn import svn-dist https://dist.apache.org/repos/dist/dev/apex/${RNAME}-RC1 -m "Apache Apex v${rv}-RC1"
</code></pre>
-<h2 id="voting">Voting</h2>
+<h2 id="build-and-deploy-documentation">Build and Deploy Documentation</h2>
+<p>The documentation will be generated as static HTML files and copied into the <code>apex-site</code> repository. It will be available at an alternate URL path until the release is promoted, at which time it will also be promoted to the main website location.</p>
+<p>Do the following setup steps before building and deploying the documentation. </p>
+<ol>
+<li><p>Clone the apex-site repository into a folder called <code>apex-site</code> at the same level as the current repository. </p>
+</li>
+<li><p>Set the following environment variables.</p>
+<p> For -core releases:</p>
+<pre><code> REPO_NAME=apex-core
+ DOC_NAME=apex
+</code></pre><p> For -malhar releases:</p>
+<pre><code> REPO_NAME=apex-malhar
+ DOC_NAME=malhar
+</code></pre><p> The <code>REPO_NAME</code> variable above should match the folder name of the cloned apex module being built.</p>
+</li>
+</ol>
+<p>To build and deploy the documentation, execute the following commands in the apex module folder specified in <code>REPO_NAME</code> above. <strong>Note</strong>: Until <a href="https://github.com/mkdocs/mkdocs/issues/859">mkdocs #859</a> is resolved and available for download, use mkdocs built against <a href="https://github.com/mkdocs/mkdocs">master</a>.</p>
+<pre><code class="lang-bash"># build docs, they would be generated in a site sub-folder
+mkdocs build --clean
+
+# Calculate the major.minor version
+docv=`echo ${rv} | sed 's/\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\)/\1\.\2/'`
+
+# copy docs from site folder into target folder on apex-site
+cd ../apex-site
+git checkout asf-site
+rm -rf docs/${DOC_NAME}-${docv}
+cp -r ../${REPO_NAME}/site docs/${DOC_NAME}-${docv}
+git add -A
+git commit -m "Adding ${DOC_NAME}-${rv} documentation"
+git push
+</code></pre>
+<p>The documentation is now accessible at the URL location below. For patch releases, however, the documentation changes will already reflect on the website.</p>
+<pre><code>https://apex.apache.org/docs/${DOC_NAME}-${docv}/
+</code></pre><h2 id="voting">Voting</h2>
<p>Vote call sample:
<a href="http://mail-archives.apache.org/mod_mbox/apex-dev/201605.mbox/%3CCAKJfLDPr3CBCfstQJWjchG-ZEYw5P%2Bwv5jN0tfy3EL%2BU%3DBUQgQ%40mail.gmail.com%3E">http://mail-archives.apache.org/mod_mbox/apex-dev/201605.mbox/%3CCAKJfLDPr3CBCfstQJWjchG-ZEYw5P%2Bwv5jN0tfy3EL%2BU%3DBUQgQ%40mail.gmail.com%3E</a></p>
<p>Vote result:
@@ -192,6 +226,22 @@ published libraries.</p>
git push apache
</code></pre>
<p>Merge <code>@since</code> tag and change log changes to <code>master</code>.</p>
+<h3 id="documentation">Documentation</h3>
+<p>There two steps in promotion. The documentation built during the build step above is made available on the website and then any changes to the rest of the website are deployed.</p>
+<ol>
+<li>If this is a new minor or a major release, under the <code>apex-site</code> folder, run the following commands to point the website to the release documentation folder, otherwise it is a patch release and this step can be skipped as the documentation is already reflected in the website.</li>
+</ol>
+<pre><code class="lang-bash"># docv major.minor version calculated in the build step
+cd docs
+# Set the release version to be the latest available version
+ln -nsf ${DOC_NAME}-${docv} ${DOC_NAME}
+git add -A
+git commit -m "Promoting ${DOC_NAME}-${docv} documentation"
+git push
+</code></pre>
+<ol>
+<li>Refer to the documentation in <a href="https://github.com/apache/apex-site#contributing">apex-site repository</a> to add any new links to the <a href="https://github.com/apache/apex-site/blob/master/src/md/docs.md">docs.md</a> page, follow the committer steps to commit and push these changes, and deploy the site.</li>
+</ol>
<h2 id="announce-release">Announce Release</h2>
<p>For minor or major release, publish the documentation to the web site prior to updating download page (which will automatically link the documentation). See <a href="https://github.com/apache/apex-core/tree/master/docs#deployment">https://github.com/apache/apex-core/tree/master/docs#deployment</a></p>
<p>Update the download page to reflect the new release: <a href="https://github.com/apache/apex-site#updating-downloads-page">https://github.com/apache/apex-site#updating-downloads-page</a></p>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/roadmap.html
----------------------------------------------------------------------
diff --git a/content/roadmap.html b/content/roadmap.html
index e89e35d..1ee8ecd 100644
--- a/content/roadmap.html
+++ b/content/roadmap.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>
@@ -305,7 +305,7 @@ http://mesos.apache.org/documentation/latest/fetcher/
<td>
<a target="_blank" href="https://issues.apache.org/jira/browse/APEXMALHAR-1811">APEXMALHAR-1811</a>
</td>
- <td title="Add new condition for non-equality join predicate (for example, user.zipcode != authzn.zipcode)">
+ <td title="Add new condition for non-equality join predicate (for example, user.zipcode != authzn.zipcode)">
Add Non-Equality Join Condition
</td>
<td>
@@ -347,7 +347,7 @@ So keep things sane - the proposed compromise is that we start creating smaller
</td>
<td title="ManagedState is described in the document below:
-https://docs.google.com/document/d/1gRWN9ufKSZSZD0N-pthlhpC9TZ8KwJ6hJlAX6nxl5f8/edit#heading=h.z87ti1fwyt0t">
+https://docs.google.com/document/d/1gRWN9ufKSZSZD0N-pthlhpC9TZ8KwJ6hJlAX6nxl5f8/edit#heading=h.z87ti1fwyt0t">
Large operator state management
</td>
<td>
http://git-wip-us.apache.org/repos/asf/apex-site/blob/62a203a6/content/verification.html
----------------------------------------------------------------------
diff --git a/content/verification.html b/content/verification.html
index be55fe2..c96c025 100644
--- a/content/verification.html
+++ b/content/verification.html
@@ -49,9 +49,9 @@
<li class="nav-item">
<a href="#" data-toggle="dropdown" class="dropdown-toggle nav-link">Source<b class="caret"></b></a>
<ul class="dropdown-menu">
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-core.git">Apex Core (ASF)</a></li>
<li><a href="https://github.com/apache/apex-core">Apex Core (Github Mirror)</a></li>
- <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
+ <li><a href="https://git-wip-us.apache.org/repos/asf?p=apex-malhar.git">Apex Malhar (ASF)</a></li>
<li><a href="https://github.com/apache/apex-malhar">Apex Malhar (Github Mirror)</a></li>
</ul>
</li>