This is an automated email from the ASF dual-hosted git repository.
dgrove pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwhisk-runtime-swift.git
The following commit(s) were added to refs/heads/master by this push:
new cce5402 chore: fix spelling and grammar (#131)
cce5402 is described below
commit cce5402cf15423127d1fd5e332a5f11675c1b1d5
Author: John Bampton <[email protected]>
AuthorDate: Thu Mar 11 00:18:06 2021 +1000
chore: fix spelling and grammar (#131)
---
CONTRIBUTING.md | 4 ++--
README.md | 10 +++++-----
gradle/README.md | 4 ++--
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d8f8faa..9118557 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,7 +21,7 @@
# Contributing to Apache OpenWhisk
-Anyone can contribute to the OpenWhisk project and we welcome your
contributions.
+Anyone can contribute to the OpenWhisk project, and we welcome your
contributions.
There are multiple ways to contribute: report bugs, improve the docs, and
contribute code, but you must follow these prerequisites and guidelines:
@@ -50,7 +50,7 @@ Please raise any bug reports or enhancement requests on the
respective project r
list to see if your issue has already been raised.
A good bug report is one that make it easy for us to understand what you were
trying to do and what went wrong.
-Provide as much context as possible so we can try to recreate the issue.
+Provide as much context as possible, so we can try to recreate the issue.
A good enhancement request comes with an explanation of what you are trying to
do and how that enhancement would help you.
diff --git a/README.md b/README.md
index bc87bfe..7776e4c 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@
## Quick Swift Action
### Simple swift action hello.swift
-The traditional support for dictionary still works:
+The traditional support for the dictionary still works:
```swift
import Foundation
@@ -490,16 +490,16 @@ Using gradle to run some tests
```
Using IntelliJ:
- Import project as gradle project.
-- Make sure working directory is root of the project/repo
+- Make sure the working directory is root of the project/repo
#### Using container image to test
-To use as docker action push to your own dockerhub account
+To use as docker action push to your own Docker Hub account
```
docker tag whisk/action-swift-v4.2 $user_prefix/action-swift-v4.2
docker push $user_prefix/action-swift-v4.2
```
-Then create the action using your the image from dockerhub
+Then create the action using your image from Docker Hub
```
wsk action update myAction myAction.swift --docker
$user_prefix/action-swift-v4.2
```
-The `$user_prefix` is usually your dockerhub user id.
+The `$user_prefix` is usually your Docker Hub user id.
diff --git a/gradle/README.md b/gradle/README.md
index 14842f1..fc28d4d 100644
--- a/gradle/README.md
+++ b/gradle/README.md
@@ -41,14 +41,14 @@ Project level options that can be used on `distDocker`:
### Test
-To run tests one uses the `test` task. OpenWhisk consolidates tests into a
single `tests` project. Hence the command to run all tests is `gradle
:tests:test`.
+To run tests one uses the `test` task. OpenWhisk consolidates tests into a
single `tests` project. Hence, the command to run all tests is `gradle
:tests:test`.
It is possible to run specific tests using [Gradle
testfilters](https://docs.gradle.org/current/userguide/java_plugin.html#test_filtering).
For example `gradle :tests:test --tests
"your.package.name.TestClass.evenMethodName"`. Wildcard `*` may be used
anywhere.
## Build your own `build.gradle`
In Gradle, most of the tasks we use are default tasks provided by plugins in
Gradle. The [`scala`
Plugin](https://docs.gradle.org/current/userguide/scala_plugin.html) for
example includes tasks, that are needed to build Scala projects. Moreover,
Gradle is aware of *Applications*. The [`application`
Plugin](https://docs.gradle.org/current/userguide/application_plugin.html)
provides tasks that are required to distribute a self-contained application.
When `application` and `scala` are used [...]
-In OpenWhisk, we want to distribute our application via Docker images. Hence
we wrote a "plugin" that creates the task `distDocker`. That task will build an
image from the `Dockerfile` that is located next to the `build.gradle` it is
called from, for example Controller's `Dockerfile` and `build.gradle` are both
located at `core/controller`.
+In OpenWhisk, we want to distribute our application via Docker images. Hence,
we wrote a "plugin" that creates the task `distDocker`. That task will build an
image from the `Dockerfile` that is located next to the `build.gradle` it is
called from, for example Controller's `Dockerfile` and `build.gradle` are both
located at `core/controller`.
If you want to create a new `build.gradle` for your component, simply put the
`Dockerfile` right next to it and include `docker.gradle` by using
