[incubator-openwhisk-wskdeploy] branch master updated: Start a proper programming guide in markdown (#482)

[lz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lz1982 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-wskdeploy.git


The following commit(s) were added to refs/heads/master by this push:
     new e82ff9e  Start a proper programming guide in markdown (#482)
e82ff9e is described below

commit e82ff9edf18023b0c33c5e7211692fc2f0c9099c
Author: Matt Rutkowski <mr...@us.ibm.com>
AuthorDate: Wed Sep 13 20:28:45 2017 -0500

    Start a proper programming guide in markdown (#482)
    
    * Create programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update .gitignore
    
    * Create programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update programming_guide.md
    
    * Update .gitignore
---
 .gitignore                |  1 +
 docs/programming_guide.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/.gitignore b/.gitignore
index 539569c..dcf046a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -29,6 +29,7 @@ _testmain.go
 
 #binaries
 openwhisk-wskdeploy
+incubator-openwhisk-wskdeploy
 wskdeploy
 
 #GoGlanD IDE
diff --git a/docs/programming_guide.md b/docs/programming_guide.md
new file mode 100644
index 0000000..7003130
--- /dev/null
+++ b/docs/programming_guide.md
@@ -0,0 +1,35 @@
+# Whisk Deploy Tool by Example
+_A step-by-step guide for deploying Apache OpenWhisk applications using Package Manifest files._
+
+This guide, by example, will walk you through how to describe OpenWhisk applications using the OpenWhisk Packaging specification and deply them through the wskdeploy utility to any OpenWhisk Serverless provider.  
+
+It assumes that you have setup and can run the ```wskdeploy``` as described in the [project README](https://github.com/apache/incubator-openwhisk-wskdeploy#).  If so, then the utility will use the OpenWhisk APIHOST and AUTH variable values in your .wskprops file to attempt deployment.
+
+## Creating an OpenWhisk Package
+
+### Start with a Package Manifest (YAML) file
+The wskdeploy utility maninly uses a single file, that uses a YAML syntax, called a "Package Manifest", to describe all the OpenWhisk components that make up your OpenWhisk Package including Actions, Triggers, Rules, etc. 
+
+The minimal manifest file would include only a package declaration, a version number and a license for the package:
+```
+package:
+  name: helloworld
+  version: 1.0
+  license: Apache-2.0
+```
+
+Save this into a file called "manifest.yaml" in a directory of your choice.
+
+### Executing the wskdeploy utility
+
+Simply execute the wskdeploy binary against the directory you saved your "manifest.yaml" file in by pointing it to the package location using the ```-p``` flag.
+
+```
+$ wskdeploy -p <my_directory>
+```
+wskdeploy will automatically look for any file named "manifest.yaml" or "manifest.yml" in the directory it is pointed; however, the manifest file can be called anything as long as it has a .yaml or .yml extension and passed on the command line using the ```-m``` flag.
+
+For example, if you called your manifest "my_pkg_manifest.yml" you could simply provide the manifest file name as follows:
+```
+$ wskdeploy -p <my_directory> -m my_pkg_manifest.yaml
+```

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