Audit overview docs

kptdev · Mar 30, 2021 · b522971 · b522971
1 parent 5262512
commit b522971
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 33 deletions.
diff --git a/internal/docs/generated/overview/docs.go b/internal/docs/generated/overview/docs.go
diff --git a/site/reference/README.md b/site/reference/README.md
@@ -7,15 +7,13 @@ menu:
   main:
     weight: 3
 description: >
-    Overview of kpt commands
+  Overview of kpt commands
 ---
 
 <!--mdtogo:Short
     Overview of kpt commands
 -->
 
-{{< asciinema key="kpt" rows="10" preload="1" >}}
-
 <!--mdtogo:Long-->
 
 kpt functionality is subdivided into the following command groups, each of
@@ -24,7 +22,7 @@ syntax and pattern of inputs and outputs.
 
 | Command Group | Description                                                                     | Reads From      | Writes To       |
 | ------------- | ------------------------------------------------------------------------------- | --------------- | --------------- |
-| [pkg]         | fetch, update, and sync configuration files using git                           | remote git      | local directory |
+| [pkg]         | get, update, and describe packages with resources using git                     | remote git      | local directory |
 | [fn]          | generate, transform, validate configuration files using containerized functions | local directory | local directory |
 | [live]        | reconcile the live state with configuration files                               | local directory | remote cluster  |
 
@@ -43,23 +41,11 @@ fetching package /package-examples/helloworld-set from \
   https://github.com/GoogleContainerTools/kpt to helloworld
 ```
 
-```shell
-# list setters and set a value
-$ kpt cfg list-setters helloworld
-NAME            DESCRIPTION         VALUE    TYPE     COUNT   SETBY
-http-port   'helloworld port'         80      integer   3
-image-tag   'hello-world image tag'   v0.3.0  string    1
-replicas    'helloworld replicas'     5       integer   1
-
-$ kpt cfg set helloworld replicas 3 --set-by pwittrock  --description 'reason'
-set 1 fields
-```
-
 ```shell
 # get a package and run a validation function
-kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-sdk.git/example-configs example-configs
-mkdir results/
-kpt fn run example-configs/ --results-dir results/ --image gcr.io/kpt-functions/validate-rolebinding:results -- subject_name=bob@foo-corp.com
+$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-sdk.git/example-configs example-configs
+$ mkdir results/
+$ kpt fn eval example-configs/ --results-dir results/ --image gcr.io/kpt-functions/validate-rolebinding:results -- subject_name=bob@foo-corp.com
 ```
 
 ```shell