Skip to content

Commit f19dff8

Browse files
authored
DOC: Fixed typos and errors in documentation (#816)
1 parent 20d04d6 commit f19dff8

File tree

8 files changed

+16
-16
lines changed

8 files changed

+16
-16
lines changed

docs/setup/install/installation-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ helm install devtron devtron/devtron-operator --create-namespace --namespace dev
2727
|AZURE_BLOB_CONTAINER_CI_LOG | Name of container created for storing CI_LOG| ci-log-container| Optional|
2828
|AZURE_BLOB_CONTAINER_CI_CACHE | Name of container created for storing CI_CACHE| ci-cache-container| Optional|
2929
|BLOB_STORAGE_PROVIDER | Cloud provider name which you will use| MINIO| Mandatory (If using any cloud other than MINIO), MINIO/AZURE/S3|
30-
|DEFAULT_BUILD_LOGS_BUCKET | S3 Bucket name used for storing Build Logs| devtron-ci-log| Mandoatory (If using AWS)|
30+
|DEFAULT_BUILD_LOGS_BUCKET | S3 Bucket name used for storing Build Logs| devtron-ci-log| Mandatory (If using AWS)|
3131
|DEFAULT_CD_LOGS_BUCKET_REGION | Region of S3 Bucket where CD Logs are being stored| us-east-1| Mandatory (If using AWS)|
3232
|DEFAULT_CACHE_BUCKET | S3 Bucket name used for storing CACHE (Do not include s3://)| devtron-ci-cache| Mandatory (If using AWS)|
33-
|DEFAULT_CACHE_BUCKET_REGION | S3 Bucket region where Cache is being stored| us-east-1| Mandoatory (If using AWS)|
33+
|DEFAULT_CACHE_BUCKET_REGION | S3 Bucket region where Cache is being stored| us-east-1| Mandatory (If using AWS)|
3434
|EXTERNAL_SECRET_AMAZON_REGION | Region where the cluster is setup for Devtron installation| ""| Mandatory (If using AWS)|
3535
|ENABLE_INGRESS | To enable Ingress (True/False)| False| Optional|
3636
|INGRESS_ANNOTATIONS | Annotations for ingress| ""| Optional|

docs/setup/install/override-default-devtron-installation-configs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In order to modify particular object it looks in namespace `devtroncd` for corre
1111
|clair| clair-config-override-cm| clair configuration|
1212
|dashboard| dashboard-override-cm| ui of devtron|
1313
|gitSensor| git-sensor-override-cm| microservice for git interaction|
14-
|guard| guard-override-cm| validaing webhook to block images with security violations|
14+
|guard| guard-override-cm| validating webhook to block images with security violations|
1515
|postgresql| postgresql-override-cm| db store of devtron|
1616
|imageScanner| image-scanner-override-cm| image scanner for vulnerability|
1717
|kubewatch| kubewatch-override-cm| watches changes in ci and cd running in different clusters|
@@ -76,7 +76,7 @@ After files being applied, you are ready to install your Devtron instance with p
7676
### Post-Devtron Installation
7777
If you have an existing Devtron instance and want to migrate it for production ready deployments, this is the right option for you.
7878

79-
In the existing namesapce, apply the production overrides as we do it above.
79+
In the existing namespace, apply the production overrides as we do it above.
8080
```bash
8181
kubectl apply -f prod-configs -n devtroncd
8282
```

docs/user-guide/creating-application/deployment-template.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,11 @@ ReadinessProbe:
131131

132132
| Key | Description |
133133
| :--- | :--- |
134-
| `Path` | It define the path where the rediness needs to be checked. |
134+
| `Path` | It define the path where the readiness needs to be checked. |
135135
| `failureThreshold` | It defines the maximum number of failures that are acceptable before a given container is not considered as ready. |
136136
| `initialDelaySeconds` | It defines the time to wait before a given container is checked for readiness. |
137137
| `periodSeconds` | It defines the time to check a given container for readiness. |
138-
| `successThreshold` | It defines the number of successes required before a given container is said to fulfil the rediness probe. |
138+
| `successThreshold` | It defines the number of successes required before a given container is said to fulfill the readiness probe. |
139139
| `timeoutSeconds` | It defines the time for checking timeout. |
140140
| `httpHeader` | Custom headers to set in the request. HTTP allows repeated headers,You can override the default headers by defining .httpHeaders for the probe. |
141141
| `scheme` | Scheme to use for connecting to the host (HTTP or HTTPS). Defaults to HTTP.
@@ -231,7 +231,7 @@ Specialized containers that run before app containers in a Pod. Init containers
231231
```yaml
232232
pauseForSecondsBeforeSwitchActive: 30
233233
```
234-
To wait for given period of time before swith active the container.
234+
To wait for given period of time before switch active the container.
235235

236236
### Resources
237237

@@ -474,7 +474,7 @@ serviceAccountName: orchestrator
474474

475475
A service account provides an identity for the processes that run in a Pod.
476476

477-
When you access the cluster, you are authenticated by the apiserver as a particular User Account. Processes in containers inside pod can also contact the apiserver. When you are authenticated as a particular Service Account.
477+
When you access the cluster, you are authenticated by the API server as a particular User Account. Processes in containers inside pod can also contact the API server. When you are authenticated as a particular Service Account.
478478

479479
When you create a pod, if you do not create a service account, it is automatically assigned the default service account in the namespace.
480480

@@ -492,7 +492,7 @@ You can specify `maxUnavailable` and `minAvailable` in a `PodDisruptionBudget`.
492492

493493
With `minAvailable` of 1, evictions are allowed as long as they leave behind 1 or more healthy pods of the total number of desired replicas.
494494

495-
With `maxAvailable` of 1, evictions are allowed as long as atmost 1 unhealthy replica among the total number of desired replicas.
495+
With `maxAvailable` of 1, evictions are allowed as long as at most 1 unhealthy replica among the total number of desired replicas.
496496

497497
### Application metrics Envoy Configurations
498498

docs/user-guide/creating-application/git-material.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Note:
2929

3030
## 3. Checkout Path
3131

32-
After clicking on checbox, git checkout path field appears. The git checkout path is the directory where your code is pulled or cloned for the repository you specified in the previous step.
32+
After clicking on checkbox, git checkout path field appears. The git checkout path is the directory where your code is pulled or cloned for the repository you specified in the previous step.
3333

3434
This field is optional in case of a single git repository application and you can leave the path as default. Devtron assigns a directory by itself when the field is left blank. The default value of this field is `./`
3535

docs/user-guide/creating-application/secrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ There are five Data types that you can use to save your secret.
2929
* **Kubernetes External Secret**: The secret data of your application is fetched by Devtron externally. Then the Kubernetes External Secret is converted to Kubernetes Secret.
3030
* **AWS Secret Manager**: The secret data of your application is fetched from AWS Secret Manager and then converted to Kubernetes Secret from AWS Secret.
3131
* **AWS System Manager**: The secret data for your application is fetched from AWS System Secret Manager and all the secrets stored in AWS System Manager are converted to Kubernetes Secret.
32-
* **Hashi Corp Vault**: The secret data for your application is fetched from Hashi Corp Vault and the secrets stored in Harshi Corp Vault are converted to Kubernetes Secret.
32+
* **Hashi Corp Vault**: The secret data for your application is fetched from Hashi Corp Vault and the secrets stored in Hashi Corp Vault are converted to Kubernetes Secret.
3333

3434
*Note: The conversion of secrets from various data types to Kubernetes Secrets is done within Devtron and irrespective of the data type, after conversion, the Pods access `secrets` normally.*
3535

docs/user-guide/global-configurations/manage-notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Click on `Add` and configure SES.
2222

2323
| Key | Description |
2424
| :--- | :--- |
25-
| `Configuation Name` | Give a name to the SES Configuration |
25+
| `Configuration Name` | Give a name to the SES Configuration |
2626
| `Access Key ID` | Valid AWS Access Key ID |
2727
| `Secret Access Key` | Valid AWS Secret Access Key |
2828
| `AWS Region` | Select the AWS Region from the drop-down menu |

docs/user-guide/global-configurations/user-access.md

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

44
{% embed url="https://www.youtube.com/watch?v=VTqBRIFbuSU" caption="" %}
55

6-
Like any entreprise product, Devtron supports fine grained access control to the resources based on
6+
Like any enterprise product, Devtron supports fine grained access control to the resources based on
77
1. Type of action allowed on the Devtron resources (Create Vs View)
88
2. Sensitivity of the data (Editing image Vs Editing memory)
99

docs/user-guide/user-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ It is designed as a self-serve platform for operationalizing and maintaining app
1616

1717
#### Zero code software delivery workflow
1818

19-
* Workflow which understands the domain of **kubernetes, testing, CD, SecOps** so that you dont have to write scripts
20-
* Reusable and composable components so that workflows are easy to contruct and reason through
19+
* Workflow which understands the domain of **kubernetes, testing, CD, SecOps** so that you don't have to write scripts
20+
* Reusable and composable components so that workflows are easy to construct and reason through
2121

2222
#### Multi cloud deployment
2323

@@ -53,7 +53,7 @@ It is designed as a self-serve platform for operationalizing and maintaining app
5353

5454
#### Gitops aware
5555

56-
* Gitops exposed through API and UI so that you dont have to interact with git cli
56+
* Gitops exposed through API and UI so that you don't have to interact with git cli
5757
* Gitops backed by postgres for easier analysis
5858
* Enforce finer access control than git
5959

0 commit comments

Comments
 (0)