Skip to content

Commit f01cfb9

Browse files
committed
doc nits
1 parent d005780 commit f01cfb9

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

docs/run.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,13 @@ docker run -i -u $(id -u) -v /tmp:/tmp gcr.io/kpt-functions/label-namespace -i /
188188

189189
#### functionConfig from literal values
190190

191-
Key/value parameters can also be assigned inline, like so:
191+
`functionConfig` can be any Kubernetes Kind. It's common for functions to use a ConfigMap to
192+
provide a simple list of key/value pairs as parameters. We provide porcelain to make this easier:
192193

193194
```sh
194195
docker run -i gcr.io/kpt-functions/label-namespace -d label_name=color -d label_value=orange < /tmp/input.yaml
195196
```
196197

197-
This is functionally equivalent to the `ConfigMap` used earlier.
198-
199198
> **Note:** This causes an error if the function takes another kind of `functionConfig`.
200199
201200
#### Composing a pipeline
@@ -248,7 +247,7 @@ Functions can be piped to form sophisticated pipelines.
248247
First, grab the `example-configs` directory and pull the docker images:
249248
250249
```sh
251-
git clone [email protected]:GoogleContainerTools/kpt-functions-sdk.git
250+
git clone --depth 1 [email protected]:GoogleContainerTools/kpt-functions-sdk.git
252251
cd kpt-functions-sdk/example-configs
253252
254253
docker pull gcr.io/kpt-functions/read-yaml

ts/demo-functions/src/write_yaml.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,6 @@ function toYaml(o: kpt.KubernetesObject): string {
135135
* @param o The KubernetesObject to get a source path for.
136136
* @returns either the annotated source path, or a generated path for the object to be written to.
137137
*/
138-
// TODO(b/143073821): Solve general problem of making testing private methods unnecessary.
139138
export function buildSourcePath(o: kpt.KubernetesObject): string {
140139
const annotationPath = kpt.getAnnotation(o, kpt.SOURCE_PATH_ANNOTATION);
141140
if (annotationPath) {

0 commit comments

Comments
 (0)