You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by de...@apache.org on 2016/08/11 18:38:27 UTC

[1/2] incubator-systemml git commit: [SYSTEMML-856] Adding Gemfile back to the documentation.

Repository: incubator-systemml
Updated Branches:
  refs/heads/gh-pages 45c36a3ff -> b537736c3


[SYSTEMML-856] Adding Gemfile back to the documentation.


Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/97ffa414
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/97ffa414
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/97ffa414

Branch: refs/heads/gh-pages
Commit: 97ffa414e49b3a721b27695cbb8e2b1fe11eef9f
Parents: 45c36a3
Author: Mike Dusenberry <mw...@us.ibm.com>
Authored: Tue Aug 9 16:48:50 2016 -0700
Committer: Mike Dusenberry <mw...@us.ibm.com>
Committed: Tue Aug 9 16:49:29 2016 -0700

----------------------------------------------------------------------
 Gemfile | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/97ffa414/Gemfile
----------------------------------------------------------------------
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..b5d5550
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gem "jekyll"
+gem "rouge"
\ No newline at end of file


[2/2] incubator-systemml git commit: [SYSTEMML-857][SYSTEMML-858] Release process for docs and version

Posted by de...@apache.org.
[SYSTEMML-857][SYSTEMML-858] Release process for docs and version

Describe release process for documentation.
Update documentation version in _config.yml.
Add version number to global documentation header.

Closes #208.


Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/b537736c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/b537736c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/b537736c

Branch: refs/heads/gh-pages
Commit: b537736c3ad0e3e12c4724b523a98145368ac7c0
Parents: 97ffa41
Author: Deron Eriksson <de...@us.ibm.com>
Authored: Thu Aug 11 11:33:05 2016 -0700
Committer: Deron Eriksson <de...@us.ibm.com>
Committed: Thu Aug 11 11:33:05 2016 -0700

----------------------------------------------------------------------
 _config.yml          |  2 +-
 _layouts/global.html |  7 +++++--
 css/main.css         | 20 ++++++++++++++++++++
 release-process.md   | 39 ++++++++++++++++++++++++++++++++++++++-
 4 files changed, 64 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/b537736c/_config.yml
----------------------------------------------------------------------
diff --git a/_config.yml b/_config.yml
index cb6d6c7..1a09658 100644
--- a/_config.yml
+++ b/_config.yml
@@ -11,7 +11,7 @@ include:
   - _modules
 
 # These allow the documentation to be updated with newer releases
-SYSTEMML_VERSION: 0.9.0-incubating
+SYSTEMML_VERSION: 0.11.0
 
 # if 'analytics_on' is true, analytics section will be rendered on the HTML pages
 analytics_on: true

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/b537736c/_layouts/global.html
----------------------------------------------------------------------
diff --git a/_layouts/global.html b/_layouts/global.html
index 3527421..71a151f 100644
--- a/_layouts/global.html
+++ b/_layouts/global.html
@@ -24,9 +24,12 @@
         <header class="navbar navbar-default navbar-fixed-top" id="topbar">
             <div class="container">
                 <div class="navbar-header">
-                    <div class="navbar-brand brand">
+                    <div class="navbar-brand brand projectlogo">
                         <img class="logo" src="img/systemml-logo.png" alt="Apache SystemML (incubating)" title="Apache SystemML (incubating)"/>
-                        <a href="index.html">Apache SystemML (incubating)<!-- {{site.SYSTEMML_VERSION}}  --></a>
+                    </div>
+                    <div class="navbar-brand brand projecttitle">
+                        <a href="index.html">Apache SystemML (incubating)</a><br/>
+                        <span class="version">{{site.SYSTEMML_VERSION}}</span>
                     </div>
                     <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
                         <span class="sr-only">Toggle navigation</span>

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/b537736c/css/main.css
----------------------------------------------------------------------
diff --git a/css/main.css b/css/main.css
index 684ee3c..27bfe0d 100644
--- a/css/main.css
+++ b/css/main.css
@@ -68,6 +68,26 @@ img.logo {
   color: #555555;
 }
 
+.navbar .version {
+  color: #fff;
+  font-size: 12px;
+  font-weight: bold;
+  line-height: 20px;
+  margin: 0;
+  padding: 0 0 0 2px;
+  vertical-align: bottom;
+}
+
+.navbar .projecttitle {
+  margin-top: 10px;
+  height: 40px;
+  white-space: nowrap;
+}
+
+.navbar .projectlogo {
+  width: 75px;
+}
+
 /* Dropdown menu */
 .dropdown-menu {
   /* Remove the default 2px top margin which causes a small

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/b537736c/release-process.md
----------------------------------------------------------------------
diff --git a/release-process.md b/release-process.md
index ed78a32..cd6299d 100644
--- a/release-process.md
+++ b/release-process.md
@@ -26,9 +26,28 @@ limitations under the License.
 * This will become a table of contents (this text will be scraped).
 {:toc}
 
+
 # Release Candidate Build and Deployment
 
-To be written.
+To be written. (Describe how the release candidate is built, including checksums. Describe how
+the release candidate is deployed to servers for review.)
+
+
+## Release Documentation
+
+The `SYSTEMML_VERSION` value in docs/_config.yml should be updated to the correct release version. The documentation
+site should be built.
+The SystemML documentation site should be deployed to a docs version folder within the main website project (using
+svn). As an example, the documentation site for SystemML version 0.11.0 should be available
+at http://systemml.apache.org/docs/0.11.0.
+
+The Javadocs should be generated for the project and should be deployed to a docs version folder, such as
+http://systemml.apache.org/docs/0.11.0/api/java. Any other docs, such as Scaladocs if they are available, should
+be deployed to corresponding locations. Note that the version number specified in the Javadocs is determined by the project
+version number in the project pom.xml file.
+
+Additionally, the Javadocs should be deployed to http://systemml.apache.org/docs/latest/api/java
+if the Javadocs have not already been deployed to this location.
 
 
 # Release Candidate Checklist
@@ -276,3 +295,21 @@ For examples, see the [Spark MLContext Programming Guide](http://apache.github.i
 
 Verify that the performance suite located at scripts/perftest/ executes on Spark and Hadoop. Testing should
 include 80MB, 800MB, 8GB, and 80GB data sizes.
+
+
+# Voting
+
+Following a successful release candidate vote by SystemML PMC members on the SystemML mailing list, the release candidate
+is voted on by Incubator PMC members on the general incubator mailing list. If this vote succeeds, the release candidate
+has been approved.
+
+
+# Release
+
+
+## Release Deployment
+
+To be written. (What steps need to be done? How is the release deployed to the central maven repo? What updates need to
+happen to the main website, such as updating the Downloads page? Where do the release notes for the release go?)
+
+