Skip to content

Commit 050e4b4

Browse files
authored
docs: Fixes + Corrections in Docs (#5335)
* Fixes + Corrections in Docs * PM Feedback Incorporated
1 parent 3e8e3bf commit 050e4b4

File tree

10 files changed

+48
-284
lines changed

10 files changed

+48
-284
lines changed

docs/FAQs/devtron-troubleshoot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ kubectl get pods -n devtroncd
2020
kubectl delete jobs <job1-name> <job2-name> -n devtroncd
2121
```
2222

23-
- Now download `migrator.yaml` file from our github repository using the command:
23+
- Now download `migrator.yaml` file from our GitHub repository using the command:
2424
```bash
2525
wget https://raw.githubusercontent.com/devtron-labs/devtron/main/manifests/yamls/migrator.yaml
2626
```

docs/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@
7676
* [CI Pipeline](user-guide/creating-application/workflow/ci-pipeline.md)
7777
* [Pre-Build/Post-Build Stages](user-guide/creating-application/workflow/ci-build-pre-post-plugins.md)
7878
* [Override Build Configuration](user-guide/creating-application/container-registry-override.md)
79-
* [CI Pipeline (Legacy)](user-guide/creating-application/workflow/ci-pipeline-legacy.md)
8079
* [CD Pipeline](user-guide/creating-application/workflow/cd-pipeline.md)
8180
* [ConfigMaps](user-guide/creating-application/config-maps.md)
8281
* [Secrets](user-guide/creating-application/secrets.md)

docs/reference/glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ However, in case you don't have a Dockerfile, Devtron helps you create one. Go t
9898

9999
Evacuating pods from a node before cordoning it, ensuring that running pods are gracefully rescheduled on other nodes.
100100

101-
In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/clusters.md#drain-a-node)
101+
In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/resource-browser.md#drain-a-node)
102102

103103
### Environment
104104

@@ -164,7 +164,7 @@ In Devtron, you can view a list of namespaces by going to Resource Browser → (
164164

165165
A setting applied to a node that influences the scheduling of pods. Taints can restrict which pods are allowed to run on the node.
166166

167-
In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/clusters.md#taint-a-node)
167+
In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/resource-browser.md#taint-a-node)
168168

169169
### NodePort
170170

@@ -174,7 +174,7 @@ A Kubernetes service type that exposes a port on each node in the cluster, makin
174174

175175
The physical or virtual machines that make up a Kubernetes cluster, where containers are scheduled to run.
176176

177-
In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/clusters.md#nodes)
177+
In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/resource-browser.md#nodes)
178178

179179
### Objects
180180

docs/user-guide/creating-application/environment-overrides.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
You will see all your environments associated with an application under the `Environment Overrides` section.
44

5-
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override.jpg)
5+
![Figure 1: App Configuration → Environment Overrides](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override-v2.jpg)
66

77

88
You can customize your `Deployment template, ConfigMap, Secrets` in Environment Overrides section to add separate customizations for different environments such as dev, test, integration, prod, etc.
@@ -50,9 +50,16 @@ The same goes for `ConfigMap` and `Secrets`. You can also create an environment-
5050

5151
If you want to configure your ConfigMap and secrets at the application level then you can provide them in [ConfigMaps](config-maps.md) and [Secrets](secrets.md), but if you want to have environment-specific ConfigMap and secrets then provide them under the Environment override Section. At the time of deployment, it will pick both of them and provide them inside your cluster.
5252

53-
Click on `Update ConfigMap` to update Configmaps.
53+
To update a ConfigMap, follow the steps below:
54+
1. In your environment, click **ConfigMaps**.
55+
2. Click the ConfigMap you wish to update.
56+
3. Click **Allow Override**.
57+
4. Edit your ConfigMap.
58+
5. Click **Save Changes**.
5459

55-
Click on `Update Secrets` to update Secrets.
60+
![Figure 2: Updating ConfigMap](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-configmap.gif)
5661

57-
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/arora4.gif)
62+
Similarly, you can update Secrets too as shown below.
63+
64+
![Figure 3: Updating Secret](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/update-secret.gif)
5865

docs/user-guide/creating-application/gitops-config.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ GitOps repositories, whether auto-created by Devtron or added manually, are immu
4242

4343
![Figure 3: Saved GitOps Config](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/saved-config.jpg)
4444

45-
**Note**: In case you skipped the GitOps configuration for your application and proceeded towards the [creation of a new CD pipeline](../creating-application/workflow/cd-pipeline.md#creating-cd-pipeline)(that uses GitOps), you will be prompted to configure GitOps as shown below:
45+
**Note**: In case you skipped the GitOps configuration for your application and proceeded towards the [creation of a new CD pipeline](../creating-application/workflow/cd-pipeline.md#creating-cd-pipeline) (that uses GitOps), you will be prompted to configure GitOps as shown below:
4646

4747
![Figure 4: Incomplete GitOps Config](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/gitops-not-configured.jpg)
4848

@@ -59,23 +59,25 @@ You can [deploy a helm chart](../deploy-chart/overview-of-charts.md#deploying-ch
5959

6060
![Figure 6: Configure & Deploy Button](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/configure-deploy.jpg)
6161

62-
3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear.
62+
3. After you enter the `App Name`, `Project`, and `Environment`; an option to choose the deployment approach (i.e., Helm or GitOps) would appear. Select **GitOps**.
6363

64-
![Figure 7: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg)
64+
{% hint style="info" %}
65+
The option to choose between 'Helm' or 'GitOps' is only available in <img src="https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg">
66+
{% endhint %}
6567

66-
4. Select **GitOps**.
68+
![Figure 7a: Deployment Approach](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/deployment-method.jpg)
6769

68-
![Figure 8: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg)
70+
![Figure 7b: Selecting GitOps Method](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/select-gitops.jpg)
6971

70-
5. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options:
72+
4. A modal window will appear for you to enter a Git repository. Just like [Devtron Apps](#for-devtron-apps) (step 2), you get two options:
7173
* Auto-create repository
7274
* Commit manifests to a desired repository
7375

74-
![Figure 9: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg)
76+
![Figure 8: Adding a Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/git-repository-helm-app.jpg)
7577

76-
6. Enter your custom Git Repo URL, and click **Save**.
78+
5. Enter your custom Git Repo URL, and click **Save**.
7779

78-
![Figure 10: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg)
80+
![Figure 9: Saved GitOps Config for Helm App](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/gitops/custom-git-repo-helm-apps.jpg)
7981

8082
Next, you may proceed to deploy the chart.
8183

0 commit comments

Comments
 (0)