diff --git a/docs/README.md b/docs/README.md index 7ed057cb4..3589e103a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,7 +13,7 @@ You can grab the latest nightly binary executable for: Put it on your system path, and make sure it's executable. -Alternately, check out the client repository, and type: +Alternatively, check out the client repository, and type: ```bash go install ./cmd/kn @@ -36,13 +36,13 @@ with `--kubeconfig`, or the env var `$KUBECONFIG`, for any command. ## Commands -See the [generated documentation.](cmd/kn.md) +See the [generated documentation](cmd/kn.md) ### Service Management -A Knative service is the embodiment of a serverless workload. Generally in the form of a collection of containers running in a group of pods in the underlying Kubernetes cluster. Each Knative service associates with a collection of revisions which represents the evolution of that service. +A Knative service is the embodiment of a serverless workload. It is generally in the form of a collection of containers running in a group of pods, in the underlying Kubernetes cluster. Each Knative service associates with a collection of revisions, which represent the evolution of that service. -With the Kn CLI a user can [`list`](cmd/kn_service_list.md), [`create`](cmd/kn_service_create.md), [`delete`](cmd/kn_service_delete.md), and [`update`](cmd/kn_service_update.md) Knative services. The [detail reference](cmd/kn_service.md) of each sub-command under the [`service` command](cmd/kn_service.md) shows the options and flags for this group of commands. +With the Kn CLI a user can [`list`](cmd/kn_service_list.md), [`create`](cmd/kn_service_create.md), [`delete`](cmd/kn_service_delete.md), and [`update`](cmd/kn_service_update.md) Knative services. The [detail reference](cmd/kn_service.md) of each sub-command under the [`service`](cmd/kn_service.md) command shows the options and flags for this group of commands. Examples: @@ -52,7 +52,7 @@ Examples: kn service create mysvc --env KEY1=VALUE1 --env KEY2=VALUE2 --image dev.local/ns/image:latest ``` -You are able to also specify the requests and limits of both CPU and memory when creating a service. See [`service create` command](cmd/kn_service_create.md) reference for additional details. +You are able to also specify the requests and limits of both CPU and memory when creating a service. See [`service create`](cmd/kn_service_create.md) command reference for additional details. ```bash # List existing services in the 'default' namespace of your cluster @@ -60,13 +60,13 @@ You are able to also specify the requests and limits of both CPU and memory when kn service list ``` -You can also list services from all namespaces or specific namespace using flags: `--all-namespaces` and `--namespace mynamespace`. See [`service list` command](cmd/kn_service_list.md) reference for additional details. +You can also list services from all namespaces or a specific namespace using flags: `--all-namespaces` and `--namespace mynamespace`. See [`service list`](cmd/kn_service_list.md) command reference for additional details. ### Revision Management -A Knative revision is a "snapshot" of the specification of a service. For instance, when a Knative service is created with environment variable `FOO=bar` a revision is added to the service. When later the environment variable is changed to `baz` or additional variables are added, a new revision is created. When the image the service is running is changed to a new digest, a new revision is created. +A Knative revision is a "snapshot" of the specification of a service. For instance, when a Knative service is created with the environment variable `FOO=bar` a revision is added to the service. Afterwards, when the environment variable is changed to `baz` or additional variables are added, a new revision is created. When the image that the service is running is changed to a new digest, a new revision is created. -With the [`revision` command group](cmd/kn_revision.md) you can [list](cmd/kn_revision_list.md) and [describe](cmd/kn_revision_describe.md) the current revisions on a service. +With the [`revision`](cmd/kn_revision.md) command group you can [list](cmd/kn_revision_list.md) and [describe](cmd/kn_revision_describe.md) the current revisions on a service. Examples: @@ -81,8 +81,8 @@ kn revision list --service srvc # CHECK this since current command does not have These are commands that provide some useful information to the user. * The `kn help` command displays a list of the commands with helpful information. -* The [`kn version` command](cmd/kn_version.md) will display the current version of the `kn` build including date and Git commit revision. -* The [`kn completion` command](cmd/kn_completion.md) will output a BASH completion script for `kn` to allow command completions with tabs. +* The [`kn version`](cmd/kn_version.md) command will display the current version of the `kn` build including date and Git commit revision. +* The [`kn completion`](cmd/kn_completion.md) command will output a BASH completion script for `kn` to allow command completions with tabs. ### Common Flags