From f68f841dcf8fbe6fa3887f1201abc672f9436c49 Mon Sep 17 00:00:00 2001 From: Ivan Nikittin Date: Tue, 17 Jul 2018 17:14:34 -0700 Subject: [PATCH] Edits for serving readme (#143) --- serving/README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/serving/README.md b/serving/README.md index 7178fd507..59fd151b8 100644 --- a/serving/README.md +++ b/serving/README.md @@ -8,13 +8,13 @@ and scales to support advanced scenarios. The Knative Serving project provides middleware primitives that enable: * Rapid deployment of serverless containers -* Automatic scale up and down to zero +* Automatic scaling up and down to zero * Routing and network programming for Istio components -* Point in time snapshots of deployed code and configurations +* Point-in-time snapshots of deployed code and configurations ## Serving resources -Knative Serving defines a set of principled objects as Kubernetes +Knative Serving defines a set of objects as Kubernetes Custom Resource Definitions (CRDs). These objects are used to define and control how your serverless workload behaves on the cluster: @@ -31,8 +31,8 @@ how your serverless workload behaves on the cluster: * [Configuration](https://github.com/knative/serving/blob/master/docs/spec/spec.md#configuration): The `configuration.serving.knative.dev` resource maintains the desired state for your deployment. It provides a clean separation between - code and configuration, following the Twelve-Factor App methodology. Modifying a configuration - will create a new revision. + code and configuration and follows the Twelve-Factor App methodology. Modifying a configuration + creates a new revision. * [Revision](https://github.com/knative/serving/blob/master/docs/spec/spec.md#revision): The `revision.serving.knative.dev` resource is a point in time snapshot of the code and configuration for each modification made to the workload. Revisions @@ -43,22 +43,21 @@ how your serverless workload behaves on the cluster: ## Getting Started To get started with Serving, check out one of the [hello world](samples/) sample projects. -These projects use the `Service` resource, which manages all the details for you. +These projects use the `Service` resource, which manages all of the details for you. With the `Service` resource, a deployed service will automatically have a matching route -and configuration created. Each time the `Service` is updated, a new revision will be +and configuration created. Each time the `Service` is updated, a new revision is created. For more information on the resources and their interactions, see the [Resource Types Overview](https://github.com/knative/serving/blob/master/docs/spec/overview.md) -in the Knative Serving repo. +in the Knative Serving repository. -To serve workloads from a custom domain, see [Use a custom domain](DNS.md) for details on how to override -the default `example.com` domain. +To serve workloads from a custom domain, see [Use a custom domain](DNS.md). ## Known Issues -See the [Knative Serving Issues](https://github.com/knative/serving/issues) for a full list of +See the [Knative Serving Issues](https://github.com/knative/serving/issues) page for a full list of known issues. * **No support for TLS** - Currently the Knative Serving components do not support TLS connections for @@ -75,4 +74,4 @@ known issues. ## Networking -* [Setting up DNS](./DNS.md) \ No newline at end of file +* [Setting up DNS](./DNS.md)