Skip to content

Commit

Permalink
hack/build.sh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Harwayne committed Aug 22, 2019
1 parent b3fd761 commit f53ebd8
Show file tree
Hide file tree
Showing 16 changed files with 286 additions and 210 deletions.
5 changes: 2 additions & 3 deletions docs/cmd/kn_importer.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ kn importer [flags]
### SEE ALSO

* [kn](kn.md) - Knative client
* [kn importer create-co](kn_importer_create-co.md) - Create an importer custom object.
* [kn importer delete-co](kn_importer_delete-co.md) - Delete an importer custom object.
* [kn importer describe](kn_importer_describe.md) - Show details for a given trigger
* [kn importer describe](kn_importer_describe.md) - Show details for a given importer, including the event types it generates and its configuration.
* [kn importer generic](kn_importer_generic.md) - Generic Importer command group
* [kn importer list](kn_importer_list.md) - List available triggers.

62 changes: 0 additions & 62 deletions docs/cmd/kn_importer_create-co.md

This file was deleted.

42 changes: 0 additions & 42 deletions docs/cmd/kn_importer_delete-co.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/cmd/kn_importer_describe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn importer describe

Show details for a given trigger
Show details for a given importer, including the event types it generates and its configuration.

### Synopsis

Show details for a given trigger
Show details for a given importer, including the event types it generates and its configuration.

