Skip to content

Commit 8364d22

Browse files
authored
doc: project-level corrections (#4753)
* Added Enterprise Tag to Custom Profile Section * Simplified actual links to relative links * Other fixes and typos * CO Revision Incorporated
1 parent b867684 commit 8364d22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+118
-120
lines changed

docs/FAQs/devtron-troubleshoot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ Edit the following field:
566566
```yaml
567567
spec:
568568
capacity:
569-
storage: 10Gi # increase as per convinience
569+
storage: 10Gi # increase as per convenience
570570
```
571571
572572
**Increase the PVC size as per your requirement. This will resolve the issue. If not, then try to bounce the pod using the following command.**

docs/reference/glossary.md

Lines changed: 29 additions & 29 deletions
Large diffs are not rendered by default.

docs/reference/graviton.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We are thrilled to announce that Devtron seamlessly supports Graviton instances,
77

88
## Installation
99

10-
To install Devtron on graviton-cluster, refer this [link](https://docs.devtron.ai/install/install-devtron-with-cicd#install-multi-architecture-nodes-arm-and-amd)
10+
To install Devtron on graviton-cluster, refer this [link](../setup/install/install-devtron-with-cicd.md#install-multi-architecture-nodes-arm-and-amd)
1111

1212
## Inferences
1313

docs/setup/getting-started/getting-started.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This section includes information about the minimum requirements you need to ins
44

55
Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes cluster, Devtron can be installed standalone or along with CI/CD integration:
66

7-
* [Devtron with CI/CD](https://docs.devtron.ai/install/install-devtron-with-cicd): Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability.
8-
* [Helm Dashboard by Devtron](https://docs.devtron.ai/install/install-devtron): The Helm Dashboard by Devtron, which is a standalone installation, includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations).
7+
* [Devtron with CI/CD](../install/install-devtron-with-cicd.md): Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability.
8+
* [Helm Dashboard by Devtron](../install/install-devtron.md): The Helm Dashboard by Devtron, which is a standalone installation, includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md).
99

1010
In this section, we will cover the basic details on how you can quickly get started with **Devtron**.
1111
First, lets see what are the prerequisite requirements before you install Devtron.
@@ -27,7 +27,7 @@ You can create a cluster using one of the following cloud providers as per your
2727
| **AWS EKS** | Create a cluster using [AWS EKS](https://docs.aws.amazon.com/eks/latest/userguide/getting-started-console.html). <br>`Note`: You can also refer our customized documentation for installing `Devtron with CI/CD` on AWS EKS [here](https://github.com/devtron-labs/devtron/blob/b33a37bb608d07966c8f8b89e4f59287db873c6c/docs/setup/install/install-devtron-on-aws-eks.md).</br> |
2828
| **Google Kubernetes Engine (GKE)** | Create a cluster using [GKE](https://cloud.google.com/kubernetes-engine/). |
2929
| **Azure Kubernetes Service (AKS)** | Create a cluster using [AKS](https://learn.microsoft.com/en-us/azure/aks/). |
30-
| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).<br>`Note`: You can also refer our customized documentation for installing `Helm Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](https://docs.devtron.ai/install/install-devtron-on-minikube-microk8s-k3s-kind).</br> |
30+
| **k3s - Lightweight Kubernetes** | Create a cluster using [k3s - Lightweight Kubernetes](https://devtron.ai/blog/deploy-your-applications-over-k3s-lightweight-kubernetes-in-no-time/).<br>`Note`: You can also refer our customized documentation for installing `Helm Dashboard by Devtron` on `Minikube, Microk8s, K3s, Kind` [here](../install/install-devtron-on-minikube-microk8s-k3s-kind.md).</br> |
3131

3232

3333

@@ -55,7 +55,7 @@ The minimum requirements for installing `Helm Dashboard by Devtron` and `Devtron
5555
| **Devtron with CI/CD** | 6 | 13 GB |
5656
| **Helm Dashboard by Devtron** | 2 | 3 GB |
5757

58-
> Refer to the [Override Configurations](https://docs.devtron.ai/configurations-overview/override-default-devtron-installation-configs) section for more information.
58+
> Refer to the [Override Configurations](../install/override-default-devtron-installation-configs.md) section for more information.
5959
6060
**Note:**
6161
* Please make sure that the recommended resources are available on your Kubernetes cluster before you proceed with Devtron installation.
@@ -70,10 +70,10 @@ Choose one of the options as per your requirements:
7070

7171
| Installation Options | Description |
7272
| --- | --- |
73-
| [Devtron with CI/CD](https://docs.devtron.ai/install/install-devtron-with-cicd) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. |
74-
| [Helm Dashboard by Devtron](https://docs.devtron.ai/install/install-devtron) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations). |
75-
| [Devtron with CI/CD along with GitOps (Argo CD)](https://docs.devtron.ai/install/install-devtron-with-cicd-with-gitops) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations). |
76-
| **Upgrade Devtron to latest version** | You can upgrade Devtron in one of the following ways:<ul><li>[Upgrade Devtron using Helm](https://docs.devtron.ai/v/v0.5/getting-started/upgrade#upgrade-devtron-using-helm)</ul></li><ul><li>[Upgrade Devtron from UI](https://docs.devtron.ai/v/v0.5/getting-started/upgrade/upgrade-devtron-ui)</ul></li> |
73+
| [Devtron with CI/CD](../install/install-devtron-with-cicd.md) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. |
74+
| [Helm Dashboard by Devtron](../install/install-devtron.md) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). |
75+
| [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). |
76+
| **Upgrade Devtron to latest version** | You can upgrade Devtron in one of the following ways:<ul><li>[Upgrade Devtron using Helm](../../setup/upgrade/README.md#upgrade-devtron-using-helm)</ul></li><ul><li>[Upgrade Devtron from UI](../../setup/upgrade/upgrade-devtron-ui.md)</ul></li> |
7777

7878
**Note**: If you have questions, please let us know on our discord channel. [![Join Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp)
7979

docs/setup/install/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Choose one of the options as per your requirements:
77

88
| Installation Options | Description | When to choose |
99
| --- | --- | --- |
10-
| [Devtron with CI/CD](https://docs.devtron.ai/install/install-devtron-with-cicd) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. | Use this option to install Devtron with `Build and Deploy CI/CD` integration. |
11-
| [Helm Dashboard by Devtron](https://docs.devtron.ai/install/install-devtron) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations). | Use this option if you are managing the applications via Helm and you want to use Devtron to deploy, observe, manage, and debug the Helm applications. |
12-
| [Devtron with CI/CD along with GitOps (Argo CD)](https://docs.devtron.ai/install/install-devtron-with-cicd-with-gitops) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations). | Use this option to install Devtron with CI/CD by enabling GitOps, which is the most scalable method in terms of version control, collaboration, compliance and infrastructure automation. |
10+
| [Devtron with CI/CD](../install/install-devtron-with-cicd.md) | Devtron installation with the CI/CD integration is used to perform CI/CD, security scanning, GitOps, debugging, and observability. | Use this option to install Devtron with `Build and Deploy CI/CD` integration. |
11+
| [Helm Dashboard by Devtron](../install/install-devtron.md) | The Helm Dashboard by Devtron which is a standalone installation includes functionalities to deploy, observe, manage, and debug existing Helm applications in multiple clusters. You can also install integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | Use this option if you are managing the applications via Helm and you want to use Devtron to deploy, observe, manage, and debug the Helm applications. |
12+
| [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md) | With this option, you can install Devtron with CI/CD by enabling GitOps during the installation. You can also install other integrations from [Devtron Stack Manager](../../user-guide/integrations/README.md). | Use this option to install Devtron with CI/CD by enabling GitOps, which is the most scalable method in terms of version control, collaboration, compliance and infrastructure automation. |
1313

1414

1515
**Note**: If you have questions, please let us know on our discord channel. [![Join Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp)

docs/setup/install/install-devtron-Kubernetes-client.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ https://cdn.devtron.ai/k8s-client/devtron-install.bash
3737

3838
* Devtron Kubernetes Client opens in your browser automatically.
3939

40-
* You must add your cluster to make your cluster visible on the `Kubernetes Resource Browser` and `Clusters` section. To add a cluster, go to the `Global Configurations` and click `Add Cluster`. [Refer documentation on how to add a cluster](https://docs.devtron.ai/v/v0.6/global-configurations/cluster-and-environments#add-cluster).
40+
* You must add your cluster to make your cluster visible on the `Kubernetes Resource Browser` and `Clusters` section. To add a cluster, go to the `Global Configurations` and click `Add Cluster`. [Refer documentation on how to add a cluster](../../user-guide/global-configurations/cluster-and-environments.md#add-cluster).
4141

4242
`Note`: You do not need to have a `super admin` permission to add a cluster if you install `Devtron Kubernetes Client`. You can add more than one cluster.
4343

@@ -62,7 +62,7 @@ With `Kubernetes Resource browser`, you can also perform the following:
6262

6363
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/install-devtron/install+devtron+K8s+client/k8s-resource-browser.jpg)
6464

65-
After your cluster is added via `Global Configurations`, go to the `Kubernetes Resource Browser` page and select your cluster. [Refer Resource Browser documentation for detail and its operations](https://docs.devtron.ai/v/v0.6/usage/resource-browser).
65+
After your cluster is added via `Global Configurations`, go to the `Kubernetes Resource Browser` page and select your cluster. [Refer Resource Browser documentation for detail and its operations](../../user-guide/resource-browser.md).
6666

6767
`Note`: You do not need to have a `super admin` permission to access `Kubernetes Resource Browser` if you install `Devtron Kubernetes Client`.
6868

@@ -80,12 +80,12 @@ It enables you to observe and monitor the cluster health and real-time node cond
8080
* Edit a node config
8181
* Delete a node
8282

83-
With its rich features and intuitive interface, you can easily manage and [debug clusters through cluster terminal access](https://docs.devtron.ai/v/v0.6/usage/clusters#access-cluster-via-terminal-for-troubleshooting) and use any CLI debugging tools like busybox, kubectl, netshoot or any custom CLI tools like k9s.
83+
With its rich features and intuitive interface, you can easily manage and [debug clusters through cluster terminal access](../../user-guide/clusters.md#access-cluster-via-terminal-for-troubleshooting) and use any CLI debugging tools like busybox, kubectl, netshoot or any custom CLI tools like k9s.
8484

8585
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/install-devtron/install+devtron+K8s+client/cluster-terminal.jpg)
8686

8787

88-
After your cluster is added via `Global Configurations`, go to the `Clusters` page and search or select your cluster. [Refer Clusters documentation for detail and its operations](https://docs.devtron.ai/v/v0.6/usage/clusters).
88+
After your cluster is added via `Global Configurations`, go to the `Clusters` page and search or select your cluster. [Refer Clusters documentation for detail and its operations](../../user-guide/clusters.md).
8989

9090

9191
### Some Peripheral Commands

docs/setup/install/install-devtron-with-cicd-with-gitops.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,9 @@ kubectl -n devtroncd get secret devtron-secret \
272272
</details>
273273
274274
275-
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
275+
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](../install/uninstall-devtron.md).
276276
277-
* Related to installation, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
277+
* Related to installation, please also refer [FAQ](../install/faq-on-installation.md) section also.
278278
279279
280280
**Note**: If you have questions, please let us know on our discord channel. [![Join Discord](https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg)](https://discord.gg/jsRG5qx2gp)

docs/setup/install/install-devtron-with-cicd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,9 @@ kubectl -n devtroncd get secret devtron-secret \
293293
</details>
294294
295295
296-
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
296+
* If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](../install/uninstall-devtron.md).
297297
298-
* Related to installaltion, please also refer [FAQ](https://docs.devtron.ai/install/faq-on-installation) section also.
298+
* Related to installaltion, please also refer [FAQ](../install/faq-on-installation.md) section also.
299299
300300
301301
{% hint style="info" %}

docs/setup/install/install-devtron.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install Devtron
22

3-
In this section, we describe on how you can install Helm Dashboard by Devtron without any integrations. Integrations can be added later using [Devtron Stack Manager](https://docs.devtron.ai/v/v0.6/usage/integrations).
3+
In this section, we describe on how you can install Helm Dashboard by Devtron without any integrations. Integrations can be added later using [Devtron Stack Manager](../../user-guide/stack-manager.md).
44

55
If you want to install Devtron on Minikube, Microk8s, K3s, Kind, refer this [section](./Install-devtron-on-Minikube-Microk8s-K3s-Kind.md).
66

@@ -21,7 +21,7 @@ helm repo update devtron
2121

2222
## Install Helm Dashboard by Devtron
2323

24-
**Note**: This installation command will not install CI/CD integration. For CI/CD, refer [install Devtron with CI/CD](https://docs.devtron.ai/install/install-devtron-with-cicd) section.
24+
**Note**: This installation command will not install CI/CD integration. For CI/CD, refer [install Devtron with CI/CD](../install/install-devtron-with-cicd.md) section.
2525

2626
Run the following command to install Helm Dashboard by Devtron:
2727

@@ -106,9 +106,9 @@ kubectl -n devtroncd get secret devtron-secret \
106106
</details>
107107

108108

109-
**Note**: If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](https://docs.devtron.ai/install/uninstall-devtron).
109+
**Note**: If you want to uninstall Devtron or clean Devtron helm installer, refer our [uninstall Devtron](../install/uninstall-devtron.md).
110110

111111

112112
## Upgrade
113113

114-
To use the CI/CD capabilities with Devtron, you can Install the [Devtron with CI/CD](https://docs.devtron.ai/install/install-devtron-with-cicd) or [Devtron with CI/CD along with GitOps (Argo CD)](https://docs.devtron.ai/install/install-devtron-with-cicd-with-gitops).
114+
To use the CI/CD capabilities with Devtron, you can Install the [Devtron with CI/CD](../install/install-devtron-with-cicd.md) or [Devtron with CI/CD along with GitOps (Argo CD)](../install/install-devtron-with-cicd-with-gitops.md).

docs/user-guide/clusters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Devtron allows you to manage your Kubernetes cluster by:
66
* Managing Cluster resources with Kubernetes requests and limits and also individual containers.
77
* Debugging a pod or node by connecting to a terminal.
88

9-
On the left navigation of Devtron, select `Clusters`. You will find the list of clusters in this section which you have added under [Global Configurations > Clusters & Environments](https://docs.devtron.ai/global-configurations/cluster-and-environments).
9+
On the left navigation of Devtron, select `Clusters`. You will find the list of clusters in this section which you have added under [Global Configurations > Clusters & Environments](./global-configurations/cluster-and-environments.md).
1010

1111
You can also search the cluster in the `Search Clusters` bar.
1212

@@ -169,15 +169,15 @@ The node will be deleted from the cluster.
169169

170170
## Access Cluster via Terminal for Troubleshooting
171171

172-
User with [Super admins](https://docs.devtron.ai/global-configurations/authorization/user-access#assign-super-admin-permission) access can now troubleshoot cluster issues by accessing the cluster terminal from Devtron. You can select an image from the list that has all CLI utilities like kubectl, helm, netshoot etc. or can use a custom image, which is publicly available.
172+
User with [Super admins](./global-configurations/authorization/user-access.md#assign-super-admin-permission) access can now troubleshoot cluster issues by accessing the cluster terminal from Devtron. You can select an image from the list that has all CLI utilities like kubectl, helm, netshoot etc. or can use a custom image, which is publicly available.
173173

174174
To troubleshoot a cluster or a specific node in a cluster, click the terminal symbol on the right side.
175175

176176
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/clusters/cluster-terminal-access.jpg)
177177

178178
* You will see the user-defined name for the cluster in Devtron. E.g. `default-cluster`.
179179
* In the `Nodes` field, select the node from the drop-down list you want to troubleshoot. E.g. `demo-new`.
180-
* Select the namespace from the drop-down list which you have added in the [Environment](https://docs.devtron.ai/global-configurations/cluster-and-environments#add-environment) section.
180+
* Select the namespace from the drop-down list which you have added in the [Environment](./global-configurations/cluster-and-environments.md#add-environment) section.
181181
* Select the image from the drop-down list which includes all CLI utilities or you can use a custom image, which is publicly available.
182182
* Select the terminal shell from the drop-down list (e.g. `sh`, `bash`) to troubleshoot a node.
183183

0 commit comments

Comments
 (0)