Format markdown (#1670)

Produced via:
  `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
/assign @samodell
This commit is contained in:
mattmoor-sockpuppet 2019-08-08 07:20:57 -07:00 committed by Knative Prow Robot
parent 62cef00906
commit bb824f1f97
5 changed files with 73 additions and 60 deletions

View File

@ -33,7 +33,8 @@ spec:
## Trigger ## Trigger
A Trigger represents a desire to subscribe to events from a specific Broker. A Trigger represents a desire to subscribe to events from a specific Broker.
Exact match filtering on CloudEvents attributes as well as extensions are supported. Exact match filtering on CloudEvents attributes as well as extensions are
supported.
Example: Example:
@ -57,26 +58,25 @@ spec:
### Channel ### Channel
`Broker`s use their `spec.channelTemplateSpec` to create their internal [Channels](./channels/), `Broker`s use their `spec.channelTemplateSpec` to create their internal
which dictate the durability guarantees of events sent to that `Broker`. If [Channels](./channels/), which dictate the durability guarantees of events sent
`spec.channelTemplateSpec` is not specified, then the to that `Broker`. If `spec.channelTemplateSpec` is not specified, then the
[default channel](./channels/default-channels.md) [default channel](./channels/default-channels.md) for their namespace is used.
for their namespace is used.
#### Setup #### Setup
Have a `Channel` CRD installed and set as the Have a `Channel` CRD installed and set as the default channel for the namespace
default channel for the namespace you are interested in. For development, the you are interested in. For development, the
[InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel) [InMemoryChannel](https://github.com/knative/eventing/tree/master/config/channels/in-memory-channel)
is normally used. is normally used.
#### Changing #### Changing
**Note** changing the `Channel` of a running `Broker` will **Note** changing the `Channel` of a running `Broker` will lose all in-flight
lose all in-flight events. events.
If you want to change which `Channel` is used by a given If you want to change which `Channel` is used by a given `Broker`, then
`Broker`, then determine if the `spec.channelTemplateSpec` is specified or not. determine if the `spec.channelTemplateSpec` is specified or not.
If `spec.channelTemplateSpec` is specified: If `spec.channelTemplateSpec` is specified:
@ -236,7 +236,8 @@ spec:
#### Defaulting #### Defaulting
The Webhook will default the `spec.broker` field to `default`, if left unspecified. The Webhook will default the `spec.broker` field to `default`, if left
unspecified.
The Webhook will default the YAML above to: The Webhook will default the YAML above to:

View File

@ -4,10 +4,9 @@ weight: 20
type: "docs" type: "docs"
--- ---
Choice CRD provides a way to easily define a list of branches, each Choice CRD provides a way to easily define a list of branches, each receiving
receiving the same CloudEvent sent to the Choice ingress channel. the same CloudEvent sent to the Choice ingress channel. Typically, each branch
Typically, each branch consists of a filter function guarding the execution consists of a filter function guarding the execution of the branch.
of the branch.
Choice creates `Channel`s and `Subscription`s under the hood. Choice creates `Channel`s and `Subscription`s under the hood.
@ -34,12 +33,12 @@ Choice has three parts for the Spec:
Choice has three parts for the Status: Choice has three parts for the Status:
1. `conditions` which details the overall status of the Choice object 1. `conditions` which details the overall status of the Choice object
1. `ingressChannelStatus` and `caseStatuses` which convey the status of underlying 1. `ingressChannelStatus` and `caseStatuses` which convey the status of
`Channel` and `Subscription` resource that are created as part of this underlying `Channel` and `Subscription` resource that are created as part of
Choice. this Choice.
1. `address` which is exposed so that Choice can be used where Addressable 1. `address` which is exposed so that Choice can be used where Addressable can
can be used. Sending to this address will target the `Channel` which is be used. Sending to this address will target the `Channel` which is fronting
fronting this Choice (same as `ingressChannelStatus`). this Choice (same as `ingressChannelStatus`).
## Examples ## Examples

View File

@ -70,10 +70,10 @@ see Performing a Custom Knative Installation.
Knative was originally built using Istio to handle cluster networking. While the Knative was originally built using Istio to handle cluster networking. While the
Istio gateway provides the functionality needed to serve requests to your Istio gateway provides the functionality needed to serve requests to your
application, installing a service mesh just to handle north-south traffic application, installing a service mesh just to handle north-south traffic
carries some operational overhead with it. Ambassador provides a way to get carries some operational overhead with it. Ambassador provides a way to get
traffic to your Knative application without the overhead or complexity of a traffic to your Knative application without the overhead or complexity of a full
full service mesh. service mesh.
You can install Ambassador with `kubectl`: You can install Ambassador with `kubectl`:

View File

@ -11,24 +11,24 @@ Below are a set of site elements that have causes issues in the past.
## Lists ## Lists
* Top level: - Top level:
1. A nested list item. 1. A nested list item.
1. another level lower 1. another level lower
1. Nested code sample: 1. Nested code sample: <br>Syntax: <code>{<code>{< readfile
<br>Syntax: <code>{<code>{< readfile file="../community/samples/serving/helloworld-java-quarkus/service.yaml" code="true" lang="yaml" >}</code>}</code> file="../community/samples/serving/helloworld-java-quarkus/service.yaml"
<br>Example: code="true" lang="yaml" >}</code>}</code> <br>Example:
{{< readfile file="../community/samples/serving/helloworld-java-quarkus/service.yaml" code="true" lang="yaml" >}} {{< readfile file="../community/samples/serving/helloworld-java-quarkus/service.yaml" code="true" lang="yaml" >}}
1. This should be the third bullet (3.). 1. This should be the third bullet (3.).
1. More nested code: 1. More nested code: <br>Shortcode: <code>{<code>{< readfile
<br>Shortcode: <code>{<code>{< readfile file="/serving/samples/hello-world/helloworld-go/Dockerfile" code="true" lang="go" >}</code>}</code> file="/serving/samples/hello-world/helloworld-go/Dockerfile" code="true"
<br>Example: lang="go" >}</code>}</code> <br>Example:
{{< readfile file="./serving/samples/hello-world/helloworld-go/Dockerfile" code="true" lang="go" >}} {{< readfile file="./serving/samples/hello-world/helloworld-go/Dockerfile" code="true" lang="go" >}}
1. Another nested ordered list item (2.) 1. Another nested ordered list item (2.)
## Code samples ## Code samples
The following use the [`readfile` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/readfile.md) The following use the
[`readfile` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/readfile.md)
{{< readfile file="../hack/reference-docs-gen-config.json" code="true" lang="json" >}} {{< readfile file="../hack/reference-docs-gen-config.json" code="true" lang="json" >}}
@ -36,26 +36,33 @@ The following use the [`readfile` shortcode](https://github.com/knative/website/
## Install version numbers and Clone branch commands ## Install version numbers and Clone branch commands
Examples of how the manual and dynamic version number or branch name can be added in-line with the Examples of how the manual and dynamic version number or branch name can be
added in-line with the
[`version` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/version.md) [`version` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/version.md)
(uses the define values from [config/_default/params.toml](https://github.com/knative/website/blob/master/config/_default/params.toml)) (uses the define values from
[config/\_default/params.toml](https://github.com/knative/website/blob/master/config/_default/params.toml))
1. Shortcode: <code>{<code>{% version %}</code>}</code> 1. Shortcode: <code>{<code>{% version %}</code>}</code>
Example: `kubectl apply version/{{% version %}}/is-the-latest/docs-version.yaml` Example:
`kubectl apply version/{{% version %}}/is-the-latest/docs-version.yaml`
1. Shortcode: <code>{<code>{% version override="v0.2.2" %}</code>}</code> 1. Shortcode: <code>{<code>{% version override="v0.2.2" %}</code>}</code>
Example: `kubectl apply the-version-override/{{% version override="v0.2.2" %}}/is-manually-specified.yaml` Example:
`kubectl apply the-version-override/{{% version override="v0.2.2" %}}/is-manually-specified.yaml`
1. Shortcode: <code>{<code>{% version patch=".20" %}</code>}</code> 1. Shortcode: <code>{<code>{% version patch=".20" %}</code>}</code>
Example: `kubectl apply this-is-a-point-release/{{% version patch=".20" %}}/filename.yaml` Example:
`kubectl apply this-is-a-point-release/{{% version patch=".20" %}}/filename.yaml`
1. Shortcode: <code>{<code>{% branch %}</code>}</code> 1. Shortcode: <code>{<code>{% branch %}</code>}</code>
Example: `git clone -b "{{% branch %}}" https://github.com/knative/docs knative-docs` Example:
`git clone -b "{{% branch %}}" https://github.com/knative/docs knative-docs`
1. Shortcode: <code>{<code>{% branch override="release-0.NEXT" %}</code>}</code> 1. Shortcode: <code>{<code>{% branch override="release-0.NEXT" %}</code>}</code>
Example: `git clone -b "{{% branch override="release-0.NEXT" %}}" https://github.com/knative/docs knative-docs` Example:
`git clone -b "{{% branch override="release-0.NEXT" %}}" https://github.com/knative/docs knative-docs`

View File

@ -11,24 +11,23 @@ Below are a set of site elements that have causes issues in the past.
## Lists ## Lists
* Top level: - Top level:
1. A nested list item. 1. A nested list item.
1. another level lower 1. another level lower
1. Nested code sample: 1. Nested code sample: <br>Shortcode: <code>{<code>{< readfile
<br>Shortcode: <code>{<code>{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}</code>}</code> file="./hack/reference-docs-gen-config.json" code="true"
<br>Example: lang="json" >}</code>}</code> <br>Example:
{{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}} {{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}}
1. This should be the third bullet (3.). 1. This should be the third bullet (3.).
1. More nested code: 1. More nested code: <br>Shortcode: <code>{<code>{< readfile
<br>Shortcode: <code>{<code>{< readfile file="Gopkg.toml" code="true" lang="toml" >}</code>}</code> file="Gopkg.toml" code="true" lang="toml" >}</code>}</code> <br>Example:
<br>Example:
{{< readfile file="Gopkg.toml" code="true" lang="toml" >}} {{< readfile file="Gopkg.toml" code="true" lang="toml" >}}
1. Another nested ordered list item (2.) 1. Another nested ordered list item (2.)
## Code samples ## Code samples
The following use the [`readfile` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/readfile.md) The following use the
[`readfile` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/readfile.md)
{{< readfile file="hack/reference-docs-gen-config.json" code="true" lang="json" >}} {{< readfile file="hack/reference-docs-gen-config.json" code="true" lang="json" >}}
@ -36,26 +35,33 @@ The following use the [`readfile` shortcode](https://github.com/knative/website/
## Install version numbers and Clone branch commands ## Install version numbers and Clone branch commands
Examples of how the manual and dynamic version number or branch name can be added in-line with the Examples of how the manual and dynamic version number or branch name can be
added in-line with the
[`version` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/version.md) [`version` shortcode](https://github.com/knative/website/blob/master/layouts/shortcodes/version.md)
(uses the define values from [config/_default/params.toml](https://github.com/knative/website/blob/master/config/_default/params.toml)) (uses the define values from
[config/\_default/params.toml](https://github.com/knative/website/blob/master/config/_default/params.toml))
1. Shortcode: <code>{<code>{% version %}</code>}</code> 1. Shortcode: <code>{<code>{% version %}</code>}</code>
Example: `kubectl apply version/{{% version %}}/is-the-latest/docs-version.yaml` Example:
`kubectl apply version/{{% version %}}/is-the-latest/docs-version.yaml`
1. Shortcode: <code>{<code>{% version override="v0.2.2" %}</code>}</code> 1. Shortcode: <code>{<code>{% version override="v0.2.2" %}</code>}</code>
Example: `kubectl apply the-version-override/{{% version override="v0.2.2" %}}/is-manually-specified.yaml` Example:
`kubectl apply the-version-override/{{% version override="v0.2.2" %}}/is-manually-specified.yaml`
1. Shortcode: <code>{<code>{% version patch=".20" %}</code>}</code> 1. Shortcode: <code>{<code>{% version patch=".20" %}</code>}</code>
Example: `kubectl apply this-is-a-point-release/{{% version patch=".20" %}}/filename.yaml` Example:
`kubectl apply this-is-a-point-release/{{% version patch=".20" %}}/filename.yaml`
1. Shortcode: <code>{<code>{% branch %}</code>}</code> 1. Shortcode: <code>{<code>{% branch %}</code>}</code>
Example: `git clone -b "{{% branch %}}" https://github.com/knative/docs knative-docs` Example:
`git clone -b "{{% branch %}}" https://github.com/knative/docs knative-docs`
1. Shortcode: <code>{<code>{% branch override="release-0.NEXT" %}</code>}</code> 1. Shortcode: <code>{<code>{% branch override="release-0.NEXT" %}</code>}</code>
Example: `git clone -b "{{% branch override="release-0.NEXT" %}}" https://github.com/knative/docs knative-docs` Example:
`git clone -b "{{% branch override="release-0.NEXT" %}}" https://github.com/knative/docs knative-docs`