-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Fix rename pages 6303 #6457
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Fix rename pages 6303 #6457
Changes from all commits
817d983
eeab381
0c76256
b8dbd3d
06ae115
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
|
@@ -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 | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ components: | |
| function: explanation | ||
| --- | ||
|
|
||
| # Knative Eventing - The Event-driven application platform for Kubernetes | ||
| # Eventing | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note that because we have explicit My $0.02 here would be to keep the longer name for SEO purposes. |
||
|
|
||
| --8<-- "about-eventing.md" | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ components: | |
| function: explanation | ||
| --- | ||
|
|
||
| # About Brokers | ||
| # Brokers | ||
|
|
||
| --8<-- "about-brokers.md" | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,6 @@ components: | |
| function: tutorial | ||
| --- | ||
|
|
||
| # About Knative Functions | ||
| # Knative Functions | ||
|
|
||
| --8<-- "about-functions.md" | ||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
Servicesas a clickable link, and "About Knative Services" isn't shown at all.Example: https://knative.dev/docs/serving/services/
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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?