From bed558454f30fe4d254afc9f96ed8dfa7d9df85c Mon Sep 17 00:00:00 2001 From: Gabriel Freites Date: Fri, 2 Jul 2021 11:37:39 -0500 Subject: [PATCH] changed notes for info admonition (#3919) --- docs/eventing/channels/channel-types-defaults.md | 6 ++++-- docs/eventing/channels/create-default-channel.md | 6 ++++-- docs/eventing/channels/subscriptions.md | 3 ++- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/eventing/channels/channel-types-defaults.md b/docs/eventing/channels/channel-types-defaults.md index e78d06210..673f5b42f 100644 --- a/docs/eventing/channels/channel-types-defaults.md +++ b/docs/eventing/channels/channel-types-defaults.md @@ -9,7 +9,8 @@ showlandingtoc: "true" Knative provides the InMemoryChannel channel implementation by default. This default implementation is useful for developers who do not want to configure a specific implementation type, such as Apache Kafka or NATSS channels. -**NOTE:** InMemoryChannel channels should not be used in production environments. +!!! info + InMemoryChannel channels should not be used in production environments. The default channel implementation is specified in the `default-ch-webhook` ConfigMap in the `knative-eventing` namespace. For more information about modifying ConfigMaps, see [Configuring the Eventing Operator custom resource](../../../install/operator/configuring-eventing-cr). @@ -38,7 +39,8 @@ data: Default channels can be configured for the cluster, a namespace on the cluster, or both. -**NOTE:** If a default channel implementation is configured for a namespace, this will overwrite the configuration for the cluster. +!!! info + If a default channel implementation is configured for a namespace, this will overwrite the configuration for the cluster. ## Next steps diff --git a/docs/eventing/channels/create-default-channel.md b/docs/eventing/channels/create-default-channel.md index 6db9a3a12..e239009c2 100644 --- a/docs/eventing/channels/create-default-channel.md +++ b/docs/eventing/channels/create-default-channel.md @@ -37,11 +37,13 @@ Developers can create channels of any supported implementation type by creating apiVersion: messaging.knative.dev/v1 kind: InMemoryChannel ``` - **NOTE:** The `spec.channelTemplate` property cannot be changed after creation, since it is set by the default channel mechanism, not the user. + !!! info + The `spec.channelTemplate` property cannot be changed after creation, since it is set by the default channel mechanism, not the user. 3. The channel controller creates a backing channel instance based on the `spec.channelTemplate`. When this mechanism is used, two objects are created, a generic Channel object, and an InMemoryChannel object. The generic object acts as a proxy for the InMemoryChannel object, by copying its subscriptions to and setting its status to that of the InMemoryChannel object. -**NOTE:** Defaults only apply on object creation. Defaults are applied by the webhook only on Channel or Sequence creation. If the default settings change, the new defaults will only apply to newly-created channels, brokers, or sequences. Existing ones will not change. +!!! info + Defaults only apply on object creation. Defaults are applied by the webhook only on Channel or Sequence creation. If the default settings change, the new defaults will only apply to newly-created channels, brokers, or sequences. Existing ones will not change. diff --git a/docs/eventing/channels/subscriptions.md b/docs/eventing/channels/subscriptions.md index ddd4a8859..7d8dc7091 100644 --- a/docs/eventing/channels/subscriptions.md +++ b/docs/eventing/channels/subscriptions.md @@ -44,7 +44,8 @@ After you have created a channel and a sink, you can create a subscription to en This example command creates a channel named `mysubscription`, that routes events from a channel named `mychannel` to a Knative service named `myservice`. - **NOTE:** The sink prefix is optional. It is also possible to specify the service for `--sink` as just `--sink ` and omit the `ksvc` prefix. + !!! info + The sink prefix is optional. It is also possible to specify the service for `--sink` as just `--sink ` and omit the `ksvc` prefix.