Skip to content

Commit

Permalink
improve golang/v3/v4 README template
Browse files Browse the repository at this point in the history
* correctly spell "until"
* correct grammar
* add previously-absent puncuation
* remove trailing whitespace

Signed-off-by: Mike Ball <mikedball@gmail.com>
  • Loading branch information
mdb committed Dec 12, 2022
1 parent 3adb0d3 commit d385fee
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions pkg/plugins/golang/v3/scaffolds/internal/templates/readme.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ You’ll need a Kubernetes cluster to run against. You can use [KIND](https://si
%s
2. Build and push your image to the location specified by ` + "`IMG`" + `:
%s
3. Deploy the controller to the cluster with the image specified by ` + "`IMG`" + `:
%s
Expand All @@ -87,18 +87,18 @@ To delete the CRDs from the cluster:
%s
### Undeploy controller
UnDeploy the controller to the cluster:
UnDeploy the controller from the cluster:
%s
## Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project
### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
### Test It Out
1. Install the CRDs into the cluster:
Expand Down
12 changes: 6 additions & 6 deletions pkg/plugins/golang/v4/scaffolds/internal/templates/readme.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ You’ll need a Kubernetes cluster to run against. You can use [KIND](https://si
%s
2. Build and push your image to the location specified by ` + "`IMG`" + `:
%s
3. Deploy the controller to the cluster with the image specified by ` + "`IMG`" + `:
%s
Expand All @@ -87,18 +87,18 @@ To delete the CRDs from the cluster:
%s
### Undeploy controller
UnDeploy the controller to the cluster:
UnDeploy the controller from the cluster:
%s
## Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project
### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/)
which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
### Test It Out
1. Install the CRDs into the cluster:
Expand Down

0 comments on commit d385fee

Please sign in to comment.