Skip to content

Commit 901b8db

Browse files
jgwestchetan-rns
andcommitted
Apply suggestions from code review
Co-authored-by: Chetan Banavikalmutt <[email protected]>
1 parent f42b2d0 commit 901b8db

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

docs/api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -288,9 +288,9 @@ See the [GitOpsDeploymentSyncRun API reference](https://redhat-appstudio.github.
288288
## GitOps Service: Stonesoup Environment APIs
289289

290290
The Stonesoup Environment API is based on the [Application](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#application), and [Component](https://redhat-appstudio.github.io/book/ref/application-environment-api.html#component) APIs, which are primarily handled by the [application-service](https://github.com/redhat-appstudio/application-service) component.
291-
- These APIs are opinionated representations of the constituent parts of a user's application: a application (e.g. a loan applicatin of a bank) contains multiple components (e.g. Node frontend, Java backend, Postgresql database).
291+
- These APIs are opinionated representations of the constituent parts of a user's application: a application (e.g. a loan application of a bank) contains multiple components (e.g. Node frontend, Java backend, Postgresql database).
292292

293-
The Stonesoup Environment APIs -- which are simultaneosly reconciled by multiple Stonesoup components -- are all related to provisioning or deploying K8s resources to external environments, such as external K8s clusters/namespaces or local namespaces.
293+
The Stonesoup Environment APIs -- which are simultaneously reconciled by multiple Stonesoup components -- are all related to provisioning or deploying K8s resources to external environments, such as external K8s clusters/namespaces or local namespaces.
294294

295295
### Environment
296296

docs/building.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The final binaries are then copied into `/usr/local/bin`, which is where they ar
3737

3838
### Build and push: using docker/podman
3939

40-
You may user docker or podman to build the containers.
40+
You may use docker or podman to build the containers.
4141
- To use podman, pass `DOCKER=podman` on the `make` calls.
4242
- For example: `USERNAME=(your quay.io username) DOCKER=podman make docker-build docker-push`
4343

docs/debug.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To reset the database to a clean state, run `./reset-db.sh`.
1414

1515
## Run PostgreSQL in Kubernetes
1616

17-
* **Note**: When developing in your local development environment, it is usually easier to run Kubernetes on your local machine using `create-dev-env.sh`, as described above.
17+
* **Note**: When developing in your local development environment, it is usually easier to run PostgreSQL on your local machine using `create-dev-env.sh`, as described above.
1818

1919
### Deploy PostgreSQL
2020

docs/development.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To do that, follow these steps:
4848

4949
For your curiosity, this _make target_ is making sure that:
5050

51-
* cluster-agent/bacckend/backend-shared/appstudio-controller/application-api CRDs and RBAC resources are applied into the cluster
51+
* cluster-agent/backend/backend-shared/appstudio-controller/application-api CRDs and RBAC resources are applied into the cluster
5252
* postgres full deployment is running on the cluster
5353

5454
In the end, you will see a similar output:

docs/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ make install-all-k8s IMG=quay.io/pgeorgia/gitops-service:latest # replace the IM
1212
```
1313

1414
This will automatically install all the required components into your Kubernetes cluster, in the `gitops` namespace.
15-
Notice that, the [Cluster-Agent] operator requires the `gitops-service-argocd` namespace which will also be created as well.
15+
Notice that, the [Cluster-Agent] controller requires the `gitops-service-argocd` namespace which will also be created as well.
1616

1717
```shell
1818
$ kubectl -n gitops get all

0 commit comments

Comments
 (0)