cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pdion...@apache.org
Subject [5/6] cloudstack-cloudmonkey git commit: Update contribution howto, add Docker howto
Date Sat, 04 Jul 2015 12:41:46 GMT
Update contribution howto, add Docker howto

Signed-off-by: pdion891 <pdion891@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/commit/7b21d1d6
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/tree/7b21d1d6
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/diff/7b21d1d6

Branch: refs/heads/master
Commit: 7b21d1d685d6fbfa06a8271711f8f198c65fed73
Parents: f0b840a
Author: Pierre-Luc Dion <pdion891@apache.org>
Authored: Mon Jun 29 07:09:36 2015 -0400
Committer: pdion891 <pdion891@apache.org>
Committed: Sat Jul 4 08:27:51 2015 -0400

----------------------------------------------------------------------
 README.md | 52 +++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 37 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack-cloudmonkey/blob/7b21d1d6/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index cf31ea3..fc1fec8 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,33 @@ with Apache CloudStack 4.0-incubating and above.
 
 ![version badge](https://badge.fury.io/py/cloudmonkey.png) ![download badge](http://img.shields.io/pypi/dm/cloudmonkey.png)
 
+
+### For users
+
+Install:
+
+    $ pip install cloudmonkey
+
+Upgrade:
+
+    $ pip install --upgrade cloudmonkey
+
+Please see the [CloudMonkey Wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+cloudmonkey+CLI)
for usage.
+
+
+### Using Docker image
+
+Use with CloudStack managemenent server as container: 
+
+    $ docker run -ti --rm --link cloudstack:8080 docker.io/cloudstack/cloudmonkey
+
+Use your own CloudMonkey configuration file:
+
+    $ docker run -ti --rm -v `pwd`/.cloudmonkey:/cloudmonkey docker.io/cloudstack/cloudmonkey
+
+
+### Build
+
 All:
 
     Cleans and then builds with precache
@@ -36,17 +63,6 @@ Install:
 
     $ make install
 
-### For users
-
-Install:
-
-    $ pip install cloudmonkey
-
-Upgrade:
-
-    $ pip install --upgrade cloudmonkey
-
-Please see the [CloudMonkey Wiki](https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+cloudmonkey+CLI)
for usage.
 
 ### Mailing lists
 
@@ -60,14 +76,20 @@ Please see the [CloudMonkey Wiki](https://cwiki.apache.org/confluence/display/CL
 
 [Marketing Mailing List](mailto:marketing-subscribe@cloudstack.apache.org)
 
-### Contributing
 
-Send your patches on Apache [Review Board](https://reviews.apache.org/groups/cloudstack/)
-for CloudStack CloudMonkey.
+### Contributing
 
-Discuss features development on the `Dev` mailing lists.
+Discuss features development on the [Development Mailing List](mailto:dev-subscribe@cloudstack.apache.org).
 Report issues on the `User` mailing list and open issue on [JIRA](http://issues.apache.org/jira/browse/CLOUDSTACK).
 
+1. Fork the repository on Github
+2. Create a named feature branch (like `add_component_x`)
+3. Write your change
+4. Write tests for your change (if applicable)
+5. Run the tests, ensuring they all pass
+6. Submit a Pull Request using Github
+
+
 ### License
 
 Licensed to the Apache Software Foundation (ASF) under one


Mime
View raw message