diff --git a/config/nav.yml b/config/nav.yml index f67d2a28f..c7862169c 100644 --- a/config/nav.yml +++ b/config/nav.yml @@ -22,64 +22,50 @@ nav: - Clean Up: getting-started/clean-up.md - What's Next?: getting-started/next-steps.md ############################################################################### - # Administrator guide + # Installing ############################################################################### - - Administration guide: - - Overview: admin/README.md - - Installing Knative: - - Overview: admin/install/README.md - # Serving Installation - - Install Knative Serving: - - Install Serving with YAML: admin/install/serving/install-serving-with-yaml.md - - Knative Serving installation files: admin/install/serving/serving-installation-files.md - # Istio Installation - - Installing Istio for Knative: admin/install/installing-istio.md - # Eventing Installation - - Install Knative Eventing: - - Install Eventing with YAML: admin/install/eventing/install-eventing-with-yaml.md - - Knative Eventing installation files: admin/install/eventing/eventing-installation-files.md - # Operator Installation - - Knative Operator: - - Installing with the Operator: admin/install/knative-with-operators.md - - Configuring Knative Eventing CRDs: admin/install/operator/configuring-eventing-cr.md - - Configuring Knative Serving CRDs: admin/install/operator/configuring-serving-cr.md - # Vendor docs - - Using a Knative-based Offering: admin/install/knative-offerings.md + - Installing: + - Overview: admin/install/README.md + # Serving Installation + - Install Knative Serving: + - Install Serving with YAML: admin/install/serving/install-serving-with-yaml.md + - Knative Serving installation files: admin/install/serving/serving-installation-files.md + # Istio Installation + - Installing Istio for Knative: admin/install/installing-istio.md + # Cert-manager Installation + - Installing cert-manager: serving/installing-cert-manager.md + # Eventing Installation + - Install Knative Eventing: + - Install Eventing with YAML: admin/install/eventing/install-eventing-with-yaml.md + - Knative Eventing installation files: admin/install/eventing/eventing-installation-files.md + # Operator Installation + - Install with Knative Operator: + - Installing with the Operator: admin/install/knative-with-operators.md + - Configuring Knative Eventing CRDs: admin/install/operator/configuring-eventing-cr.md + - Configuring Knative Serving CRDs: admin/install/operator/configuring-serving-cr.md + # kn Installation + - Install kn: + - Overview: client/README.md + - Installing kn: client/install-kn.md + - Customizing kn: client/configure-kn.md + - kn plugins: client/kn-plugins.md + # Vendor docs + - Using a Knative-based offering: admin/install/knative-offerings.md + # Upgrading Knative + - Upgrading your installation: + - Overview: admin/upgrade/README.md - Checking your Knative version: check-install-version.md - # Upgrading Knative - - Upgrading your installation: - - Overview: admin/upgrade/README.md - - Upgrading with the Knative Operator: admin/upgrade/upgrade-installation-with-operator.md - - Upgrading with kubectl: admin/upgrade/upgrade-installation.md - # Uninstall - - Uninstalling Knative: admin/install/uninstall.md - # Administrator configuration of observability tools - - Observability: - - Collecting logs: admin/observability/collecting-logs/collecting-logs.md - - Collecting metrics: admin/observability/collecting-metrics/collecting-metrics.md - - Configuring logging: admin/observability/config-logging/logging.md - - Knative Eventing metrics: admin/observability/collecting-metrics/eventing-metrics/metrics.md - - Knative Serving metrics: admin/observability/collecting-metrics/serving-metrics/metrics.md - # Serving config - - Knative Serving configuration: - - Revision garbage collection: admin/serving/revision-gc.md - - Configure Deployment resources: admin/serving/deployment.md - - Configuring gradual rollout of traffic to Revisions: admin/serving/rolling-out-latest-revision-configmap.md - - Feature and extension flags: admin/serving/feature-flags.md - - Configure the Defaults ConfigMap: admin/serving/config-defaults.md - # Eventing config - - Knative Eventing configuration: - - Configure Channel defaults: admin/eventing/channel-configuration.md - - Configure Broker defaults: admin/eventing/broker-configuration.md - - Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md - - Configure event source defaults: admin/eventing/sources-configuration.md -############################################################################## - # Developer guide -############################################################################## - - Developer guide: - - Overview: developer/README.md - # Developer guide - serving - - Knative Serving: + - Upgrading with the Knative Operator: admin/upgrade/upgrade-installation-with-operator.md + - Upgrading with kubectl: admin/upgrade/upgrade-installation.md + # Uninstall + - Uninstalling Knative: admin/install/uninstall.md +############################################################################### + # Serving +############################################################################### + - Serving: + - Overview: serving/README.md + # Serving - developer docs + - Developer Topics: - Services: - About Knative Services: developer/serving/services/README.md - Creating a Service: developer/serving/services/creating-services.md @@ -96,10 +82,58 @@ nav: - Configuring gradual rollout of traffic to Revisions: developer/serving/rolling-out-latest-revision.md - Tag resolution: developer/serving/tag-resolution.md - Deploying from private registries: developer/serving/deploying-from-private-registry.md - - Troubleshooting: - - Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md - # Developer guide - eventing - - Knative Eventing: + - Load balancing: + - Overview: serving/load-balancing/README.md + - Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md + - Revision garbage collection: serving/revision-gc.md + - Autoscaling: + - Overview: serving/autoscaling/README.md + - Supported autoscaler types: serving/autoscaling/autoscaler-types.md + - Metrics: serving/autoscaling/autoscaling-metrics.md + - Targets: serving/autoscaling/autoscaling-targets.md + - Configuring scale to zero: serving/autoscaling/scale-to-zero.md + - Configuring concurrency: serving/autoscaling/concurrency.md + - Configuring the requests per second (RPS) target: serving/autoscaling/rps-target.md + - Configuring scale bounds: serving/autoscaling/scale-bounds.md + - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md + - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md + # Serving - admin docs + - Administrator Topics: + - Kubernetes services: serving/knative-kubernetes-services.md + - Accessing request traces: serving/accessing-traces.md + - Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md + - Exclude namespaces from the Knative webhook: serving/webhook-customizations.md + - Configuring high-availability components: serving/config-ha.md + - Configuring HTTPS connections: serving/using-a-tls-cert.md + - Enabling auto-TLS certs: serving/using-auto-tls.md + - Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md + - Changing the default domain: serving/using-a-custom-domain.md + - Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md + # Serving config + - Serving configuration: + - Revision garbage collection: admin/serving/revision-gc.md + - Configure Deployment resources: admin/serving/deployment.md + - Configuring gradual rollout of traffic to Revisions: admin/serving/rolling-out-latest-revision-configmap.md + - Feature and extension flags: admin/serving/feature-flags.md + - Configure the Defaults ConfigMap: admin/serving/config-defaults.md + # Serving - observability + # TODO: Create separate files for Serving and Eventing + - Observability: + - Collecting logs: admin/observability/collecting-logs/collecting-logs.md + - Configuring logging: admin/observability/config-logging/logging.md + - Collecting metrics: admin/observability/collecting-metrics/collecting-metrics.md + - Knative Serving metrics: admin/observability/collecting-metrics/serving-metrics/metrics.md + # Serving - troubleshooting + - Troubleshooting: + - Debugging application issues: developer/serving/troubleshooting/debugging-application-issues.md +############################################################################### + # Eventing +############################################################################### + - Eventing: + - Overview: eventing/README.md + - Eventing getting started: eventing/getting-started.md # do we need this as well as the getting started guide? + # Eventing - developer docs + - Developer topics: - Event sources: - Overview: developer/eventing/sources/README.md - ApiServerSource: @@ -132,43 +166,56 @@ nav: - About sinks: developer/eventing/sinks/README.md - KafkaSink: developer/eventing/sinks/kafka-sink.md - Handling delivery failure: developer/eventing/event-delivery.md - # Developer guide - concepts - - Concepts: - - Duck typing: developer/concepts/duck-typing.md + - Flows: + - Overview: eventing/flows/README.md + - Parallel: eventing/flows/parallel.md + - Sequence: + - Overview: 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: + - Overview: 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 + - Sugar Controller: eventing/sugar/README.md + - Brokers: + - Overview: eventing/broker/README.md + - Event registry: eventing/event-registry.md # does this make sense here since it mentions being used with brokers and triggers? + - Creating a broker: eventing/broker/create-mtbroker.md + - Triggers: eventing/broker/triggers/README.md + - Broker configuration example: eventing/broker/example-mtbroker.md + - Apache Kafka Broker: eventing/broker/kafka-broker/README.md + - RabbitMQ Broker: eventing/broker/rabbitmq-broker/README.md + - Accessing CloudEvent traces: eventing/accessing-traces.md + # Eventing - admin docs + - Administrator topics: + # Eventing config + - Eventing configuration: + - Configure Channel defaults: admin/eventing/channel-configuration.md + - Configure Broker defaults: admin/eventing/broker-configuration.md + - Configure Kafka Channel defaults: admin/eventing/kafka-channel-configuration.md + - Configure event source defaults: admin/eventing/sources-configuration.md + # Eventing - observability + # TODO: Create separate files for Serving and Eventing + - Observability: + - Collecting logs: admin/observability/collecting-logs/collecting-logs.md + - Configuring logging: admin/observability/config-logging/logging.md + - Collecting metrics: admin/observability/collecting-metrics/collecting-metrics.md + - Knative Eventing metrics: admin/observability/collecting-metrics/eventing-metrics/metrics.md + # Eventing - troubleshooting + - Troubleshooting: + - Debugging: eventing/debugging/README.md + - Experimental Features: eventing/experimental-features.md ############################################################################### - # Serving + # Code samples ############################################################################### - - Knative Serving: - - Overview: serving/README.md - - Developer Topics: - - Load balancing: - - Overview: serving/load-balancing/README.md - - Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md - - Revision garbage collection: serving/revision-gc.md - - Autoscaling: - - Overview: serving/autoscaling/README.md - - Supported autoscaler types: serving/autoscaling/autoscaler-types.md - - Metrics: serving/autoscaling/autoscaling-metrics.md - - Targets: serving/autoscaling/autoscaling-targets.md - - Configuring scale to zero: serving/autoscaling/scale-to-zero.md - - Configuring concurrency: serving/autoscaling/concurrency.md - - Configuring the requests per second (RPS) target: serving/autoscaling/rps-target.md - - Configuring scale bounds: serving/autoscaling/scale-bounds.md - - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md - - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md - - Administrator Topics: - - Kubernetes services: serving/knative-kubernetes-services.md - - Accessing request traces: serving/accessing-traces.md - - Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md - - Exclude namespaces from the Knative webhook: serving/webhook-customizations.md - - Configuring high-availability components: serving/config-ha.md - - Installing cert-manager: serving/installing-cert-manager.md - - Configuring HTTPS connections: serving/using-a-tls-cert.md - - Enabling auto-TLS certs: serving/using-auto-tls.md - - Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md - - Changing the default domain: serving/using-a-custom-domain.md - - Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md - - Code samples: + - Code samples: + - Overview: samples.md + - Serving code samples: - Overview: serving/samples/README.md - Cloud Events apps: - .NET: serving/samples/cloudevents/cloudevents-dotnet/README.md @@ -197,46 +244,13 @@ nav: - RESTful service - Go: serving/samples/rest-api-go/README.md - Secrets - Go: serving/samples/secrets-go/README.md - Tag Header Based Routing: serving/samples/tag-header-based-routing/README.md -############################################################################### - # Eventing -############################################################################### - - Knative Eventing: - - Overview: eventing/README.md - - Getting started: eventing/getting-started.md - - Event registry: eventing/event-registry.md - - Flows: - - Overview: eventing/flows/README.md - - Parallel: eventing/flows/parallel.md - - Sequence: - - Overview: 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: - - Overview: 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 - - Sugar Controller: eventing/sugar/README.md - - Brokers: - - Overview: eventing/broker/README.md - - Creating a broker: eventing/broker/create-mtbroker.md - - Triggers: eventing/broker/triggers/README.md - - Broker configuration example: eventing/broker/example-mtbroker.md - - Apache Kafka Broker: eventing/broker/kafka-broker/README.md - - RabbitMQ Broker: eventing/broker/rabbitmq-broker/README.md - - Debugging: eventing/debugging/README.md - - Accessing CloudEvent traces: eventing/accessing-traces.md - - Experimental Features: eventing/experimental-features.md - - Code samples: + - Eventing code samples: - Overview: eventing/samples/README.md - Hello World: - Overview: eventing/samples/helloworld/README.md - GO: eventing/samples/helloworld/helloworld-go/README.md - Python: eventing/samples/helloworld/helloworld-python/README.md - - Writing an event source using Javascript: eventing/samples/writing-event-source-easy-way/README.md + - Writing an event source using Javascript: eventing/samples/writing-event-source-easy-way/README.md - Apache Kafka: - Binding Example: eventing/samples/kafka/binding/README.md - Channel Example: eventing/samples/kafka/channel/README.md @@ -245,22 +259,20 @@ nav: - Overview: eventing/samples/parallel/README.md - Multiple Cases: eventing/samples/parallel/multiple-branches/README.md - Mutual Exclusivity: eventing/samples/parallel/mutual-exclusivity/README.md - - CloudAuditLogsSource: eventing/samples/cloud-audit-logs-source/README.md - - CloudPubSubSource: eventing/samples/cloud-pubsub-source/README.md - - CloudSchedulerSource: eventing/samples/cloud-scheduler-source/README.md - - CloudStorageSource: eventing/samples/cloud-storage-source/README.md - - GitHub source: eventing/samples/github-source/README.md - - GitLab source: eventing/samples/gitlab-source/README.md - # Client -############################################################################### - - Client: - - Overview: client/README.md - - Installing kn: client/install-kn.md - - Customizing kn: client/configure-kn.md - - kn plugins: client/kn-plugins.md + - Sources: + - CloudAuditLogsSource: eventing/samples/cloud-audit-logs-source/README.md + - CloudPubSubSource: eventing/samples/cloud-pubsub-source/README.md + - CloudSchedulerSource: eventing/samples/cloud-scheduler-source/README.md + - CloudStorageSource: eventing/samples/cloud-storage-source/README.md + - GitHub source: eventing/samples/github-source/README.md + - GitLab source: eventing/samples/gitlab-source/README.md - Blog: /blog/ # Reference docs - Reference: - - Serving: reference/api/serving-api.md - - Eventing: reference/api/eventing-api.md + - Overview: reference/README.md + - API: + - Serving: reference/api/serving-api.md + - Eventing: reference/api/eventing-api.md + - Concepts: + - Duck types: developer/concepts/duck-typing.md - "Join the Community ➠": /community/