Merge pull request #402 from IBM-Swift/develop

Documentation and configuration file updates

Author: tfrank64

BluePic-OpenWhisk/local.env

@@ -4,8 +4,8 @@ export CLOUDANT_password=
 export CLOUDANT_host=
 export CLOUDANT_db=
 
-# From Alchemy service
-export ALCHEMY_key=
+# From Watson Visual Recognition
+export VISUAL_key=
 
 # From Weather Insights service
 export WEATHER_username=

Cloud-Scripts/populator.sh

@@ -19,4 +19,4 @@
 cloudantFolder=`cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd`/cloudantNoSQLDB
 objectStorageFolder=`cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd`/Object-Storage
 $cloudantFolder/populator.sh --username=<cloudant username> --password=<cloudant password> --projectId=<object storage projectId>
-$objectStorageFolder/populator.sh --userId=<object storage username> --password=<object storage password> --projectId=<object storage projectId> --region<object storage region>
+$objectStorageFolder/populator.sh --userId=<object storage username> --password=<object storage password> --projectId=<object storage projectId> --region=<object storage region>

Docs/OpenWhisk.md

@@ -1,17 +1,15 @@
 # Setup OpenWhisk
-1) Create an OpenWhisk account on the [Welcome to Bluemix OpenWhisk](https://new-console.ng.bluemix.net/openwhisk/) page.
+1. Download and install the [OpenWhisk CLI](https://new-console.ng.bluemix.net/openwhisk/cli) zip with an executable inside. Once downloaded, unzip the file and either start using the `wsk` command right there or add the wsk executable to your `PATH`. Then set your OpenWhisk API host and auth key as mentioned in step 2 of the "Configure CLI" page.
 
-2) Download and install the [OpenWhisk CLI](https://new-console.ng.bluemix.net/openwhisk/cli) zip with an executable inside. Once downloaded, unzip the file and either start using the `wsk` command right there or add the wsk executable to your `PATH`. Then set your OpenWhisk API host and auth key as mentioned in step 2 of the "Configure CLI" page.
+2. On that same [OpenWhisk CLI](https://new-console.ng.bluemix.net/openwhisk/cli) page, you can find the values needed to populate the [properties.json](../BluePic-Server/properties.json) file under the `Bluepic-Server` directory.
 
-3) On that same [OpenWhisk CLI](https://new-console.ng.bluemix.net/openwhisk/cli) page, you can find the values needed to populate the [properties.json](../BluePic-Server/properties.json) file under the `Bluepic-Server` directory.
-
-1. In step 2 on the "OpenWhisk - Configure CLI" page, you will see a command that looks similar to:
+3. In step 2 on the "OpenWhisk - Configure CLI" page, you will see a command that looks similar to:
 
     `wsk property set --apihost <hostName> --auth <authKey>`
 
-2. Take the value after `--apihost` and put it as the `hostName` value in `properties.json`.
+4. Take the value after `--apihost` and put it as the `hostName` value in `properties.json`.
 
-3. Next, insert a namespace value within the existing `urlPath` value in `properties.json`. In the `<namespace>` spot to be exact:
+5. Next, insert a namespace value within the existing `urlPath` value in `properties.json`. In the `<namespace>` spot to be exact:
 `"/api/v1/namespaces/<namespace>/actions/bluepic/processImage?blocking=false"`
 You can find this value at the top of the Bluemix UI, it will be a combination of the org and the space name, for example: `swiftdo%40us.ibm.com_dev`. Where our email is the org name, and `dev` is the space name.
 

README.md

@@ -61,7 +61,7 @@ If you'd like to, you can spend a few minutes to get familiar with the folder st
 ### 3. Create BluePic application on Bluemix
 Clicking on the button below deploys the BluePic application to Bluemix. The [`manifest.yml`](manifest.yml) file [included in the repo] is parsed to obtain the name of the application and to determine the Cloud Foundry services that should be instantiated. For further details on the structure of the `manifest.yml` file, see the [Cloud Foundry documentation](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html#minimal-manifest). After clicking the button below, you will be able to name your application, keep in mind that your Bluemix application name needs to match the name value in your `manifest.yml`. Therefore, you may have to change the name value in your `manifest.yml` if there is a naming conflict in your Bluemix account.
 
-[![Deploy to Bluemix](https://deployment-tracker.mybluemix.net/stats/c45eeb765e77bf2bffd747e8d910e37d/button.svg)](https://bluemix.net/deploy?repository=https://github.com/IBM-Swift/BluePic.git)
+[![Deploy to Bluemix](https://deployment-tracker.mybluemix.net/stats/c45eeb765e77bf2bffd747e8d910e37d/button.svg)](https://bluemix.net/deploy?repository=https://github.com/IBM-Swift/BluePic.git&cm_mmc=github-code-_-native-_-bluepic-_-deploy2bluemix)
 
 Once deployment to Bluemix is completed, you should access the route assigned to your application using the web browser of your choice. You should see the Kitura welcome page!
 
@@ -120,6 +120,8 @@ You can find your region in multiple ways. For instance, by just looking at the
 ## Optional features to configure
 This section describes the steps to take in order to leverage Facebook authentication with App ID, Push Notifications, and OpenWhisk.
 
+*API endpoints in BluePic-Server are currently not protected due to dependency limitations, but they will be as soon as that functionality is availalbe with the Kitura and App ID SDKs*
+
 ### 1. Create an application instance on Facebook
 In order to have the app authenticate with Facebook, you must create an application instance on Facebook's website.