diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index d8f413b09..695ef98f0 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -1,9 +1,4 @@ -# Getting Started with a Knative "Quickstart" Environment - -!!! warning - Knative Quickstart Environments are for experimentation only. For production installation, see our [Administrator's Guide](../admin) - -## Before you begin +# Before you begin Before you can get started with a Knative Quickstart deployment you must set up a development environment. ## Set up a development cluster diff --git a/docs/getting-started/first-service.md b/docs/getting-started/first-service.md index d41c5422a..da97099b0 100644 --- a/docs/getting-started/first-service.md +++ b/docs/getting-started/first-service.md @@ -1,6 +1,6 @@ # Deploying your first Knative Service !!! tip - Hit ++"n"++ / ++"."++ on your keyboard to move forward in the tutorial. Use ++"p"++ / ++","++ to go back at any time. + Hit ++"."++ on your keyboard to move forward in the tutorial. Use ++","++ to go back at any time. ==**In this tutorial, you will deploy a "Hello world" service.**== This service will accept an environment variable, `TARGET`, and print "`Hello ${TARGET}!`." diff --git a/docs/getting-started/first-trigger.md b/docs/getting-started/first-trigger.md index f2f93a67c..56953adb9 100644 --- a/docs/getting-started/first-trigger.md +++ b/docs/getting-started/first-trigger.md @@ -6,9 +6,21 @@ ``` === "YAML" - - //TODO - + ```bash + apiVersion: eventing.knative.dev/v1 + kind: Trigger + metadata: + name: cloudevents-player + annotations: + knative-eventing-injection: enabled + spec: + broker: example-broker + subscriber: + ref: + apiVersion: serving.knative.dev/v1 + kind: Service + name: cloudevents-player + ``` ==**Expected Output**== ```{ .bash .no-copy } Trigger 'cloudevents-player' successfully created in namespace 'default'. diff --git a/docs/getting-started/install-serving-eventing.md b/docs/getting-started/install-knative-quickstart.md similarity index 93% rename from docs/getting-started/install-serving-eventing.md rename to docs/getting-started/install-knative-quickstart.md index a34ed3db0..185aa3095 100644 --- a/docs/getting-started/install-serving-eventing.md +++ b/docs/getting-started/install-knative-quickstart.md @@ -1,20 +1,23 @@ -# Install Knative components +# Getting Started with the Knative "Quickstart" Environment + +!!! warning + Knative Quickstart Environments are for experimentation only. For production installation, see our [Administrator's Guide](../admin) ## Install Knative using the konk script You can get started with a local deployment of Knative by using _Knative on Kind_ (`konk`): -!!! todo "Install Knative and Kubernetes on a local Docker Daemon using `konk`" - ``` - curl -sL install.konk.dev | bash - ``` - `konk` is a shell script that completes the following functions: 1. Checks if you have `kind` installed, and creates a cluster called `knative`. 1. Installs Knative Serving with Kourier as the default networking layer, and nip.io as the DNS. 1. Installs Knative Eventing and creates a default broker and channel implementation. +!!! todo "Install Knative and Kubernetes on a local Docker Daemon using `konk`" + ``` + curl -sL install.konk.dev | bash + ``` + ## 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. diff --git a/mkdocs.yml b/mkdocs.yml index daf349f27..40085ccfc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,7 @@ nav: - Home: index.md - Getting Started: - Before you begin: getting-started/README.md - - Install Knative: getting-started/install-serving-eventing.md + - Knative Quickstart: getting-started/install-knative-quickstart.md - Serverless: - First Knative Service: getting-started/first-service.md - Scaling to Zero: getting-started/first-autoscale.md