Merge branch 'docs' of https://github.com/james-milligan/open-feature-operator into docs

Author: james-milligan

docs/README.md

@@ -12,7 +12,7 @@ Follow the documentation below to deploy the open feature operator to your local
 ## Configuration
 
 Configuration of the deployed sidecars is handled through the `FeatureFlagConfiguration` CRs defined in the `openfeature.dev/featureflagconfiguration` annotation of a deployed `PodSpec`. 
-> Configuration for the operator will be possible in the future, to help contribute [click here](https://github.com/open-feature/open-feature-operator/issues)
+> Further configuration of the operator will be possible in the future, to help contribute [click here](https://github.com/open-feature/open-feature-operator/issues)
 
 - [Annotations](./annotations.md)
 - [FeatureFlagConfigurations](./feature_flag_configuration.md)

docs/getting_started.md

@@ -4,7 +4,7 @@ Once you have [installed the operator](./installation.md) you can follow this gu
 
 ### Deploy a `FeatureFlagConfiguration`
 
-This `FeatureFlagConfiguration` will be watched by the injected `flagd` container to create a twin of its flag definitions internally. If multiple configurations are supplied to `flagd` these states will be combined.
+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.
 
 ```yaml
 apiVersion: core.openfeature.dev/v1alpha2
@@ -25,7 +25,7 @@ spec:
 
 ### Reference the deployed FeatureFlagConfiguration within a Deployment spec annotation.
 
-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).
+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).
 
 ```yaml
 apiVersion: apps/v1
@@ -57,7 +57,7 @@ spec:
 
 ### Confirm that operator has injected the `flagd` sidecar
 
-Once the `deployment.yaml` has been applied, our `Pod` should be created and contain 2 containers.
+Once the `deployment.yaml` has been applied, our `Pod` should be created grouping 2 containers.
 ```
 kubectl get pods -n default
 ```
@@ -83,9 +83,9 @@ kubectl describe pod busybox-curl-7bd5767999-spf7v
       FLAGD_METRICS_PORT:  8014
 ```
 
-Now that we have confirmed that the flagd sidecar has been injected and the configuration is correct we can test out the flag evaluation using curl.
+Now that we have confirmed that the `flagd` sidecar has been injected and the configuration is correct, we can test the flag evaluation using `curl`.
 
-> This would not be the usual method for evaluating flags in our applications, instead a language specific flagd provider would be used in conjunction with the OpenFeature SDK, documentation can be found [here](https://github.com/open-feature/flagd/blob/main/docs/usage/flagd_providers.md).
+> This is not the usual suggested best practice for evaluating flags in applications, typically a language specific `flagd` provider would be used in conjunction with the OpenFeature SDK, documentation can be found [here](https://github.com/open-feature/flagd/blob/main/docs/usage/flagd_providers.md).
 
 ```
 kubectl exec -it busybox-curl-7bd5767999-spf7v sh

docs/installation.md

@@ -3,7 +3,7 @@
 
 ## Prerequisites
 
-OpenFeature Operator is a server that communicates with Kubernetes components within the cluster, as such it requires a means of authorizing requests between peers. Cert manager handles the authorization by adding certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates.
+The OpenFeature Operator is a server that communicates with Kubernetes components within a cluster. As such, it requires a means of authorizing requests between peers. Cert manager handles authorization by adding certificates and certificate issuers as resource types in Kubernetes clusters. This simplifies the process of obtaining, renewing, and using those certificates.
 The installation docs for cert manager can be found [here](https://cert-manager.io/docs/installation/kubernetes/).
 Alternatively, running the commands below will install cert manager into the `cert-manager` namespace.
 

docs/permissions.md

@@ -9,7 +9,7 @@ The open feature operator uses the `open-feature-operator-controller-manager` se
 ### leader-election-role
 
 The `leader-election-role` provides the operator with the required permissions to perform leader election.
-The definition of this role can be found [here](../config//rbac//leader_election_role.yaml)
+The definition of this role can be found [here](../config/rbac//leader_election_role.yaml)
 
 | API Group      | Resource | Verbs |
 | ----------- | ----------- | ----------- |
@@ -20,7 +20,7 @@ The definition of this role can be found [here](../config//rbac//leader_election
 
 ### manager-role
 
-The `manager-role` applies the rules described below, its definition can be found [here](../config/rbac/role.yaml). It provides the operator permissions over the `core.openfeature.dev` resources, and the required permissions for injecting the `flagd` sidecar into appropriate pods. The `ConfigMap` permissions are needed to allow for the mounting of `FeatureFlagConfiguration` resources for filepath syncs.
+The `manager-role` applies the rules described below, its definition can be found [here](../config/rbac/role.yaml). It provides the operator with sufficient permissions over the `core.openfeature.dev` resources, and the required permissions for injecting the `flagd` sidecar into appropriate pods. The `ConfigMap` permissions are needed to allow the mounting of `FeatureFlagConfiguration` resources for filepath syncs.
 
 | API Group      | Resource | Verbs |
 | ----------- | ----------- | ----------- |