Skip to content

Commit b75fd8a

Browse files
authored
Merge pull request #179 from bartoszmajsak/patch-1
fix(docs): minor improvements in README.md
2 parents ebe7221 + 357ecbc commit b75fd8a

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ following methods are provided for installing the operator.
1515
### OpenShift
1616

1717
The operator is published as part of the built-in Community Operators in the Operator Hub on OpenShift 4. See the
18-
[OpenShift Install Guide][install_openshift] for more information on installing on the OpenShift platorm.
18+
[OpenShift Install Guide][install_openshift] for more information on installing on the OpenShift platform.
1919

2020
### Operator Lifecycle Manager
2121

@@ -29,9 +29,8 @@ Look at the [OLM Install Guide][install_olm] for an example using this approach
2929

3030
The operator can be installed manually if desired.
3131

32-
!!! info
33-
The manual installation method requires cluster credentials that provide the `cluster-admin` ClusterRole or
34-
equivalent.
32+
> [!IMPORTANT]
33+
> The manual installation method requires cluster credentials that provide the `cluster-admin` ClusterRole or equivalent.
3534
3635
The [Manual Installation Guide][install_manual] provides the steps needed to manually install the operator on any
3736
Kubernetes cluster.
@@ -58,7 +57,7 @@ This means that the same configuration option that are available when [installin
5857
When something changes on an existing `DaprControlPlane` resource or any resource generated by the operator, the operator works to reconfigure the cluster to ensure the actual state of the cluster matches the desired state.
5958

6059
> [!IMPORTANT]
61-
> The operator expect that a single `DaprControlPlane` named `dapr-control-plane` and placed in the same namespace where the operator runs exists in a given point in time.
60+
> The operator expect that a single `DaprControlPlane` named `dapr-control-plane` and placed in the same namespace where the operator runs exists at a given point in time.
6261
> Any additional `DaprControlPlane` resources will be moved to an `Error` state and ignored.
6362

6463
The `DaprControlPlane` Custom Resource consists of the following properties
@@ -83,7 +82,7 @@ Create a new Dapr Control Plane operator in the `openshift-operators` namespace
8382
kubectl apply -n openshift-operators -f config/samples/basic/dapr-basic.yaml
8483
```
8584

86-
There will be several Dapr controllers and resources created that should be familiar to anyone who has deployed Dapr beforeusing [helm](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/#install-with-helm-advanced):
85+
There will be several Dapr controllers and resources created that should be familiar to anyone who has deployed Dapr before using [helm](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/#install-with-helm-advanced):
8786

8887
```bash
8988
➜ kubecto tree daprcontrolplanes.operator.dapr.io dapr-control-plane
@@ -125,4 +124,4 @@ openshift-operators ├─ServiceAccount/dapr-placement
125124
openshift-operators ├─ServiceAccount/dapr-sentry - 67s
126125
openshift-operators └─StatefulSet/dapr-placement-server - 67s
127126
openshift-operators └─ControllerRevision/dapr-placement-server-6cb96b4b85 - 67s
128-
```
127+
```

0 commit comments

Comments
 (0)