geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aba...@apache.org
Subject [geode-examples] branch develop updated: Changes to Readmes
Date Mon, 16 Oct 2017 23:16:58 GMT
This is an automated email from the ASF dual-hosted git repository.

abaker pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-examples.git


The following commit(s) were added to refs/heads/develop by this push:
     new e55efcc  Changes to Readmes
e55efcc is described below

commit e55efcc773802e231fedc1e462ecc189caa7b63c
Author: Alexander Murmann <amurmann@pivotal.io>
AuthorDate: Tue Oct 10 10:09:29 2017 -0700

    Changes to Readmes
    
    * Address how to add more examples add the end of the readme. The target
    audience of the readme is looking at this to learn about Geode rather
    than contribute examples.
    * Fix gfsh command in partitiones region
---
 README.md             | 36 ++++++++++++++++++------------------
 partitioned/README.md |  4 ++--
 2 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 507da4d..46bf24e 100644
--- a/README.md
+++ b/README.md
@@ -26,24 +26,6 @@ Contributions<sup>[2]</sup> and corrections are welcome. Please
talk to us
 about your suggestions at [dev@geode.apache.org](mailto:dev@geode.apache.org)
 or submit a [pull request](https://github.com/apache/geode/pull/new/develop).
 
-## Adding a new example
-
-Follow this approach to add a new example:
-
-* Create a subdirectory with a descriptive name like `cache-writer`
-* Create a `README.md` file in the example subproject to walk the user through the tutorial
-* Create a Java class with a main method in the `org.apache.geode.examples.$name.Example`
class
-* Create a cluster initialization script in `scripts/start.gfsh`
-* Create a cluster shutdown script in `scripts/stop.gfsh`
-
-The scripts should contain `gfsh` commands for starting locators, servers, and
-creating regions--everything that the example program will need to use.  Where
-appropriate you should also add unit tests.  To customize the build you can add
-a `build.gradle` file.
-
-Note that the build may fail if you do not add ASF license headers or use the
-correct formatting (you can fix formatting with `gradle spotlessApply`).
-
 ## Running an example
 
 The gradle build will automatically download and install a Geode release in the
@@ -118,6 +100,24 @@ an integration with other projects.
 *  Memcached
 *  Spark Connector
 
+## Adding a new example
+
+Follow this approach to add a new example:
+
+* Create a subdirectory with a descriptive name like `cache-writer`
+* Create a `README.md` file in the example subproject to walk the user through the tutorial
+* Create a Java class with a main method in the `org.apache.geode.examples.$name.Example`
class
+* Create a cluster initialization script in `scripts/start.gfsh`
+* Create a cluster shutdown script in `scripts/stop.gfsh`
+
+The scripts should contain `gfsh` commands for starting locators, servers, and
+creating regions--everything that the example program will need to use.  Where
+appropriate you should also add unit tests.  To customize the build you can add
+a `build.gradle` file.
+
+Note that the build may fail if you do not add ASF license headers or use the
+correct formatting (you can fix formatting with `gradle spotlessApply`).
+
 ## References
 
 - [1]  [https://cwiki.apache.org/confluence/display/GEODE/Criteria+for+Code+Submissions](https://cwiki.apache.org/confluence/display/GEODE/Criteria+for+Code+Submissions)
diff --git a/partitioned/README.md b/partitioned/README.md
index 6334ce1..7ec66fb 100644
--- a/partitioned/README.md
+++ b/partitioned/README.md
@@ -56,7 +56,7 @@ will also be retrieved from the region and printed to the console.
 
         $ gfsh
         ...
-        gfsh>connect --locators=127.0.0.1[10334]
+        gfsh>connect --locator=127.0.0.1[10334]
         gfsh>query --query="select e.key from /example-region.entries e"
         ...
 
@@ -91,7 +91,7 @@ will also be retrieved from the region and printed to the console.
 
         $ gfsh
         ...
-        gfsh>connect --locators=127.0.0.1[10334]
+        gfsh>connect --locator=127.0.0.1[10334]
         gfsh>stop server --name=server1
 
 6. Run the query a second time, and notice that all the entries hosted on

-- 
To stop receiving notification emails like this one, please contact
['"commits@geode.apache.org" <commits@geode.apache.org>'].

Mime
View raw message