Restructure Parameters Docs

lornajane commented 6 years ago

I'm a fairly experienced IBM Cloud Functions user (also IBM Developer Advocate) but today I really struggled to find the instructions on adding credentials for my existing IBM Cloud data stores to OpenWhisk that I knew had been recently added. The information I needed was:

how to bind a service to an action, which is under CLI setup https://console.bluemix.net/docs/openwhisk/bluemix_cli.html#cli_bind
how to handle parameters in general (because binding a service is actually doing some special parameter setting) which is in the JavaScript actions section https://console.bluemix.net/docs/openwhisk/openwhisk_actions.html#creating-and-invoking-javascript-actions - then scroll down to "Pass parameters to an action"

I suggest that we break out these bits of documentation and make a first-class "Parameters" section, so everything is in one place, and that we also extend it to describe packages and parameters (do we have this? I couldn't find it). I'm happy to make these changes and offer a Pull Request if anyone thinks it might be worth doing.

lornajane commented 6 years ago

Any interest in this? If not, no worries

jpkessle commented 6 years ago

@lornajane - Thanks for the feedback ! I would love to see what you have in mind, please create a PR on staging: https://github.ibm.com/Bluemix-Docs/openwhisk/issues

Once the changes look good, I will promote them to prod.

lornajane commented 6 years ago

I realised that some of the content comes from the OpenWhisk repo itself - but not all of it. So I've made an initial PR on that repo https://github.com/apache/incubator-openwhisk/pull/3244. Then I can add the IBM-Cloud-specific part about binding service parameters in a separate patch (maybe after this is merged?)

jpkessle commented 6 years ago

@lornajane - I reviewed that PR and submit some comments.

Sounds great, thanks you for your contribution! Just a reminder, when you add the IBM Cloud specific info, please create the PR on the staging repo. I will promote it to Prod once we are happy with the changes. Ty !

Rachael-Graham commented 6 years ago

Live in prod--Closing! :)

ibm-cloud-docs / openwhisk

Restructure Parameters Docs #19