diff --git a/docs/versioned/.nav.yml b/docs/versioned/.nav.yml index eba5380782b..ca0fd854e5a 100644 --- a/docs/versioned/.nav.yml +++ b/docs/versioned/.nav.yml @@ -6,13 +6,13 @@ nav: ############################################################################### # Getting started ############################################################################### - - Tutorial: + - Tutorials: - Overview: getting-started/tutorial.md - Quickstart: - Tutorial introduction: getting-started/README.md - Install Knative using quickstart: getting-started/quickstart-install.md - Knative Functions: - - About Knative Functions: getting-started/about-knative-functions.md + - Getting Started: getting-started/about-knative-functions.md - Installing Knative Functions: getting-started/install-func.md - Creating a function: getting-started/create-a-function.md - Building, running, or deploying a function: getting-started/build-run-deploy-func.md @@ -21,7 +21,7 @@ nav: - Autoscaling: getting-started/first-autoscale.md - Traffic splitting: getting-started/first-traffic-split.md - Knative Eventing: - - About Knative Eventing: getting-started/getting-started-eventing.md + - Getting Started: getting-started/getting-started-eventing.md - Sources, Brokers, and Triggers: getting-started/first-broker.md - Using a Knative Service as a source: getting-started/first-source.md - Using Triggers and sinks: getting-started/first-trigger.md @@ -73,9 +73,9 @@ nav: - Additional autoscaling configuration for Knative Pod Autoscaler: serving/autoscaling/kpa-specific.md - Autoscale Sample App - Go: serving/autoscaling/autoscale-go/README.md # Serving - developer docs - - Developer Topics: + - Developer Tasks: - Services: - - About Knative Services: serving/services/README.md + - Knative Services: serving/services/README.md - Creating a Service: serving/services/creating-services.md - Configuring private Services: serving/services/private-services.md - Configuring ingress class: serving/services/ingress-class.md @@ -130,7 +130,7 @@ nav: # add default IMC broker page, page explaining broker types - Channel based Broker: eventing/brokers/broker-types/channel-based-broker/README.md - Apache Kafka: - - About Apache Kafka Broker: eventing/brokers/broker-types/kafka-broker/README.md + - Knative Broker for Apache Kafka: eventing/brokers/broker-types/kafka-broker/README.md - RabbitMQ Broker: eventing/brokers/broker-types/rabbitmq-broker/README.md - Creating a Broker: eventing/brokers/create-broker.md - Developer configuration options: eventing/brokers/broker-developer-config-options.md @@ -189,7 +189,7 @@ nav: # - 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: + - Developer Tasks: # BYO event source - Custom event sources: - Custom event sources overview: eventing/custom-event-source/README.md @@ -224,7 +224,7 @@ nav: ############################################################################### # CLI ############################################################################### - - Knative CLI: + - CLI tools: - CLI tools: client/README.md - Installing the Knative CLI: client/install-kn.md - Customizing kn: client/configure-kn.md @@ -238,7 +238,7 @@ nav: - Overview: install/README.md # YAML Installation - Install Knative with YAML: - - About YAML-based installation: install/yaml-install/README.md + - YAML-based installation: install/yaml-install/README.md - Install Knative Serving: - Install Serving with YAML: install/yaml-install/serving/install-serving-with-yaml.md - Knative Serving installation files: install/yaml-install/serving/serving-installation-files.md diff --git a/docs/versioned/eventing/README.md b/docs/versioned/eventing/README.md index e7a8194edcd..a0eaf2324f4 100644 --- a/docs/versioned/eventing/README.md +++ b/docs/versioned/eventing/README.md @@ -5,7 +5,7 @@ components: function: explanation --- -# Knative Eventing - The Event-driven application platform for Kubernetes +# Eventing --8<-- "about-eventing.md" diff --git a/docs/versioned/eventing/brokers/README.md b/docs/versioned/eventing/brokers/README.md index 870f01804d8..08a4feb3410 100644 --- a/docs/versioned/eventing/brokers/README.md +++ b/docs/versioned/eventing/brokers/README.md @@ -5,7 +5,7 @@ components: function: explanation --- -# About Brokers +# Brokers --8<-- "about-brokers.md" diff --git a/docs/versioned/eventing/configuration/broker-configuration.md b/docs/versioned/eventing/configuration/broker-configuration.md index 42ef48c06d0..78eaf6e4ce6 100644 --- a/docs/versioned/eventing/configuration/broker-configuration.md +++ b/docs/versioned/eventing/configuration/broker-configuration.md @@ -5,7 +5,7 @@ components: function: how-to --- -# Configure Broker defaults +# Configuring Broker defaults If you have cluster administrator permissions for your Knative installation, you can modify ConfigMaps to change the global default configuration options for Brokers on the cluster. diff --git a/docs/versioned/eventing/sinks/README.md b/docs/versioned/eventing/sinks/README.md index 73a49e97152..31537fa2031 100644 --- a/docs/versioned/eventing/sinks/README.md +++ b/docs/versioned/eventing/sinks/README.md @@ -5,7 +5,7 @@ components: function: how-to --- -# About sinks +# Sinks When you create an event source, you can specify a _sink_ where events are sent to from the source. A sink is an _Addressable_ or a _Callable_ resource that can receive incoming events from other resources. Knative Services, Channels, and Brokers are all examples of sinks. diff --git a/docs/versioned/eventing/sources/apiserversource/README.md b/docs/versioned/eventing/sources/apiserversource/README.md index c3a762cd2bd..1f2e6fd8465 100644 --- a/docs/versioned/eventing/sources/apiserversource/README.md +++ b/docs/versioned/eventing/sources/apiserversource/README.md @@ -5,7 +5,7 @@ components: function: explanation --- -# About ApiServerSource +# ApiServerSource ![stage](https://img.shields.io/badge/Stage-stable-green?style=flat-square) ![version](https://img.shields.io/badge/API_Version-v1-green?style=flat-square) diff --git a/docs/versioned/eventing/sources/redis/README.md b/docs/versioned/eventing/sources/redis/README.md index 2ca95782588..f306bc1dc68 100644 --- a/docs/versioned/eventing/sources/redis/README.md +++ b/docs/versioned/eventing/sources/redis/README.md @@ -5,7 +5,7 @@ components: function: explanation --- -# About RedisStreamSource +# RedisStreamSource ![stage](https://img.shields.io/badge/Stage-alpha-green?style=flat-square) ![version](https://img.shields.io/badge/API_Version-v1alpha1-red?style=flat-square) diff --git a/docs/versioned/getting-started/about-knative-functions.md b/docs/versioned/getting-started/about-knative-functions.md index d4feb447194..26dd4e18ca0 100644 --- a/docs/versioned/getting-started/about-knative-functions.md +++ b/docs/versioned/getting-started/about-knative-functions.md @@ -5,6 +5,6 @@ components: function: tutorial --- -# About Knative Functions +# Knative Functions --8<-- "about-functions.md" diff --git a/docs/versioned/getting-started/getting-started-eventing.md b/docs/versioned/getting-started/getting-started-eventing.md index 83314dfd291..cfe59e87db7 100644 --- a/docs/versioned/getting-started/getting-started-eventing.md +++ b/docs/versioned/getting-started/getting-started-eventing.md @@ -5,7 +5,7 @@ components: function: tutorial --- -# About Knative Eventing +# Knative Eventing Knative Eventing provides you with helpful tools that can be used to create event-driven applications, by easily attaching event sources, triggers, and other options to your Knative Services. diff --git a/docs/versioned/getting-started/quickstart-install.md b/docs/versioned/getting-started/quickstart-install.md index 91676bef526..7cb5c424301 100644 --- a/docs/versioned/getting-started/quickstart-install.md +++ b/docs/versioned/getting-started/quickstart-install.md @@ -7,7 +7,7 @@ components: function: tutorial --- -# Install Knative using quickstart +# Installing Knative using quickstart Following this quickstart tutorial provides you with a simplified, local Knative installation by using the Knative `quickstart` plugin. diff --git a/docs/versioned/getting-started/tutorial.md b/docs/versioned/getting-started/tutorial.md index 5ec2ab9e05f..d27d0ee78cb 100644 --- a/docs/versioned/getting-started/tutorial.md +++ b/docs/versioned/getting-started/tutorial.md @@ -7,7 +7,7 @@ components: function: tutorial --- -# Welcome to the Knative Tutorial +# Welcome to the Knative Tutorials ### **Quick Start Tutorial** Quickstart tutorial provides a simplified local installation to explore Knative Serving and Eventing features. diff --git a/docs/versioned/install/yaml-install/README.md b/docs/versioned/install/yaml-install/README.md index ffda49300f4..9e14efcb7a4 100644 --- a/docs/versioned/install/yaml-install/README.md +++ b/docs/versioned/install/yaml-install/README.md @@ -6,7 +6,7 @@ components: function: reference --- -# About YAML-based installation +# YAML-based installation You can install the Serving component, Eventing component, or both on your cluster by applying YAML files. diff --git a/docs/versioned/serving/app-security/security-guard-about.md b/docs/versioned/serving/app-security/security-guard-about.md index 626b723ea2f..b322888cf15 100644 --- a/docs/versioned/serving/app-security/security-guard-about.md +++ b/docs/versioned/serving/app-security/security-guard-about.md @@ -5,7 +5,7 @@ components: function: explanation --- -# About Security-Guard +# Security-Guard Security-Guard provides visibility into the security status of deployed Knative Services, by monitoring the behaviors of user containers and events. Security-Guard also supports optional blocking of events and termination of user container instances, all based on behavior. diff --git a/docs/versioned/serving/services/README.md b/docs/versioned/serving/services/README.md index b93777a0370..56f4f2c0450 100755 --- a/docs/versioned/serving/services/README.md +++ b/docs/versioned/serving/services/README.md @@ -5,7 +5,7 @@ components: function: explanation --- -# About Knative Services +# Knative Services Knative Services are used to deploy an application. To create an application using Knative, you must create a YAML file that defines a Service. This YAML file specifies metadata about the application, points to the hosted image of the app, and allows the Service to be configured.