Skip to content

Commit fb0a550

Browse files
authored
docs: fixes (#54)
1 parent eb688fb commit fb0a550

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: docs/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Intro
44

55
Kubernetes Webhooks Framework makes it simple to
6-
implementing [admission controllers](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/)
6+
implement [admission controllers](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/)
77
and [conversion hooks](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-conversion)
88
for Kubernetes in Java.
99

@@ -16,10 +16,10 @@ Before you start make sure you understand these concepts in Kubernetes, reading
1616
There are samples both
1717
for [Spring Boot](https://github.com/java-operator-sdk/admission-controller-framework/tree/main/samples/spring-boot)
1818
and [Quarkus](https://github.com/java-operator-sdk/kubernetes-webooks-framework/tree/main/samples/quarkus), both of them
19-
implements the same logic. Both sync and async APIs
20-
are showcased. This documentation describes the Quarkus version, however Spring Boot version is almost identical.
19+
implement the same logic. Both sync and async APIs
20+
are showcased. This documentation describes the Quarkus version, however the Spring Boot version is almost identical.
2121

22-
There are two endpoint, one
22+
There are two endpoints, one
2323
for [admission controllers](https://github.com/java-operator-sdk/admission-controller-framework/blob/main/samples/quarkus/src/main/java/io/javaoperatorsdk/webhook/sample/admission/AdmissionEndpoint.java)
2424
(a validating and a mutating) and one for the
2525
sample [conversion hook](https://github.com/java-operator-sdk/admission-controller-framework/blob/76fd9c4b9fef6738310a7dd97b159c3668ced9f1/samples/quarkus/src/main/java/io/javaoperatorsdk/webhook/sample/conversion/ConversionEndpoint.java)
@@ -29,7 +29,7 @@ Starting from those endpoints, it should be trivial to understand how the underl
2929

3030
### End-To-End Tests
3131

32-
The goal of the end-to-end tests is to test the framework in a production like environment, but also works as an
32+
The goal of the end-to-end tests is to test the framework in a production-like environment, but also works as an
3333
executable documentation to guide developers how to deploy and configure the target service.
3434

3535
The [end-to-end tests](https://github.com/java-operator-sdk/admission-controller-framework/blob/main/samples/quarkus/src/test/java/io/javaoperatorsdk/webhook/sample/QuarkusWebhooksE2E.java)
@@ -54,7 +54,7 @@ using [dekorate](https://github.com/java-operator-sdk/admission-controller-frame
5454
</dependency>
5555
```
5656

57-
Only additional resources used for admission hooks, are present in
57+
Only additional resources used for admission hooks are present in
5858
the [k8s](https://github.com/java-operator-sdk/admission-controller-framework/tree/main/samples/quarkus/k8s)
5959
directory. These are the configuration files to configure the admission hooks. For example the configuration for
6060
validation look like:
@@ -150,7 +150,7 @@ public interface Mapper<R extends HasMetadata, HUB> {
150150
```
151151

152152
It handles mapping to and from a Hub. Hub is an intermediate representation in a conversion. Thus, the conversion
153-
steps from v1 to v2 happens in the following way: v1 -> HUB -> v2. Using the provided v1 and v2 mappers implementations.
154-
Having this approach is useful mainly in case there are more than two version of resources on the cluster, so there is
153+
steps from v1 to v2 happen in the following way: v1 -> HUB -> v2. Using the provided v1 and v2 mappers implementations.
154+
Having this approach is useful mainly in case there are more than two versions of resources on the cluster, so there is
155155
no need for a mapper for every combination. See also related docs in
156156
[Kubebuilder](https://book.kubebuilder.io/multiversion-tutorial/conversion-concepts.html).

0 commit comments

Comments
 (0)