README: fix typos and remove redundancy #128
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fanminshi
reviewed
Mar 23, 2018
README.md
Outdated
| ``` | ||
|
|
||
| ## Creating a new project | ||
| This should install the CLI binary `operator-sdk` at `$GOPATH/bin`. |
There was a problem hiding this comment.
Hmm, I think go install always installs the binary under $GOPATH/bin? correct me if I am wrong.
If that's the case, we probably should say This installs to be more certain.
Also I think we should be have a tone with certainty in our readme; hence avoid any phrase meaning likely or probable.
README.md
Outdated
| ``` | ||
|
|
||
| This generates a project repo `memcached-operator`, a custom resource with APIVersion `cache.example.com/v1apha1` and Kind `Memcached`, and an example operator that watches all deployments in the same namespace and logs deployment names. | ||
| This creates the project directory `memcached-operator`, and generates the API pkg tree for a custom resource with APIVersion `cache.example.com/v1apha1` and Kind `Memcached`. |
There was a problem hiding this comment.
memcached-operator, and -> memcached-operator and?
No ,?
README.md
Outdated
| At this point we are ready to build and run a functional operator. | ||
|
|
||
| The default operator behaviour as seen in the entrypoint `cmd/memcached-operator/main.go` is to watch for Deployments in the default namespace and print out their names. | ||
| The default operator behaviour defined in the entrypoint `cmd/memcached-operator/main.go` is to watch for Deployments in the default namespace and print out their names. |
There was a problem hiding this comment.
also change entrypoint -> entry point?
| ``` | ||
|
|
||
| Check memcached-operator pod’s log: | ||
| Check the memcached-operator pod’s log: |
There was a problem hiding this comment.
suggest to change
The memcached-operator would be up and running: at line 111
to
Verify that the memcached-operator is up and running:
|
Fixed. |
|
lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed a few typos, changed the phrasing in a few places to clarify acronyms, and removed repeated explanations.
/cc @fanminshi