Minor doc changes

* Fix broken command, link to contributor guide
* Fix links

Author: prachirp

CONTRIBUTING.md

@@ -25,4 +25,9 @@ information on using pull requests.
 ## Community Guidelines
 
 This project follows
-[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
+[Google's Open Source Community Guidelines](https://opensource.google.com/conduct/).
+
+## Additional Notes
+
+Follow the [contributor guide](docs/contributor_guide.md) for additional tips and best practices when
+submitting changes.

docs/concepts.md

@@ -14,7 +14,7 @@ At a high level, a function can be conceptualized like so:
 
 See [Configuration Functions Specification][spec] for further details.
 
-There are two special-case functions:
+There are two special-case functions: source functions and sink functions.
 
 ## Source Function
 

docs/contributor_guide.md

@@ -11,7 +11,7 @@ need to perform due diligence.
 1. What's size of the package? Will it cause binary bloat?
 1. Is the package and its transitive dependencies high quality, trust-worthy, and well-maintained projects?
 1. What version of the package should we depend on?
-1. Are the licenses for the package and its transitive dependencies 'green'? See next section for checking license.
+1. Are the licenses for the package and its transitive dependencies green? See next section for checking licenses.
 
 ## Checking licenses
 
@@ -25,8 +25,8 @@ npm run lint-license
 ## Releases
 
 1. Update version in package.json to e.g. `0.10.0-rc.1`
-2. Create a RC in GitHub, e.g: `release-kpt-functions-v0.10.0-rc.1`
+1. Create a release candidate (RC) in GitHub, e.g: `release-kpt-functions-v0.10.0-rc.1`
    This will trigger a release job in GitHub actions
-3. Create a PR changing dependant packages to use the rc version.
-4. If the CI passes for this PR, edit release created in #2 and remove `-rc.1`.
-5. Edit PR in #4 to remove `-rc.1`.
+1. Create a pull request (PR) changing dependent packages to use the RC version.
+1. If the release job passes for this PR, edit release created in #2 and remove `-rc.1`.
+1. Edit PR in #4 to remove `-rc.1`.

docs/develop-quickstart.md

@@ -16,15 +16,15 @@ Currently supported platforms: amd64 Linux/Mac
 
 - Install [node][download-node]
 - Install [docker][install-docker]
-- Install [kpt][download-kpt]
+- Install [kpt][download-kpt] and add it to \$PATH
 
 #### `.npmrc` File
 
 In order to install these packages, you need to configure your `.npmrc` file to authenticate to GitHub.
 
 1. Create a Personal Token by navigating to `Settings > Developer settings > Personal access tokens`
-   in GitHub. Specify `read:packages` scope.
-1. Back up any existing `.npmrc` if it exist:
+   in GitHub. Specify the `read:packages` scope.
+1. Back up any existing `.npmrc` if it exists:
 
    ```sh
    mv ~/.npmrc{,.backup}
@@ -53,19 +53,19 @@ In order to install these packages, you need to configure your `.npmrc` file to
    cd kpt-functions-sdk/ts/hello-world
    ```
 
-2. Install all dependencies:
+1. Install all dependencies:
 
    ```sh
    npm install
    ```
-   
-3. Run the following in a separate terminal to continuously build your function as you make changes:
+
+1. Run the following in a separate terminal to continuously build your function as you make changes:
 
    ```sh
    npm run watch
    ```
 
-4. Run the `label_namespace` function:
+1. Run the `label_namespace` function:
 
    ```sh
    export CONFIGS=../../example-configs
@@ -75,20 +75,20 @@ In order to install these packages, you need to configure your `.npmrc` file to
    kpt fn sink $CONFIGS
    ```
 
-   As the name suggest, this function added the given label to all `Namespace` objects
-   in `example-configs` directory:
+   As the name suggests, this function added the given label to all `Namespace` objects
+   in the `example-configs` directory:
 
    ```sh
    git diff $CONFIGS
    ```
 
-5. Try modifying the function in `src/label_namespace.ts` to perform other operations
+1. Try modifying the function in `src/label_namespace.ts` to perform other operations
    on `example-configs`, then repeat step 4.
 
    The function should implement the `KptFunc` interface [documented here][api-kptfunc].
 
    Take a look at [these example functions][demo-funcs] to better understand how to use
-   `kpt-functions` library.
+   the `kpt-functions` SDK.
 
 ## Next Steps
 

docs/develop.md

@@ -29,13 +29,13 @@ Currently supported platforms: amd64 Linux/Mac
 
 #### `.npmrc` File
 
-Currently, NPM packages in the SDK are published to [private GitHub package in this repo][npm-packages].
+Currently, NPM packages in the SDK are published to [private GitHub packages in this repo][npm-packages].
 
 In order to install these packages, you need to configure your `.npmrc` file to authenticate to GitHub.
 
 1. Create a Personal Token by navigating to `Settings > Developer settings > Personal access tokens`
-   in GitHub. Specify `read:packages` scope.
-1. Back up any existing `.npmrc` if it exist:
+   in GitHub. Specify the `read:packages` scope.
+1. Back up any existing `.npmrc` if it exists:
 
    ```sh
    mv ~/.npmrc{,.backup}
@@ -52,7 +52,7 @@ In order to install these packages, you need to configure your `.npmrc` file to
 
 ### Your Kubernetes Cluster
 
-For the type generation functionality to work, you need a Kubernetes cluster with [CRD OpenAPI Publishing][beta-feature] feature which is beta with Kubernetes 1.15.
+For the type generation functionality to work, you need a Kubernetes cluster with the [CRD OpenAPI Publishing][beta-feature] feature which is beta with Kubernetes 1.15.
 
 Alternatively, you can use an existing NPM package with pre-generated types such as the `hello-world`
 package discussed in the [Quickstart](develop-quickstart.md) and skip to [implementing the function](#implementing-the-function).
@@ -97,7 +97,7 @@ You can also use a deployed cluster in GKE. The beta k8s feature is avilable onl
 `--enable-kubernetes-alpha` flag, as seen here:
 
 ```sh
-gcloud container clusters create $USER-1-14-alpha --enable-kubernetes-alpha --cluster-version=latest --region=us-central1-a --project <PROJECT>
+gcloud container clusters create $USER-1-14-alpha --enable-kubernetes-alpha --cluster-version=latest --no-enable-autoupgrade --region=us-central1-a --project <PROJECT>
 gcloud container clusters get-credentials $USER-1-14-alpha --zone us-central1-a --project <PROJECT>
 ```
 
@@ -241,11 +241,9 @@ the NPM package you created above. The CLI sub-commands can be invoked via `npm
 to add a new function to the package:
 
 ```console
-npm run kpt:function-create -- --help
+npm run kpt:function-create
 ```
 
-> **Note:** Flags are passed to the CLI after the `--` separator.
-
 These sub-commands are available:
 
 ```console
@@ -259,6 +257,13 @@ kpt:type-create         Generate classes for core and CRD types. Overwrite
                         files if they exist.
 ```
 
+Flags are passed to the CLI after the `--` separator. For example, to pass a tag
+when building a docker image:
+
+```console
+npm run kpt:docker-build -- --tag=latest
+```
+
 ## Next Steps
 
 - [Running KPT Functions](run.md)

docs/run.md

@@ -196,7 +196,7 @@ provide a simple list of key/value pairs as parameters. We provide porcelain to
 docker run -i gcr.io/kpt-functions/label-namespace -d label_name=color -d label_value=orange < /tmp/input.yaml
 ```
 
-> **Note:** This causes an error if the function takes another kind of `functionConfig`.
+> **Note:** This causes an error if the function takes another Kind of `functionConfig`.
 
 #### Composing a pipeline
 
@@ -223,13 +223,13 @@ Finally, let's run the pipeline:
 docker run -i -u $(id -u) -v $(pwd):/source gcr.io/kpt-functions/read-yaml -i /dev/null -d source_dir=/source |
 docker run -i gcr.io/kpt-functions/label-namespace -d label_name=color -d label_value=orange |
 docker run -i -u $(id -u) -v $(pwd):/sink gcr.io/kpt-functions/write-yaml -o /dev/null -d sink_dir=/sink -d overwrite=true
-````
+```
 
 You should see labels added to `Namespace` configuration files:
 
 ```sh
 git status
-````
+```
 
 #### Understanding Docker Flags