Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/versioned/.nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know the right title here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’ve removed “About” from the title for consistency with other sections. Happy to update it if there’s a preferred alternative

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It turns out that it doesn't matter in this case, because building the nav causes this README.md page to be organized under Services as a clickable link, and "About Knative Services" isn't shown at all.

Example: https://knative.dev/docs/serving/services/

Copy link
Member

@dprotaso dprotaso Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh - that's confusing - what's the best way to represent that in the nav yaml file so it's clear?

- Creating a Service: serving/services/creating-services.md
- Configuring private Services: serving/services/private-services.md
- Configuring ingress class: serving/services/ingress-class.md
Expand Down Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This title change also doesn't matter, because the singleton with README.md gets parented to "Apache Kafka". I do think the longer name in the title makes sense -- it just won't show up in the nav either way.

- 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/eventing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ components:
function: explanation
---

# Knative Eventing - The Event-driven application platform for Kubernetes
# Eventing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that because we have explicit .nav.yaml, the titles here aren't reflected in the side nav, so we can have longer titles here and shorter titles in the nav.

My $0.02 here would be to keep the longer name for SEO purposes.


--8<-- "about-eventing.md"

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/eventing/brokers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ components:
function: explanation
---

# About Brokers
# Brokers

--8<-- "about-brokers.md"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/eventing/sinks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/eventing/sources/apiserversource/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/eventing/sources/redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/getting-started/about-knative-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ components:
function: tutorial
---

# About Knative Functions
# Knative Functions

--8<-- "about-functions.md"
2 changes: 1 addition & 1 deletion docs/versioned/getting-started/getting-started-eventing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/getting-started/quickstart-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/getting-started/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/install/yaml-install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned/serving/services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down