```
kn importer describe NAME [flags]
Expand Down
34 changes: 34 additions & 0 deletions docs/cmd/kn_importer_generic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## kn importer generic

Generic Importer command group

### Synopsis

Generic Importer command group

```
kn importer generic [flags]
```

### Options

```
-h, --help help for generic
```

### Options inherited from parent commands

```
--config string kn config file (default is $HOME/.kn/config.yaml)
--kubeconfig string kubectl config file (default is $HOME/.kube/config)
--log-http log http traffic
```

### SEE ALSO

* [kn importer](kn_importer.md) - Importer command group
* [kn importer generic create](kn_importer_generic_create.md) - Create an importer custom object.
* [kn importer generic delete](kn_importer_generic_delete.md) - Delete an importer custom object.
* [kn importer generic describe](kn_importer_generic_describe.md) - Show details for an importer custom object.
* [kn importer generic list](kn_importer_generic_list.md) - List available Importer Custom Objects.

50 changes: 50 additions & 0 deletions docs/cmd/kn_importer_generic_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## kn importer generic create

Create an importer custom object.

### Synopsis

Create an importer custom object.

```
kn importer generic create CRD_NAME CO_NAME [flags]
```

### Examples

```
# Create a CronJobSource importer named 'my-imp' which sends its events to
# the default Broker.
kn importer generic create CronJobSource my-imp
TODO: Add more
```

### Options

```
--async Create importer and don't wait for it to become ready.
--broker string Broker the Importer associates with. (default "default")
--event-types strings Comma separated list of event types.
--extension-overrides stringToString CloudEvent extension attribute overrides. (default [])
--force Create importer forcefully, replaces existing importer if any.
-h, --help help for create
-n, --namespace string List the requested object(s) in given namespace.
--parameters stringToString Parameters used in the spec of the created importer, expressed as a CSV. (default [])
--secret specField=secretName:key Secret to inject into the spec as a SecretKeySelector. In the form specField=secretName:key. Which will set `spec.specField` to a SecretKeySelector. (default =:)
--wait-timeout int Seconds to wait before giving up on waiting for importer to be ready. (default 60)
```

### Options inherited from parent commands

```
--config string kn config file (default is $HOME/.kn/config.yaml)
--kubeconfig string kubectl config file (default is $HOME/.kube/config)
--log-http log http traffic
```

### SEE ALSO

* [kn importer generic](kn_importer_generic.md) - Generic Importer command group

46 changes: 46 additions & 0 deletions docs/cmd/kn_importer_generic_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## kn importer generic delete

Delete an importer custom object.

### Synopsis

Delete an importer custom object.

```
kn importer generic delete CRD_NAME CO_NAME [flags]
```

### Examples

```
# Delete the importer 'imp1' of type
# 'apiserversources.sources.eventing.knative.dev' in the default namespace.
kn importer delete apiserversources.sources.eventing.knative.dev imp1
# Delete the importer 'imp1' of type 'apiserversources' in the default
# namespace. 'apiserversource' can be the name, kind, singular, or plural name
# of the CRD. If there are multiple CRDs that match 'apiserversource', then an
# error is returned.
kn importer delete apiserversources imp1
```

### Options

```
-h, --help help for delete
-n, --namespace string List the requested object(s) in given namespace.
```

### Options inherited from parent commands

```
--config string kn config file (default is $HOME/.kn/config.yaml)
--kubeconfig string kubectl config file (default is $HOME/.kube/config)
--log-http log http traffic
```

### SEE ALSO

* [kn importer generic](kn_importer_generic.md) - Generic Importer command group

35 changes: 35 additions & 0 deletions docs/cmd/kn_importer_generic_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## kn importer generic describe

Show details for an importer custom object.

### Synopsis

Show details for an importer custom object.

```
kn importer generic describe CRD_NAME CO_NAME [flags]
```

### Options

```
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for describe
-n, --namespace string List the requested object(s) in given namespace.
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
-v, --verbose More output.
```

### Options inherited from parent commands

```
--config string kn config file (default is $HOME/.kn/config.yaml)
--kubeconfig string kubectl config file (default is $HOME/.kube/config)
--log-http log http traffic
```

### SEE ALSO

* [kn importer generic](kn_importer_generic.md) - Generic Importer command group

56 changes: 56 additions & 0 deletions docs/cmd/kn_importer_generic_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## kn importer generic list

List available Importer Custom Objects.

### Synopsis

List available Importer Custom Objects.

```
kn importer generic list [CRD_NAME] [flags]
```

### Examples

```
# List all importer custom objects of kind
# apiserversources.sources.eventing.knative.dev.
kn importer generic list apiserversources.sources.eventing.knative.dev
# List all importer custom objects of kind 'apiserversource'.
# 'apiserversource' can be the name, kind, singular, or plural name of the
# CRD. If there are multiple CRDs that match 'apiserversource', then an
# error is returned.
kn importer generic list apiserversource
# List all apiserversource custom objects in JSON output format.
kn importer generic list apiserversource -o json
# List apiserversource custom object 'cli'.
kn trigger list apiserversource cli
```

### Options

```
--all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for list
-n, --namespace string List the requested object(s) in given namespace.
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
```

### Options inherited from parent commands

```
--config string kn config file (default is $HOME/.kn/config.yaml)
--kubeconfig string kubectl config file (default is $HOME/.kube/config)
--log-http log http traffic
```

### SEE ALSO

* [kn importer generic](kn_importer_generic.md) - Generic Importer command group

12 changes: 6 additions & 6 deletions docs/cmd/kn_importer_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ kn importer list [name] [flags]

```
# List all triggers
kn trigger list
# List all importer CRDs.
kn importer list
# List all triggers in JSON output format
kn trigger list -o json
# List all importer CRDs in JSON output format.
kn importer list -o json
# List trigger 'web'
kn trigger list web
# List importer CRD 'apiserversources.sources.eventing.knative.dev'.
kn importer list apiserversources.sources.eventing.knative.dev
```

### Options
Expand Down
5 changes: 2 additions & 3 deletions docs/cmd/kn_trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@ kn trigger [flags]
### SEE ALSO

* [kn](kn.md) - Knative client
* [kn trigger create](kn_trigger_create.md) - Create a trigger.
* [kn trigger create](kn_trigger_create.md) - Create a Trigger and optionally an importer. If an Importer is created, then the created Trigger receives events exclusively from the created importer.
* [kn trigger delete](kn_trigger_delete.md) - Delete a trigger.
* [kn trigger describe](kn_trigger_describe.md) - Show details for a given trigger
* [kn trigger describe](kn_trigger_describe.md) - Show details for the named trigger
* [kn trigger list](kn_trigger_list.md) - List available triggers.
* [kn trigger update](kn_trigger_update.md) - Update a trigger.

Loading

0 comments on commit f53ebd8

Please sign in to comment.