From dd7efc9996f2e736605342a913f69f864fbe88c5 Mon Sep 17 00:00:00 2001 From: Evan Anderson Date: Wed, 24 Sep 2025 15:25:55 -0700 Subject: [PATCH] Move install docs to administration --- config/redirects.yml | 1 + docs/snippets/quickstart-install.md | 1 - docs/snippets/quickstart-prereqs.md | 1 - docs/versioned/.nav.yml | 87 ++++++++++---------- docs/versioned/install/README.md | 2 +- docs/versioned/install/quickstart-install.md | 28 ------- overrides/assets/stylesheets/home.css | 35 ++++---- overrides/home.html | 6 +- 8 files changed, 64 insertions(+), 97 deletions(-) delete mode 100644 docs/versioned/install/quickstart-install.md diff --git a/config/redirects.yml b/config/redirects.yml index d1588659ee1..000ea35e240 100644 --- a/config/redirects.yml +++ b/config/redirects.yml @@ -164,6 +164,7 @@ plugins: versioned/eventing/sink/kafka-sink.md: versioned/eventing/sinks/kafka-sink.md versioned/eventing/sources/containersource.md: versioned/eventing/custom-event-source/containersource/README.md versioned/eventing/sources/pingsource/index.md: versioned/eventing/sources/ping-source/README.md + versioned/install/quickstart-install.md: versioned/getting-started/quickstart-install.md versioned/install/collecting-logs/index.md: versioned/serving/observability/logging/collecting-logs.md versioned/install/collecting-metrics/index.md: versioned/serving/observability/metrics/collecting-metrics.md versioned/install/eventing/eventing-installation-files.md: versioned/install/yaml-install/eventing/eventing-installation-files.md diff --git a/docs/snippets/quickstart-install.md b/docs/snippets/quickstart-install.md index 3f9b7d65ee1..a9125e58949 100644 --- a/docs/snippets/quickstart-install.md +++ b/docs/snippets/quickstart-install.md @@ -1,6 +1,5 @@ ## Install the Knative quickstart plugin diff --git a/docs/snippets/quickstart-prereqs.md b/docs/snippets/quickstart-prereqs.md index 69793d1a58f..455fefcad13 100644 --- a/docs/snippets/quickstart-prereqs.md +++ b/docs/snippets/quickstart-prereqs.md @@ -1,6 +1,5 @@ ## Before you begin diff --git a/docs/versioned/.nav.yml b/docs/versioned/.nav.yml index 062da3fbd83..b84cebf74cb 100644 --- a/docs/versioned/.nav.yml +++ b/docs/versioned/.nav.yml @@ -39,49 +39,6 @@ nav: - 6 - Advanced event filtering: bookstore/page-6/advanced-event-filtering.md - 7 - Connect Slack via Camel-K: bookstore/page-7/slack-sink-learning-knative-eventing-and-apache-camel-K-integration.md - 8 - Extra Challenges: bookstore/extra-challenge/README.md -############################################################################### - # Installing -############################################################################### - - Installing: - - About installing Knative: install/README.md - - Install CLI Tools: client/install-kn.md - - Install quickstart: install/quickstart-install.md - # YAML Installation - - Install Knative with YAML: - - About 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 - - Install Knative Eventing: - - Install Eventing with YAML: install/yaml-install/eventing/install-eventing-with-yaml.md - - Knative Eventing installation files: install/yaml-install/eventing/eventing-installation-files.md - # Operator Installation - - Install with Knative Operator: - - Install by using the Knative Operator: install/operator/knative-with-operators.md - - Install by using the Knative Operator CLI plugin: install/operator/knative-with-operator-cli.md - - Configuring Knative using the Operator: install/operator/configuring-with-operator.md - - Configuring Knative Serving CRDs: install/operator/configuring-serving-cr.md - - Configuring Knative Eventing CRDs: install/operator/configuring-eventing-cr.md - # Advanced options for Serving - - Install advanced options: - # Istio Installation - - Install Istio for Knative: install/installing-istio.md - # Cert-manager Installation - - Install cert-manager: install/installing-cert-manager.md - # Backstage plugin - - Install Knative Backstage plugin: install/installing-backstage-plugins.md - # Vendor docs - - Using a Knative-based offering: install/knative-offerings.md - # Upgrading Knative - - Upgrading your installation: - - About upgrading Knative: install/upgrade/README.md - - Checking your Knative version: install/upgrade/check-install-version.md - - Upgrading with kubectl: install/upgrade/upgrade-installation.md - - Upgrading with the Knative Operator: install/upgrade/upgrade-installation-with-operator.md - # Uninstall - - Uninstalling Knative: install/uninstall.md - # Troubleshooting - - Troubleshooting Knative: install/troubleshooting.md ############################################################################### # Functions ############################################################################### @@ -108,7 +65,7 @@ nav: - About Revisions: serving/revisions/README.md - Administrator configuration options: serving/revisions/revision-admin-config-options.md - Developer configuration options: serving/revisions/revision-developer-config-options.md -# add other resource types + # add other resource types - Autoscaling: - About autoscaling: serving/autoscaling/README.md - Supported autoscaler types: serving/autoscaling/autoscaler-types.md @@ -325,6 +282,48 @@ nav: - Installing the Knative CLI: client/install-kn.md - Customizing kn: client/configure-kn.md - kn plugins: client/kn-plugins.md +############################################################################### + # Administration +############################################################################### + - Administration: + # TODO: add a general overview of Knative for administrators + - Installing Knative: install/README.md + # YAML Installation + - Install Knative with YAML: + - About 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 + - Install Knative Eventing: + - Install Eventing with YAML: install/yaml-install/eventing/install-eventing-with-yaml.md + - Knative Eventing installation files: install/yaml-install/eventing/eventing-installation-files.md + # Operator Installation + - Install with Knative Operator: + - Install by using the Knative Operator: install/operator/knative-with-operators.md + - Install by using the Knative Operator CLI plugin: install/operator/knative-with-operator-cli.md + - Configuring Knative using the Operator: install/operator/configuring-with-operator.md + - Configuring Knative Serving CRDs: install/operator/configuring-serving-cr.md + - Configuring Knative Eventing CRDs: install/operator/configuring-eventing-cr.md + # Advanced options for Serving + - Install advanced options: + # Istio Installation + - Install Istio for Knative: install/installing-istio.md + # Cert-manager Installation + - Install cert-manager: install/installing-cert-manager.md + # Backstage plugin + - Install Knative Backstage plugin: install/installing-backstage-plugins.md + # Vendor docs + - Using a Knative-based offering: install/knative-offerings.md + # Upgrading Knative + - Upgrading your installation: + - About upgrading Knative: install/upgrade/README.md + - Checking your Knative version: install/upgrade/check-install-version.md + - Upgrading with kubectl: install/upgrade/upgrade-installation.md + - Upgrading with the Knative Operator: install/upgrade/upgrade-installation-with-operator.md + # Uninstall + - Uninstalling Knative: install/uninstall.md + # Troubleshooting + - Troubleshooting Knative: install/troubleshooting.md ############################################################################### # Code samples ############################################################################### diff --git a/docs/versioned/install/README.md b/docs/versioned/install/README.md index 71619695538..121d1225e09 100644 --- a/docs/versioned/install/README.md +++ b/docs/versioned/install/README.md @@ -33,7 +33,7 @@ Use the following steps to install Knative depending on your installation method **Quickstart**: 1. Install the [CLI Tools](../client/install-kn.md). - 1. Install the [Knative Quickstart plugin](quickstart-install.md). + 1. Install the [Knative Quickstart plugin](../getting-started/quickstart-install.md). **YAML**: diff --git a/docs/versioned/install/quickstart-install.md b/docs/versioned/install/quickstart-install.md deleted file mode 100644 index 2cd71bbc5b1..00000000000 --- a/docs/versioned/install/quickstart-install.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -audience: administrator -components: - - serving - - eventing -function: tutorial ---- - -# Install the Knative quickstart plugin - -This quickstart plugin provides a simplified Knative installation on a kind or Minikube Kubernetes cluster running locally on a single computer. This installation is well suited for experimentation. - -This installation requires the following prerequisites: - -- The [CLI Tools](../client/install-kn.md) are installed. -- Sufficient hardware: - - 6 CPUs, 6 GB of memory, and 30 GB of disk storage. - -For information on production installs, see the [Installation Roadmap](README.md#installation-roadmap). - ---8<-- "quickstart-install.md" - -## Next steps - -- Learn how to deploy your first Service in the [Knative tutorial](../getting-started/first-service.md). -- Try out Knative [code samples](../samples/README.md). -- See the [Knative Serving](../serving/README.md) and [Knative Eventing](../eventing/README.md) guides. diff --git a/overrides/assets/stylesheets/home.css b/overrides/assets/stylesheets/home.css index aaecf640d70..9ddb0cd80b4 100644 --- a/overrides/assets/stylesheets/home.css +++ b/overrides/assets/stylesheets/home.css @@ -108,11 +108,6 @@ section.home-container { margin-left: 0.5rem; } -.md-button--secondary { - background-color: var(--md-primary-fg-color--dark); - border: none !important; -} - .home-container .md-button, .need-to-know-more-container .md-button { background-color: var(--md-primary-fg-color--light); @@ -120,11 +115,25 @@ section.home-container { border-radius: 8px; } -.home-container .md-button--primary { +.md-typeset .call-to-action .md-button { margin-top: 0.5rem; + border-radius: 8px; + color: var(--md-primary-fg-color--dark); + background-color: var(--md-primary-fg-color); + border-color: var(--md-primary-fg-color); +} + +.md-typeset .call-to-action .md-button.md-button--primary { + color: var(--md-primary-fg-color); background-color: var(--md-primary-fg-color--dark); border-color: var(--md-primary-fg-color--dark); - border-radius: 8px; +} + +.md-typeset .call-to-action .md-button:focus, +.md-typeset .call-to-action .md-button:hover { + background-color: var(--md-accent-fg-color) !important; + border-color: var(--md-accent-fg-color) !important; + color: white !important; } h3.trusted-by { @@ -495,18 +504,6 @@ div.components-content { padding: 1rem 1.5rem; } -.md-typeset .md-button.black { - color: black; -} - -.md-typeset .md-button.black:hover { - color: white; -} - -.md-typeset .md-button.white { - color: white; -} - /* cncf notice container css */ .cncf-notice-container { background-color: white; diff --git a/overrides/home.html b/overrides/home.html index 8153d47b677..73cd0e0008d 100644 --- a/overrides/home.html +++ b/overrides/home.html @@ -17,12 +17,12 @@

Try the tutorial Install Knative on your cluster

@@ -187,7 +187,7 @@

Knative Components

Case Studies & Testimonies

- Kelsey Hightower + Kelsey Hightower

"If you want to build a