Skip to content

Commit 4ad4d58

Browse files
author
Mengqi Yu
committed
Merge branch 'master' into gatekeeper/v0.1
2 parents 4ded65b + 05410c1 commit 4ad4d58

File tree

268 files changed

+1810
-1692
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

268 files changed

+1810
-1692
lines changed

.github/hooks/pre-commit

Lines changed: 0 additions & 14 deletions
This file was deleted.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,7 @@ node_modules
99
bin/
1010
__pycache__
1111

12+
functions/go/*/generated
13+
1214
# We use sed -i.bak when doing in-line replace, because it works better cross-platform
1315
*.bak

examples/_template/README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,25 @@
33
### Overview
44

55
1. Explain what this particular example demonstrates.
6-
2. Include a link to the function reference (help doc) on first mention of the function.
7-
3. If function config present:
6+
1. Include a link to the function reference (help doc) on first mention of the function.
7+
8+
### Fetch the example package
9+
10+
1. Show exact `kpt` commands to get the example package.
11+
1. If function config present:
812
1. Show the example function config.
913
1. Explain what this function config does.
1014
Focus on explaining this particular example, not repeating the function reference.
1115

1216
### Function invocation
1317

14-
4. Show exact `kpt` commands to get the example package and run the function.
18+
1. Show exact `kpt` commands to run the function.
1519

1620
### Expected result
1721

18-
5. Describe the expected outcome of running the instructions above. This needs to be specific enough
22+
1. Describe the expected outcome of running the instructions above. This needs to be specific enough
1923
so that the user is confident the function works as expected (Don't just provide the command to `cat` a file).
2024

2125
### Function Reference
2226

23-
6. Provide a link to the function help doc for reference.
27+
1. Provide a link to the function help doc for reference.

examples/apply-setters/simple/README.md renamed to examples/apply-setters-simple/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ with setter references.
88
In this example, we will see how to apply desired setter values to the
99
resource fields parameterized by `kpt-set` comments.
1010

11+
### Fetch the example package
12+
13+
Get the example package by running the following commands:
14+
15+
```shell
16+
$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/apply-setters-simple
17+
```
18+
1119
Let's start with the input resources
1220

1321
```yaml
@@ -68,11 +76,10 @@ roles: # kpt-set: ${role}
6876

6977
### Function invocation
7078

71-
Get the config example and try it out by running the following commands:
79+
Invoke the function by running the following commands:
7280

7381
```shell
74-
$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/apply-setters/simple
75-
$ kpt fn render simple
82+
$ kpt fn render apply-setters-simple
7683
```
7784

7885
### Expected result

0 commit comments

Comments
 (0)