You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by bu...@apache.org on 2016/04/30 21:31:27 UTC
svn commit: r987173 [2/2] - in /websites/staging/streams/trunk/content: ./
site/0.3-incubating-SNAPSHOT/streams-master/
site/0.3-incubating-SNAPSHOT/streams-master/tutorial/
Modified: websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/website.html
==============================================================================
--- websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/website.html (original)
+++ websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/website.html Sat Apr 30 19:31:26 2016
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7 at 2016-04-29
+ | Generated by Apache Maven Doxia Site Renderer 1.7 at 2016-04-30
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20160429" />
+ <meta name="Date-Revision-yyyymmdd" content="20160430" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Streams :: streams-master – Website Management</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -118,7 +118,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Projects <b class="caret"></b></a>
<ul class="dropdown-menu">
- <li> <a href="" title="streams-master">streams-master</a>
+ <li> <a href="../../latest/streams-master" title="streams-master">streams-master</a>
</li>
<li> <a href="../../latest/streams-project" title="streams-project">streams-project</a>
@@ -158,7 +158,7 @@
<li> <a href="../../latest/streams-project/streams-pojo/index.html" title="View the official Apache Streams jsonschema files">View the official Apache Streams jsonschema files</a>
</li>
- <li> <a href="../../latest/streams-project/streams-contrib/streams-pojo/apidocs/index.html" title="View java POJOs generated from the official Apache Streams jsonschema files">View java POJOs generated from the official Apache Streams jsonschema files</a>
+ <li> <a href="../../latest/streams-project/streams-pojo/apidocs/org/apache/streams/pojo/json/package-summary.html" title="View java POJOs generated from the official Apache Streams jsonschema files">View java POJOs generated from the official Apache Streams jsonschema files</a>
</li>
<li> <a href="../../latest/streams-examples/index.html" title="Check out some additional examples">Check out some additional examples</a>
@@ -251,7 +251,7 @@
<div class="section">
<h2><a name="Website_Management"></a>Website Management</h2>
-<p><a class="externalLink" href="http://streams.incubator.apache.org">http://streams.incubator.apache.org</a> is a set of interconnected websites generated by the maven site plugin. The front page, this page, and most pages linked in the top nav of the site are part of incubator-streams-master.</p>
+<p><a class="externalLink" href="http://streams.incubator.apache.org">http://streams.incubator.apache.org</a> is a set of interconnected websites generated by the maven site plugin. The front page, this page, and most pages linked in the top nav of the site are part of incubator-streams-master. incubator-streams and incubator-streams-examples also contain documentation of specific modules and examples that are part of the project webpage.</p>
<div class="section">
<h3><a name="Website_Content"></a>Website Content</h3>
<p>Pages, diagrams, and other hard-linkable resources are stored throughout the source tree.</p>
@@ -288,11 +288,11 @@
<div class="section">
<h3><a name="Website_Updates"></a>Website Updates</h3>
<p>The project website(s) are hosted by the Apache foundation and updated via SVN.</p>
-<p>Currently pushing website changes is a manual process performed by whomever is making the change.</p>
+<p>Currently pushing website changes is a manual process with several steps, performed by whomever is making the change.</p>
<p>This typically requires checking out the current website from SVN.</p>
<div class="source">
-<div class="source"><pre class="prettyprint">svn co https://svn.apache.org/repos/infra/websites/production/streams/content
+<div class="source"><pre class="prettyprint">svn co https://svn.apache.org/repos/asf/incubator/streams/site/trunk/content
cd content
</pre></div></div>
<p>NOTE:</p>
@@ -340,9 +340,13 @@ mkdir site/${project.version}/${project.
svn add site/${project.version}/${project.artifactId}
svn commit -m "svn add site/${project.version}/${project.artifactId}"
</pre></div></div>
-<p>The folder must exist and be empty for the publish steps to succeed.</p></div>
+<p>The folder must exist and be empty for the publish steps to succeed.</p>
+<p>If you are publishing a release, it’s appropriate to delete the site snapshots related to the prior releases.</p>
+<p>For example when 0.3-incubating is published, 0.2-incubating-SNAPSHOT should be deleted.</p>
+<p>This policy of removing old snapshots keeps external projects from linking to snapshot artifacts indefinitely.</p>
+<p>Release artifacts should be retained indefinitely.</p></div>
<div class="section">
-<h4><a name="Generating_and_publishing_a_new_website_version"></a>Generating and publishing a new website version</h4>
+<h4><a name="Generating_and_committing_a_new_website_version"></a>Generating and committing a new website version</h4>
<p>The instructions below presume:</p>
<ul>
@@ -378,58 +382,66 @@ svn commit -m "svn add site/${proje
<p>Finally, publish the site.</p>
<div class="source">
-<div class="source"><pre class="prettyprint">mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/infra/websites/production/streams/content/site/${project.version}/${project.artifactId}
+<div class="source"><pre class="prettyprint">mvn scm-publish:publish-scm -Dscmpublish.pubScmUrl=scm:svn:https://svn.apache.org/repos/asf/incubator/streams/site/trunk/content/site/${project.version}/${project.artifactId}
</pre></div></div>
<p>You may need to provide -Dscmpublish.content= depending where the staging site directory winds up under target/</p>
-<p>Note the revision number checked in at the bottom of the maven logs.</p>
-<p>You should now be able to access the published site(s) via an absolute URL such as <a class="externalLink" href="http://streams.incubator.apache.org/site/${project.version}/${project.artifactId">http://streams.incubator.apache.org/site/${project.version}/${project.artifactId</a>}</p>
-<p>For example, website documentation from a recent release:</p>
+<p>Note the revision number checked in at the bottom of the maven logs.</p></div>
+<div class="section">
+<h4><a name="Updating_the_staging_site"></a>Updating the staging site</h4>
+<p>Next step is to update the staging site and check it out.</p>
+<p>Log into <a class="externalLink" href="https://cms.apache.org">https://cms.apache.org</a> with your apache credentials.</p>
+<p>Use <a class="externalLink" href="https://cms.apache.org/streams">https://cms.apache.org/streams</a> to access the streams website.</p>
+<p>Typically you can use Get streams Working Copy, although you might need to Force if you run into conflicts in SVN.</p>
+<p>You’ll probably need to ‘Update this directory’ if you want to inspect the changes you committed above.</p>
+<p>‘View Staging Builds’ should show a build around the time of the previous commit. This means the change has been staged.</p>
+<p>You should now be able to access and review the published site(s) via the staging URL:</p>
<ul>
-<li><a class="externalLink" href="http://streams.incubator.apache.org/site/0.2-incubating/streams-project/index.html">http://streams.incubator.apache.org/site/0.2-incubating/streams-project/index.html</a></li>
+<li><a class="externalLink" href="http://streams.staging.apache.org/">http://streams.staging.apache.org/</a></li>
</ul>
-<p>Some recent snapshots:</p>
+<p>At this point use explicit versions to access and review the new documentation, i.e.</p>
<ul>
-<li><a class="externalLink" href="http://streams.incubator.apache.org/site/0.3-incubating-SNAPSHOT/streams-master/index.html">http://streams.incubator.apache.org/site/0.3-incubating-SNAPSHOT/streams-master/index.html</a></li>
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-master/index.html">http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-master/index.html</a></li>
-<li><a class="externalLink" href="http://streams.incubator.apache.org/site/0.3-incubating-SNAPSHOT/streams-project/index.html">http://streams.incubator.apache.org/site/0.3-incubating-SNAPSHOT/streams-project/index.html</a></li>
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-project/index.html">http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-project/index.html</a></li>
-<li><a class="externalLink" href="http://streams.incubator.apache.org/site/0.2-incubating-SNAPSHOT/streams-examples/index.html">http://streams.incubator.apache.org/site/0.2-incubating-SNAPSHOT/streams-examples/index.html</a></li>
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-examples/index.html">http://streams.staging.apache.org/site/0.3-incubating-SNAPSHOT/streams-examples/index.html</a></li>
</ul></div>
<div class="section">
-<h4><a name="Promoting_a_new_website_version"></a>Promoting a new website version</h4>
-<p>New release or snapshots are immediately published, but visitors to the website won’t arrive there from standard links and navigation until it has been fully promoted.</p>
-<p>The instructions below presume:</p>
-
-<ul>
-
-<li>you have a shell open in the SVN content directory</li>
-
-<li>you know the artifactId and version of the repository you want to publish.</li>
-</ul>
-<p>The convention in place exposes the latest specific site version(s) using redirects maintained in the .htaccess file of project website SVN.</p>
-<p>This file can be edited from <a class="externalLink" href="https://cms.apache.org/streams/">https://cms.apache.org/streams/</a></p>
-<p>First, click ‘Get streams Working Copy’</p>
-<p>Next, open .htaccess</p>
-<p>If you are promoting sites from all streams repositories simultaneously, the file should end with:</p>
+<h4><a name="Managing_version_pointers"></a>Managing version pointers</h4>
+<p>When new versions of these sites are built for the first time, an additional set to alter Apache rules may be appropriate.</p>
+<p>The convention we use exposes the latest specific site version(s) using redirects maintained in the .htaccess file of project website SVN.</p>
+<p>These rules are located in the ‘.htaccess’ file in the root of the SVN content directory and looks something like this:</p>
<div class="source">
-<div class="source"><pre class="prettyprint">Redirect /site/latest/ /site/${project.version}
-</pre></div></div>
-<p>If you want to expose sites hosted under different versions across streams repositories:</p>
-
-<div class="source">
-<div class="source"><pre class="prettyprint">Redirect /site/latest/streams-master /site/0.3-incubating-SNAPSHOT/streams-master
-Redirect /site/latest/streams-project /site/0.2-incubating/streams-project
+<div class="source"><pre class="prettyprint">Options +FollowSymLinks
+RewriteEngine on
+RedirectMatch "^/$" "/site/0.3-incubating-SNAPSHOT/streams-master"
+Redirect /site/latest /site/0.3-incubating-SNAPSHOT
+Redirect /site/latest/streams-master /site/0.3-incubating-SNAPSHOT/streams-master
+Redirect /site/latest/streams-project /site/0.3-incubating-SNAPSHOT/streams-project
Redirect /site/latest/streams-examples /site/0.3-incubating-SNAPSHOT/streams-examples
</pre></div></div>
-<p>Commit your changes.</p>
-<p>Wait a few seconds and click Follow Staging Build.</p>
-<p>You should see a new build with a ‘Build Successful’ message.</p>
-<p>Open a new tab and visit <a class="externalLink" href="http://streams.staging.apache.org">http://streams.staging.apache.org</a> for one last check before go-live.</p></div></div></div>
+<p>Adjust the Redirect rules as appropriate for the project and version you are deploying. You can do this directly from the CMS.</p>
+<p>Commit your changes, wait a few seconds, click Follow Staging Build, and you should see a new build with a ‘Build Successful’ message.</p>
+<p>You should now be able to use ‘latest’ as an alias for the docs you are deploying, i.e.</p>
+
+<ul>
+
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/latest/streams-master/index.html">http://streams.staging.apache.org/site/latest/streams-master/index.html</a></li>
+
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/latest/streams-project/index.html">http://streams.staging.apache.org/site/latest/streams-project/index.html</a></li>
+
+<li><a class="externalLink" href="http://streams.staging.apache.org/site/latest/streams-examples/index.html">http://streams.staging.apache.org/site/latest/streams-examples/index.html</a></li>
+</ul></div>
+<div class="section">
+<h4><a name="Promoting_a_new_website_version"></a>Promoting a new website version</h4>
+<p>All that’s left at this point is to promote from staging to production.</p>
+<p>If a release is happening, this should happen just prior to the release announcement.</p>
+<p>If you are just updating content associated with a snapshot, use good judgement to determine whether the list should have a chance to review and/or vote on the changes in staging prior to promotion.</p></div></div></div>
</div>
</div>
@@ -441,7 +453,7 @@ Redirect /site/latest/streams-examples /
<p >Copyright © 2012–2016
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.
- <li id="publishDate" class="pull-right">Last Published: 2016-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2016-04-30</li>
<li id="projectVersion" class="pull-right">
Version: 0.3-incubating-SNAPSHOT
</li>
Modified: websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/who.html
==============================================================================
--- websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/who.html (original)
+++ websites/staging/streams/trunk/content/site/0.3-incubating-SNAPSHOT/streams-master/who.html Sat Apr 30 19:31:26 2016
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7 at 2016-04-29
+ | Generated by Apache Maven Doxia Site Renderer 1.7 at 2016-04-30
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20160429" />
+ <meta name="Date-Revision-yyyymmdd" content="20160430" />
<meta http-equiv="Content-Language" content="en" />
<title>Apache Streams :: streams-master – Who uses activity streams?</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -118,7 +118,7 @@
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Projects <b class="caret"></b></a>
<ul class="dropdown-menu">
- <li> <a href="" title="streams-master">streams-master</a>
+ <li> <a href="../../latest/streams-master" title="streams-master">streams-master</a>
</li>
<li> <a href="../../latest/streams-project" title="streams-project">streams-project</a>
@@ -158,7 +158,7 @@
<li> <a href="../../latest/streams-project/streams-pojo/index.html" title="View the official Apache Streams jsonschema files">View the official Apache Streams jsonschema files</a>
</li>
- <li> <a href="../../latest/streams-project/streams-contrib/streams-pojo/apidocs/index.html" title="View java POJOs generated from the official Apache Streams jsonschema files">View java POJOs generated from the official Apache Streams jsonschema files</a>
+ <li> <a href="../../latest/streams-project/streams-pojo/apidocs/org/apache/streams/pojo/json/package-summary.html" title="View java POJOs generated from the official Apache Streams jsonschema files">View java POJOs generated from the official Apache Streams jsonschema files</a>
</li>
<li> <a href="../../latest/streams-examples/index.html" title="Check out some additional examples">Check out some additional examples</a>
@@ -306,7 +306,7 @@
<p >Copyright © 2012–2016
<a href="http://www.apache.org/">The Apache Software Foundation</a>.
All rights reserved.
- <li id="publishDate" class="pull-right">Last Published: 2016-04-29</li>
+ <li id="publishDate" class="pull-right">Last Published: 2016-04-30</li>
<li id="projectVersion" class="pull-right">
Version: 0.3-incubating-SNAPSHOT
</li>