You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2021/03/02 16:40:00 UTC
[GitHub] [openwhisk-client-go] mrutkows commented on a change in pull request #144: chore: update docs & provide example code
mrutkows commented on a change in pull request #144:
URL: https://github.com/apache/openwhisk-client-go/pull/144#discussion_r585696105
##########
File path: README.md
##########
@@ -51,7 +51,7 @@ You can also specify a release (tag), if you do not want the latest code, by usi
git clone --branch 1.1.0 git@github.com:apache/openwhisk-client-go
```
-You can also pull the code from a fork of the repository. If you intend to become a Contributor to the project, read the section [Contributing to the project](#contributing-to-the-project) below on how to setup a fork.
+You can also pull the code from a fork of the repository. If you intend to become a Contributor to the project, read the section [Contributing to the project](https://github.com/apache/openwhisk-client-go/blob/master/CONTRIBUTING.md).
Review comment:
Yes, we should link to the separate CONTRIBUTING.md, but there is some basics here... could you put this back and perhaps link to the separate document at the start of that (i.e., #contributing-to-the-project) section?
##########
File path: README.md
##########
@@ -114,10 +114,10 @@ client, _ := whisk.NewClient(http.DefaultClient, nil)
options := &whisk.ActionListOptions{
Limit: 30,
- Skip: 30,
+ Skip: 0,
Review comment:
Skippin g 30 would be silly for someone "getting started"; good change.
##########
File path: README.md
##########
@@ -114,10 +114,10 @@ client, _ := whisk.NewClient(http.DefaultClient, nil)
options := &whisk.ActionListOptions{
Limit: 30,
- Skip: 30,
+ Skip: 0,
Review comment:
I would change the limit to 10 as this seems like what would be a logical default for many downstream tools that use the client...
##########
File path: README.md
##########
@@ -88,7 +88,7 @@ available for you to run this library.
We use a configuration file called _wskprop_ to specify all the parameters necessary for this Go client library to access the OpenWhisk services. Make sure you create or edit the file _~/.wskprops_, and add the mandatory parameters APIHOST, APIVERSION, NAMESPACE and AUTH.
-- The parameter `APIHOST` is the OpenWhisk API hostname (for example, openwhisk.ng.bluemix.net, 172.17.0.1, and so on).
+- The parameter `APIHOST` is the OpenWhisk API hostname (for example, us-east.functions.cloud.ibm.com, 172.17.0.1, and so on).
Review comment:
Could you add some text explaining that this APIHOST endpoint is a sample and you can substitute with that of any OW deployment? It would be great if we could have a "if you run OW locally your APIHOST might look like: xxx).
##########
File path: README.md
##########
@@ -127,22 +127,25 @@ In addition, it can also be configured by passing in a `*whisk.Config` object as
```go
config := &whisk.Config{
- Host: "openwhisk.ng.bluemix.net",
- Version: "v1"
+ Host: "us-east.functions.cloud.ibm.com",
+ Version: "v1",
Namespace: "_",
- AuthKey: "aaaaa-bbbbb-ccccc-ddddd-eeeee"
+ AuthToken: "aaaaa-bbbbb-ccccc-ddddd-eeeee",
Review comment:
Great catch!
##########
File path: README.md
##########
@@ -88,7 +88,7 @@ available for you to run this library.
We use a configuration file called _wskprop_ to specify all the parameters necessary for this Go client library to access the OpenWhisk services. Make sure you create or edit the file _~/.wskprops_, and add the mandatory parameters APIHOST, APIVERSION, NAMESPACE and AUTH.
-- The parameter `APIHOST` is the OpenWhisk API hostname (for example, openwhisk.ng.bluemix.net, 172.17.0.1, and so on).
+- The parameter `APIHOST` is the OpenWhisk API hostname (for example, us-east.functions.cloud.ibm.com, 172.17.0.1, and so on).
Review comment:
For example, the "tools/dev" README indicates the default Controller port to be used: https://github.com/apache/openwhisk/blob/master/tools/dev/README.md
```~/.wskprops must be updated with APIHOST=http://localhost:10001 so that the wsk CLI communicates directly with the controller.```
##########
File path: README.md
##########
@@ -88,7 +88,7 @@ available for you to run this library.
We use a configuration file called _wskprop_ to specify all the parameters necessary for this Go client library to access the OpenWhisk services. Make sure you create or edit the file _~/.wskprops_, and add the mandatory parameters APIHOST, APIVERSION, NAMESPACE and AUTH.
-- The parameter `APIHOST` is the OpenWhisk API hostname (for example, openwhisk.ng.bluemix.net, 172.17.0.1, and so on).
+- The parameter `APIHOST` is the OpenWhisk API hostname (for example, us-east.functions.cloud.ibm.com, 172.17.0.1, and so on).
Review comment:
and the "standalone server" starts on a diff. host:port:
https://github.com/apache/openwhisk/tree/master/core/standalone
It would be good to link/and explain these 2 common setting variants for APIHOST
##########
File path: README.md
##########
@@ -127,22 +127,25 @@ In addition, it can also be configured by passing in a `*whisk.Config` object as
```go
config := &whisk.Config{
- Host: "openwhisk.ng.bluemix.net",
- Version: "v1"
+ Host: "us-east.functions.cloud.ibm.com",
Review comment:
I know I use "us-south" (dallas)... as it has to match my IBM Cloud account... it would be good to make note of that somehow.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org