Skip to content

Commit b3f3447

Browse files
Apply suggestions from code review
Co-authored-by: Todd Baert <[email protected]> Signed-off-by: James Milligan <[email protected]>
1 parent 9cd5b95 commit b3f3447

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
## Get started
1717

18-
The OpenFeature Operator is a Kubernetes native operator that allows you to expose feature flags to your applications. It injects a [flagD](https://github.com/open-feature/flagd) sidecar into your pod and allows you to poll the flagD server for feature flags in a variety of ways. To get started, follow the installation instructions in the [docs](./docs).
18+
The OpenFeature Operator allows you to expose feature flags to your applications. It injects a [flagD](https://github.com/open-feature/flagd) sidecar into relevant pods exposes gRPC and HTTP interfaces for flag evaluation. To get started, follow the installation instructions in the [docs](./docs).
1919

2020
## Contributing
2121

docs/feature_flag_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ spec:
2727

2828
Within the CRD there are 2 main objects, namely the `flagDSpec` and the `featureFlagSpec`, both offering a different set of configuration for the injected `flagd` sidecars.
2929

30-
The `featureFlagSpec` is a json object representing the flag configurations themselves, the documentation for this object can be found [here](https://github.com/open-feature/flagd/blob/main/docs/configuration/flag_configuration.md).
30+
The `featureFlagSpec` is an object representing the flag configurations themselves, the documentation for this object can be found [here](https://github.com/open-feature/flagd/blob/main/docs/configuration/flag_configuration.md).
3131

3232
The `flagDSpec` has one property called `envs` which contains a list of environment variables used to override the default start command values in `flagd`, the documentation for this configuration can be found [here](https://github.com/open-feature/flagd/blob/main/docs/configuration/configuration.md).

docs/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Once you have [installed the operator](./installation.md) you can follow this gu
44

55
### Deploy a `FeatureFlagConfiguration`
66

7-
This `FeatureFlagConfiguration` will be watched by the injected `flagd` container and used to construct its internal flag definitions state. If multiple configurations are supplied to `flagd` these states will be merged.
7+
This `FeatureFlagConfiguration` is watched by the injected `flagd` container and used to construct its internal flag definitions state. If multiple configurations are supplied to `flagd` these states will be merged.
88

99
```yaml
1010
apiVersion: core.openfeature.dev/v1alpha2
@@ -25,7 +25,7 @@ spec:
2525
2626
### Reference the deployed FeatureFlagConfiguration within a Deployment spec annotation.
2727
28-
In this example, we will be creating a `Deployment` containing an `busybox-curl` container. In the example below, the `metadata.annotations` object contains the required annotations for the operator to correctly configure and inject the `flagd` sidecar into each deployed `Pod`. The documentation for these annotations can be found [here](./annotations.md).
28+
In this example, a`Deployment` containing a `busybox-curl` container is created. In the example below, the `metadata.annotations` object contains the required annotations for the operator to correctly configure and inject the `flagd` sidecar into each deployed `Pod`. The documentation for these annotations can be found [here](./annotations.md).
2929

3030
```yaml
3131
apiVersion: apps/v1
@@ -66,7 +66,7 @@ Should give a similar output to the following
6666
NAME READY STATUS RESTARTS AGE
6767
busybox-curl-7bd5767999-spf7v 0/2 ContainerCreating 0 2s
6868
```
69-
If we describe our `Pod` we should should see that the injected sidecar has the following configuration:
69+
When the `Pod` is described, the injected sidecar has the following configuration:
7070
```
7171
kubectl describe pod busybox-curl-7bd5767999-spf7v
7272
```

0 commit comments

Comments
 (0)