knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Restructure eventing docs navigation (#5914) 

* feat: restructure docs to match new navigation

Signed-off-by: Calum Murray <cmurray@redhat.com>

* fix: faq link is correct

Signed-off-by: Calum Murray <cmurray@redhat.com>

---------

Signed-off-by: Calum Murray <cmurray@redhat.com>
This commit is contained in:
Calum Murray 2024-03-20 09:37:20 -04:00 committed by GitHub
parent 45edc09616
commit 3ad1d9a853
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
config/nav.yml
View File

@ -185,7 +185,7 @@ nav:
- Eventing: - Eventing:
- Knative Eventing overview: eventing/README.md - Knative Eventing overview: eventing/README.md
- Event Mesh: eventing/event-mesh.md - Event Mesh: eventing/event-mesh.md
- Resources: - Concepts:
- Brokers: - Brokers:
- About Brokers: eventing/brokers/README.md - About Brokers: eventing/brokers/README.md
- Broker types: - Broker types:
@ -200,11 +200,6 @@ nav:
- Developer configuration options: eventing/brokers/broker-developer-config-options.md - Developer configuration options: eventing/brokers/broker-developer-config-options.md
- Triggers: - Triggers:
- Using Triggers: eventing/triggers/README.md - Using Triggers: eventing/triggers/README.md
# about triggers docs
# - Administrator configuration options: eventing/triggers/trigger-admin-config-options.md
# - Developer configuration options: eventing/triggers/trigger-developer-config-options.md
# Eventing - developer docs
- Developer topics:
- Event sources: - Event sources:
- About event sources: eventing/sources/README.md - About event sources: eventing/sources/README.md
- ApiServerSource: - ApiServerSource:
@ -219,6 +214,29 @@ nav:
- RedisStreamSource: - RedisStreamSource:
- About RedisStreamSource: eventing/sources/redis/README.md - About RedisStreamSource: eventing/sources/redis/README.md
- Creating a RedisStreamSource object: eventing/sources/redis/getting-started.md - Creating a RedisStreamSource object: eventing/sources/redis/getting-started.md
- Channels:
- About Channels: eventing/channels/README.md
- Channel types and defaults: eventing/channels/channel-types-defaults.md
- Creating a Channel using cluster or namespace defaults: eventing/channels/create-default-channel.md
- Available Channels: eventing/channels/channels-crds.md
- Subscriptions: eventing/channels/subscriptions.md
- Event sinks:
- About sinks: eventing/sinks/README.md
- Apache Kafka Sink: eventing/sinks/kafka-sink.md
- Flows:
- About flows: eventing/flows/README.md
- Parallel: eventing/flows/parallel.md
- Sequence:
- About Sequences: eventing/flows/sequence/README.md
- Displaying Sequence output: eventing/flows/sequence/sequence-reply-to-event-display/README.md
- Using Sequences in series: eventing/flows/sequence/sequence-reply-to-sequence/README.md
- Create additional events: eventing/flows/sequence/sequence-terminal/README.md
- Using with Broker and Trigger: eventing/flows/sequence/sequence-with-broker-trigger/README.md
# about triggers docs
# - Administrator configuration options: eventing/triggers/trigger-admin-config-options.md
# - Developer configuration options: eventing/triggers/trigger-developer-config-options.md
# Eventing - developer docs
- Developer topics:
# BYO event source # BYO event source
- Custom event sources: - Custom event sources:
- Custom event sources overview: eventing/custom-event-source/README.md - Custom event sources overview: eventing/custom-event-source/README.md
@ -236,27 +254,10 @@ nav:
- ContainerSource: - ContainerSource:
- Create a ContainerSource: eventing/custom-event-source/containersource/README.md - Create a ContainerSource: eventing/custom-event-source/containersource/README.md
- ContainerSource Reference: eventing/custom-event-source/containersource/reference.md - ContainerSource Reference: eventing/custom-event-source/containersource/reference.md
- Event sinks:
- About sinks: eventing/sinks/README.md
- Apache Kafka Sink: eventing/sinks/kafka-sink.md
- Handling delivery failure: eventing/event-delivery.md - Handling delivery failure: eventing/event-delivery.md
- Flows:
- About flows: eventing/flows/README.md
- Parallel: eventing/flows/parallel.md
- Sequence:
- About Sequences: eventing/flows/sequence/README.md
- Displaying Sequence output: eventing/flows/sequence/sequence-reply-to-event-display/README.md
- Using Sequences in series: eventing/flows/sequence/sequence-reply-to-sequence/README.md
- Create additional events: eventing/flows/sequence/sequence-terminal/README.md
- Using with Broker and Trigger: eventing/flows/sequence/sequence-with-broker-trigger/README.md
- Channels:
- About Channels: eventing/channels/README.md
- Channel types and defaults: eventing/channels/channel-types-defaults.md
- Creating a Channel using cluster or namespace defaults: eventing/channels/create-default-channel.md
- Available Channels: eventing/channels/channels-crds.md
- Subscriptions: eventing/channels/subscriptions.md
- Event registry: eventing/event-registry.md - Event registry: eventing/event-registry.md
- Sugar controller: eventing/sugar/README.md - Sugar controller: eventing/sugar/README.md
- Debugging: eventing/troubleshooting/README.md
- Administrator topics: - Administrator topics:
# Eventing config # Eventing config
- Eventing configuration: - Eventing configuration:
@ -272,9 +273,6 @@ nav:
- Configuring logging: eventing/observability/logging/config-logging.md - Configuring logging: eventing/observability/logging/config-logging.md
- Collecting metrics: eventing/observability/metrics/collecting-metrics.md - Collecting metrics: eventing/observability/metrics/collecting-metrics.md
- Knative Eventing metrics: eventing/observability/metrics/eventing-metrics.md - Knative Eventing metrics: eventing/observability/metrics/eventing-metrics.md
# Eventing - troubleshooting
- Troubleshooting:
- Debugging: eventing/troubleshooting/README.md
- Experimental Features: - Experimental Features:
- About Eventing experimental features: eventing/experimental-features/README.md - About Eventing experimental features: eventing/experimental-features/README.md
- DeliverySpec.Timeout field: eventing/experimental-features/delivery-timeout.md - DeliverySpec.Timeout field: eventing/experimental-features/delivery-timeout.md
@ -285,6 +283,7 @@ nav:
- EventType auto creation: eventing/experimental-features/eventtype-auto-creation.md - EventType auto creation: eventing/experimental-features/eventtype-auto-creation.md
- Transport Encryption: eventing/experimental-features/transport-encryption.md - Transport Encryption: eventing/experimental-features/transport-encryption.md
- Sender Identity: eventing/experimental-features/sender-identity.md - Sender Identity: eventing/experimental-features/sender-identity.md
- FAQ: eventing/faq/README.md
# Eventing reference docs # Eventing reference docs
- Reference: - Reference:
- Eventing API: eventing/reference/eventing-api.md - Eventing API: eventing/reference/eventing-api.md

6
docs/eventing/faq/README.md Normal file
View File

@ -0,0 +1,6 @@
# Eventing FAQs
## What is a Sugar Controller?
The Sugar Controller is an optional controller which will automatically create and clean up brokers based on the creation/deletion of namespaces and triggers.
For more information on how to enable and configure the sugar controller, read the [sugar controller documentation](/docs/eventing/sugar).