You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ja...@apache.org on 2017/10/11 19:09:37 UTC

samza git commit: SAMZA-1409; add missing parts and make guideline clearer for docs/README.md

Repository: samza
Updated Branches:
  refs/heads/master a47ed9d18 -> 24170389c


SAMZA-1409; add missing parts and make guideline clearer for docs/README.md

Author: Fred Ji <ha...@gmail.com>

Reviewers: Jagadish <ja...@apache.org>

Closes #288 from fredji97/master_docs_readme


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

Branch: refs/heads/master
Commit: 24170389cbd04f6f39724fd6e786a2abc655a19c
Parents: a47ed9d
Author: Fred Ji <ha...@gmail.com>
Authored: Wed Oct 11 12:09:33 2017 -0700
Committer: Jagadish <jv...@linkedin.com>
Committed: Wed Oct 11 12:09:33 2017 -0700

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


http://git-wip-us.apache.org/repos/asf/samza/blob/24170389/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 1884405..21a4991 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -68,26 +68,26 @@ Following can be done when updating the gradle.properties file
 
 1. in x.x.x branch,
 
-    * modify the docs/_config.yml to make both the "version" and "latest-release" properties to x.x.x
+    * if this is a major release, modify the docs/_config.yml to make both the "version" and "latest-release" properties to x.x.x
 
     * remove "git checkout latest" line and the "-SNAPSHOT" version suffix in each of the tutorials
       * docs/startup/hello-samza/versioned/index.md
       * docs/learn/tutorials/versioned/hello-samza-high-level-code.md
       * docs/learn/tutorials/versioned/hello-samza-high-level-yarn.md
       * docs/learn/tutorials/versioned/hello-samza-high-level-zk.md
+      * docs/learn/tutorials/versioned/samza-rest-getting-started.md
 
 2. in master branch,
 
-    * modify the docs/_config.yml to make the "latest-release" to x.x.x
+    * if this is a major release, modify the docs/_config.yml to make the "latest-release" to x.x.x
 
-    * add the x.x.x release to Archive category in docs/_layouts/default.html and x.x.x release part in docs/archive/index.html
+    * if this is a major release, add the x.x.x release to Archive category in docs/_layouts/default.html and x.x.x release part in docs/archive/index.html
 
     * update the download page to use x.x.x release
       * docs/startup/download/index.md
 
     * update the version number in "tar -xvf ./target/hello-samza-y.y.y-dist.tar.gz -C deploy/samza" in each of the tutorials (and search for other uses of version x.x.x which may need to be replaced with y.y.y)
       * docs/startup/hello-samza/versioned/index.md
-      * docs/learn/tutorials/versioned/hello-samza-high-level-code.md
       * docs/learn/tutorials/versioned/hello-samza-high-level-yarn.md
       * docs/learn/tutorials/versioned/hello-samza-high-level-zk.md
       * docs/learn/tutorials/versioned/samza-rest-getting-started.md