cleanup

Signed-off-by: James Milligan <[email protected]>

Author: james-milligan

docs/annotations.md

@@ -5,7 +5,7 @@ The following annotations are used by the operator to control the injection and
 ### `openfeature.dev/enabled`
 When a value of `"true"` is provided, the operator will inject a flagd sidecar into the annotated pods.  
 Example: 
-```
+```yaml
     metadata:
     annotations:
         openfeature.dev/enabled: "true"
@@ -16,7 +16,7 @@ This annotation specifies the names of the FeatureFlagConfigurations used to con
 The annotation value a comma separated list of values following one of 2 patterns: {NAME} or {NAMESPACE}/{NAME}. 
 If no namespace is provided it is assumed that the CR is within the same namespace as the deployed pod.
 Example:
-```
+```yaml
     metadata:
     annotations:
         openfeature.dev/enabled: "true"
@@ -28,7 +28,7 @@ Example:
 
 When a value of `"enabled"` is provided, the operator will inject a flagd sidecar into the annotated pods.  
 Example: 
-```
+```yaml
     metadata:
     annotations:
         openfeature.dev: "enabled"

docs/development_notes.md

@@ -3,7 +3,7 @@
 ## Running the operator locally
 
 The project `Makefile` defines a useful method for locally deploying the operator, allowing for the operator image to be defined:
-```
+```sh
 IMG=ghcr.io/open-feature/open-feature-operator:main make deploy-operator
 ```
 

docs/getting_started.md

@@ -58,16 +58,16 @@ spec:
 ### Confirm that operator has injected the `flagd` sidecar
 
 Once the `deployment.yaml` has been applied, our `Pod` should be created grouping 2 containers.
-```
+```sh
 kubectl get pods -n default
 ```
 Should give a similar output to the following
-```
+```sh
 NAME                                                READY   STATUS              RESTARTS   AGE
 busybox-curl-7bd5767999-spf7v                              0/2     ContainerCreating   0          2s
 ```
 When the `Pod` is described, the injected sidecar has the following configuration:
-```
+```sh
 kubectl describe pod busybox-curl-7bd5767999-spf7v
 ```
 ```yaml
@@ -87,11 +87,11 @@ Now that we have confirmed that the `flagd` sidecar has been injected and the co
 
 > 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).
 
-```
+```sh
 kubectl exec -it busybox-curl-7bd5767999-spf7v sh
 curl -X POST "localhost:8013/schema.v1.Service/ResolveString" -d '{"flagKey":"foo","context":{}}' -H "Content-Type: application/json"
 ```
 output:
-```
+```sh
 {"value":"BAR","reason":"DEFAULT","variant":"bar"}
 ```

docs/installation.md

@@ -7,37 +7,37 @@ The OpenFeature Operator is a server that communicates with Kubernetes component
 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.
 
-```
+```sh
 kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.10.1/cert-manager.yaml
 kubectl wait --for=condition=Available=True deploy --all -n 'cert-manager'
 ```
 
 ## Helm
 
 Add the chart repository to helm:
-```
+```sh
 helm repo add openfeature https://open-feature.github.io/open-feature-operator/
 ```
 Install the OFO helm charts:
-```
+```sh
 helm install ofo openfeature/ofo
 ```
 ### Uninstall
-```
+```sh
 helm uninstall ofo
 ```
 
 ## kubectl
 Apply the release yaml directly via kubectl
 <!---x-release-please-start-version-->
-```
+```sh
 kubectl create namespace open-feature-operator-system
 kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
 ```
 <!---x-release-please-end-->
 ### Uninstall
 <!---x-release-please-start-version-->
-```
+```sh
 kubectl delete -f https://github.com/open-feature/open-feature-operator/releases/download/v0.2.20/release.yaml
 kubectl delete namespace open-feature-operator-system
 ```