From 87ed43782b7ed87336be487a812112865c1d1b36 Mon Sep 17 00:00:00 2001
From: Jessica Yao <jessica@heptio.com>
Date: Mon, 27 Nov 2017 09:16:21 -0800
Subject: [PATCH] small readme and install fixes
Signed-off-by: Jessica Yao <jessica@heptio.com>
---
README.md | 6 ++++--
cmd/show.go | 6 +++---
docs/README.md | 2 +-
docs/build-install.md | 2 +-
docs/cli-reference/ks_show.md | 6 +++---
5 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index f9567010..61e5c462 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,11 @@ All of this results in a more iterative process for developing manifests, one th
## Install
+The ksonnet CLI, `ks`, can be installed in three different ways. Choose the method that best matches your setup:
+
### Homebrew on macOS
-If you are using [Homebrew](https://brew.sh/) on macOS, you can easily install `ks`.
+If you are using [Homebrew](https://brew.sh/) on macOS, you can easily install `ks` with the following command:
```
brew install ksonnet/tap/ks
@@ -153,7 +155,7 @@ Thanks for taking the time to join our community and start contributing!
#### Before you start
* Please familiarize yourself with the [Code of
-Conduct](CODE_OF_CONDUCT.md) before contributing.
+Conduct](CODE-OF-CONDUCT.md) before contributing.
* Read the contribution guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).
* There is a [mailing list](https://groups.google.com/forum/#!forum/ksonnet) and [Slack channel](https://ksonnet.slack.com/) if you want to interact with
other members of the community.
diff --git a/cmd/show.go b/cmd/show.go
index b66e558c..c27e20f2 100644
--- a/cmd/show.go
+++ b/cmd/show.go
@@ -41,13 +41,13 @@ var showCmd = &cobra.Command{
Short: "Show expanded manifests for a specific environment.",
Long: `Show expanded manifests (resource definitions) for a specific environment. Jsonnet manifests,
each defining a ksonnet component, are expanded into their JSON or YAML equivalents (YAML is the default).
-Any parameters for a component are resolved based on environment-specific values.
+Any parameters in these Jsonnet manifests are resolved based on environment-specific values.
-When NO component is specified via the` + "`-c`" + `flag, this command expands all of the files in the ` +
+When NO component is specified (no ` + "`-c`" + ` flag), this command expands all of the files in the ` +
"`components/`" + ` directory into a list of resource definitions. This is the YAML version
of what gets deployed to your cluster with ` + "`ks apply <env>`" + `.
-When a component IS specified via the` + "`-c`" + `flag, this command only expands the manifest for that
+When a component IS specified via the ` + "`-c`" + ` flag, this command only expands the manifest for that
particular component.`,
Example: `# Show all of the components for the 'dev' environment, in YAML
# (In other words, expands all manifests in the components/ directory)
diff --git a/docs/README.md b/docs/README.md
index 42e21e45..5c5e4a35 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,6 +2,6 @@
While the ksonnet site updates are still pending, you can find additional documentation in this directory:
-* [Manual build and install](/docs/build-install.md)
+* [Manually build and install](/docs/build-install.md)
* [CLI reference](/docs/cli-reference#command-line-reference)
* [Concept reference](/docs/concepts.md)
diff --git a/docs/build-install.md b/docs/build-install.md
index be1c3afc..db3d5491 100644
--- a/docs/build-install.md
+++ b/docs/build-install.md
@@ -19,7 +19,7 @@ If your ksonnet is properly installed, you should be able to run `ks --help` and
If you're using macOS, trying adding the line `export GOPATH=$HOME/go` to the end of your `$HOME/.bash_profile`.
Other systems may have different `$GOPATH` defaults (e.g. `/usr/local/go`), in which case you should use those instead.
- If you get stuck, [these instructions](https://github.com/golang/go/wiki/SettingGOPATH) may help).
+ (If you get stuck, [these instructions](https://github.com/golang/go/wiki/SettingGOPATH) may help).
The ksonnet Makefile assumes you have one and only one directory in your `$GOPATH`.
diff --git a/docs/cli-reference/ks_show.md b/docs/cli-reference/ks_show.md
index f10fa429..c245f4d0 100644
--- a/docs/cli-reference/ks_show.md
+++ b/docs/cli-reference/ks_show.md
@@ -7,12 +7,12 @@ Show expanded manifests for a specific environment.
Show expanded manifests (resource definitions) for a specific environment. Jsonnet manifests,
each defining a ksonnet component, are expanded into their JSON or YAML equivalents (YAML is the default).
-Any parameters for a component are resolved based on environment-specific values.
+Any parameters in these Jsonnet manifests are resolved based on environment-specific values.
-When NO component is specified via the`-c`flag, this command expands all of the files in the `components/` directory into a list of resource definitions. This is the YAML version
+When NO component is specified (no `-c` flag), this command expands all of the files in the `components/` directory into a list of resource definitions. This is the YAML version
of what gets deployed to your cluster with `ks apply <env>`.
-When a component IS specified via the`-c`flag, this command only expands the manifest for that
+When a component IS specified via the `-c` flag, this command only expands the manifest for that
particular component.
```
--
GitLab