diff --git a/config/nav.yml b/config/nav.yml index 0ba0a7990..11fce31ca 100644 --- a/config/nav.yml +++ b/config/nav.yml @@ -2,9 +2,8 @@ INHERIT: redirects.yml nav: - Home: index.md - - Getting Started: - - Before you begin: getting-started/README.md - - Knative Quickstart: getting-started/install-knative-quickstart.md + - Getting started: + - Knative Quickstart: getting-started/README.md - Using Knative Serving: - First Knative Service: getting-started/first-service.md - Scaling to Zero: getting-started/first-autoscale.md @@ -18,7 +17,7 @@ nav: - What's Next?: getting-started/next-steps.md # Administration guide - Administration guide: - - Overview: admin/README.md + - Administration guide: admin/README.md - Installing Knative: - Overview: admin/install/README.md # Serving Installation diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 64efda14c..dd8ce200c 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -1,13 +1,29 @@ -# Before you begin +# Getting Started with Knative +## Before you begin !!! warning Knative Quickstart Environments are for experimentation use only. For production installation, see our [Administrator's Guide](../admin) Before you can get started with a Knative Quickstart deployment you must install kind and the Kubernetes CLI. -## Install Kind (Kubernetes in Docker) +### Install Kind (Kubernetes in Docker) You can use [`kind`](https://kind.sigs.k8s.io/docs/user/quick-start){target=_blank} (Kubernetes in Docker) to run a local Kubernetes cluster with Docker container nodes. -## Install the Kubernetes CLI +### Install the Kubernetes CLI The [Kubernetes CLI (`kubectl`)](https://kubernetes.io/docs/tasks/tools/install-kubectl){target=_blank}, allows you to run commands against Kubernetes clusters. You can use `kubectl` to deploy applications, inspect and manage cluster resources, and view logs. + + +## Install the Knative "Quickstart" environment + +You can get started with a local deployment of Knative by using _Knative on Kind_ (`konk`): + +--8<-- "quickstart-install.md" + +## Install the Knative CLI + +The Knative CLI (`kn`) provides a quick and easy interface for creating Knative resources, such as Knative Services and Event Sources, without the need to create or modify YAML files directly. + +`kn` also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting. + +--8<-- "install-kn.md" diff --git a/docs/getting-started/install-knative-quickstart.md b/docs/getting-started/install-knative-quickstart.md deleted file mode 100644 index afc84df4a..000000000 --- a/docs/getting-started/install-knative-quickstart.md +++ /dev/null @@ -1,15 +0,0 @@ -# Getting Started with the Knative "Quickstart" Environment - -## Install Knative using the konk script - -You can get started with a local deployment of Knative by using _Knative on Kind_ (`konk`): - ---8<-- "quickstart-install.md" - -## Install the Knative CLI - -The Knative CLI (`kn`) provides a quick and easy interface for creating Knative resources, such as Knative Services and Event Sources, without the need to create or modify YAML files directly. - -`kn` also simplifies completion of otherwise complex procedures such as autoscaling and traffic splitting. - ---8<-- "install-kn.md"