From 33e43e180774052ed85c2b964227192da119884c Mon Sep 17 00:00:00 2001 From: toyeshhm Date: Fri, 18 Sep 2026 09:11:25 -0500 Subject: [PATCH] docs: fix broken registry and user-access links, and typos - setup/start-using.md linked to global-configurations/docker-registries.md, which no longer exists; point it at container-registries.md - four "Admin role" links in creating-application/ resolved to docs/user-guide/user-guide/...; fix the relative path to user-access.md - fix typos: Definations, Depricated, everytime, atleast, occured, "to to", "is is" --- README.md | 2 +- charts/devtron/README.md | 2 +- docs/FAQs/devtron-troubleshoot.md | 4 ++-- docs/setup/start-using.md | 2 +- docs/user-guide/creating-application/deployment-template.md | 6 +++--- .../creating-application/docker-build-configuration.md | 2 +- .../creating-application/environment-overrides.md | 2 +- .../user-guide/creating-application/workflow/ci-pipeline.md | 4 ++-- .../global-configurations/container-registries.md | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 01653f1cde..c2162fe442 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Check out the below video to experience the full power of the **Kubernetes Dashb Out of the box, Devtron's Kubernetes Dashboard includes: - [Helm Application Management](https://docs.dashboard.devtron.ai/user-guide/helm-apps) to streamline deploying, configuration, and management of Helm apps -- [Resource Browser](https://docs.dashboard.devtron.ai/user-guide/resource-browser) to visualize and manage different cluster resources like Nodes, Pods, ConfigMaps, Custom Resource Definations (CRDs), etc +- [Resource Browser](https://docs.dashboard.devtron.ai/user-guide/resource-browser) to visualize and manage different cluster resources like Nodes, Pods, ConfigMaps, Custom Resource Definitions (CRDs), etc - [Single Sign On (SSO)](https://docs.dashboard.devtron.ai/operator-guide/authorization/sso-login-services) to simplify onboarding and authenticating team members. - [Fine Grained RBAC](https://docs.dashboard.devtron.ai/operator-guide/authorization) to control the level of access users have to different Dashboard and Cluster resources. diff --git a/charts/devtron/README.md b/charts/devtron/README.md index 487b57407f..145c86fb6a 100644 --- a/charts/devtron/README.md +++ b/charts/devtron/README.md @@ -15,7 +15,7 @@ It packages third party components like - [Argocd](https://github.com/argoproj/argo-cd/) for gitops - [Argo workflows](https://github.com/argoproj/argo) for CI - [Clair](https://github.com/quay/clair) & [Guard](https://github.com/guard/guard) for image scanning - - [External Secret Operator](https://github.com/external-secrets/external-secrets) and [Kubernetes External Secrets (Depricated) ](https://github.com/godaddy/kubernetes-external-secrets) for integrating with external secret management systems like [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) or [HashiCorp Vault](https://www.vaultproject.io/) + - [External Secret Operator](https://github.com/external-secrets/external-secrets) and [Kubernetes External Secrets (Deprecated) ](https://github.com/godaddy/kubernetes-external-secrets) for integrating with external secret management systems like [AWS Secrets Manager](https://aws.amazon.com/secrets-manager/) or [HashiCorp Vault](https://www.vaultproject.io/) - [Nats](https://github.com/nats-io) for event streaming - [Postgres](https://github.com/postgres/postgres) as datastore - Fork of [Argo Rollout](https://github.com/argoproj/argo-rollouts) diff --git a/docs/FAQs/devtron-troubleshoot.md b/docs/FAQs/devtron-troubleshoot.md index fb6b076248..545b9cf271 100644 --- a/docs/FAQs/devtron-troubleshoot.md +++ b/docs/FAQs/devtron-troubleshoot.md @@ -253,7 +253,7 @@ If you are getting an error message of "invalid username or password" or you wan `Solution:` -1. Make sure you are on latest version or atleast you are using devtron version v0.6.9 or above. You can check your devtron version using `kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync.data}' | grep "^LTAG=" | cut -d"=" -f2-` +1. Make sure you are on latest version or at least you are using devtron version v0.6.9 or above. You can check your devtron version using `kubectl -n devtroncd get installers installer-devtron -o jsonpath='{.status.sync.data}' | grep "^LTAG=" | cut -d"=" -f2-` 1. Take a backup of devtron secret using `kubectl get secret devtron-secret -n devtroncd -o yaml > devtron-secret-backup.yaml` 2. Edit devtron secret using `kubectl edit secret devtron-secret -n devtroncd` and remove the key value pairs of ADMIN_PASSWORD, admin.password and admin.passwordMtime 3. Restart argocd dex server to create new admin password for devtron using `kubectl delete po -n devtroncd -l app.kubernetes.io/name=argocd-dex-server` @@ -589,7 +589,7 @@ Below is a sample annotation for your reference. kubectl.kubernetes.io/last-applied-configuration: | {"apiVersion":"v1","data":{"foo":"bar"},"kind":"ConfigMap","metadata":{"annotations":{},"creationTimestamp":"2019-08-12T18:38:34Z","labels":{"argocd.argoproj.io/instance":"deploy-test-cd-argo"},"name":"test-cm-1154","namespace":"argo"}} ``` -You may take the help of JSON validators to identify where the unintended human error has occured in the JSON. Rectifying the same should resolve this issue. +You may take the help of JSON validators to identify where the unintended human error has occurred in the JSON. Rectifying the same should resolve this issue. {% hint style="info" %} The annotation `kubectl.kubernetes.io/last-applied-configuration:` is automatically added to each object when you run `kubectl apply`. diff --git a/docs/setup/start-using.md b/docs/setup/start-using.md index 7fd5959358..9268ba1306 100644 --- a/docs/setup/start-using.md +++ b/docs/setup/start-using.md @@ -2,7 +2,7 @@ #### configure docker registry -Please [setup docker registry](../user-guide/global-configurations/docker-registries.md) before deploying application. +Please [setup docker registry](../user-guide/global-configurations/container-registries.md) before deploying application. ## Deploying Applications diff --git a/docs/user-guide/creating-application/deployment-template.md b/docs/user-guide/creating-application/deployment-template.md index ab117b9a3c..ba60b34f71 100644 --- a/docs/user-guide/creating-application/deployment-template.md +++ b/docs/user-guide/creating-application/deployment-template.md @@ -18,7 +18,7 @@ To configure a deployment chart for your application, do the following steps: {% hint style="warning" %} ### Who Can Perform This Action? -Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above to select a chart. +Users need to have [Admin role](../global-configurations/authorization/user-access.md#role-based-access-levels) or above to select a chart. {% endhint %} {% hint style="warning" %} @@ -53,7 +53,7 @@ You can select an available custom chart as shown below. You can also view the d {% hint style="warning" %} ### Who Can Perform This Action? -Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above to select a chart version. +Users need to have [Admin role](../global-configurations/authorization/user-access.md#role-based-access-levels) or above to select a chart version. {% endhint %} Once you select a chart type, choose a chart version using which you wish to deploy the application. @@ -72,7 +72,7 @@ Every chart version has its own YAML file that provides specifications for your {% hint style="warning" %} ### Who Can Perform This Action? -Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above to configure a chart. However, super-admins can lock keys in base deployment template to prevent non-super-admins from modifying them. Refer [Lock Deployment Configuration](../global-configurations/lock-deployment-config.md) to know more. +Users need to have [Admin role](../global-configurations/authorization/user-access.md#role-based-access-levels) or above to configure a chart. However, super-admins can lock keys in base deployment template to prevent non-super-admins from modifying them. Refer [Lock Deployment Configuration](../global-configurations/lock-deployment-config.md) to know more. {% endhint %} ### Using Basic GUI diff --git a/docs/user-guide/creating-application/docker-build-configuration.md b/docs/user-guide/creating-application/docker-build-configuration.md index 18a0b0b435..8b2dd07f1e 100644 --- a/docs/user-guide/creating-application/docker-build-configuration.md +++ b/docs/user-guide/creating-application/docker-build-configuration.md @@ -116,7 +116,7 @@ If target platform is not set, Devtron will build image for architecture and ope The Target Platform feature might not work in minikube & microk8s clusters as of now. ### Docker Build Arguments - It is is a collapsed view including the following parameters: + It is a collapsed view including the following parameters: * Key * Value diff --git a/docs/user-guide/creating-application/environment-overrides.md b/docs/user-guide/creating-application/environment-overrides.md index 59699c7975..2abebcf9b3 100644 --- a/docs/user-guide/creating-application/environment-overrides.md +++ b/docs/user-guide/creating-application/environment-overrides.md @@ -33,7 +33,7 @@ This will save you the trouble to manually create deployment files separately fo {% hint style="warning" %} ### Who Can Perform This Action? -Users need to have [Admin role](../user-guide/global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to change perform environment override. +Users need to have [Admin role](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and applications) to change perform environment override. {% endhint %} Go to **App Configuration** → **Environment Overrides**. For each environment you can override the following configurations: diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline.md b/docs/user-guide/creating-application/workflow/ci-pipeline.md index 0346553385..dfa547930a 100644 --- a/docs/user-guide/creating-application/workflow/ci-pipeline.md +++ b/docs/user-guide/creating-application/workflow/ci-pipeline.md @@ -250,7 +250,7 @@ You can use Devtron for deployments on Kubernetes while using an external CI too | Fields | Description | | --- | --- | | **Deploy to environment** | | -| **When do you want to deploy** | You can deploy either in one of the following ways: | +| **When do you want to deploy** | You can deploy either in one of the following ways: | | **Deployment Strategy** | Configure the deployment preferences for this pipeline. | * Click **Create Pipeline**. @@ -325,7 +325,7 @@ curl --location --request POST \ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/webhook-ci/execute-shell-jenkins-v2.jpg) - Now, you can access the images on the Devtron dashboard and deploy manually. In case, if you select **Automatic** deployment option, then your application will be deployed automatically everytime a new image is received. + Now, you can access the images on the Devtron dashboard and deploy manually. In case, if you select **Automatic** deployment option, then your application will be deployed automatically every time a new image is received. Similarly, you can also integrate with external source such as **CircleCI** by: diff --git a/docs/user-guide/global-configurations/container-registries.md b/docs/user-guide/global-configurations/container-registries.md index 48ed1ff3f1..e80590997a 100644 --- a/docs/user-guide/global-configurations/container-registries.md +++ b/docs/user-guide/global-configurations/container-registries.md @@ -28,7 +28,7 @@ You can configure a container registry using any registry provider of your choic | **Name** | Provide a name to your registry, this name will appear in the **Container Registry** drop-down list available within the [Build Configuration](../creating-application/docker-build-configuration.md) section of your application| | **Registry URL** | Provide the URL of your registry in case it doesn't come prefilled (do not include `oci://`, `http://`, or `/https://` in the URL) | | **Authentication Type** | The credential input fields may differ depending on the registry provider, check [Registry Providers](#supported-registry-providers) | - | **Push container images** | Tick this checkbox if you wish to use the repository to push container images. This comes selected by default and you may untick it if you don't intend to push container images after a CI build. If you wish to to use the same repository to pull container images too, read [Registry Credential Access](#registry-credential-access). | + | **Push container images** | Tick this checkbox if you wish to use the repository to push container images. This comes selected by default and you may untick it if you don't intend to push container images after a CI build. If you wish to use the same repository to pull container images too, read [Registry Credential Access](#registry-credential-access). | | **Push helm packages** | Tick this checkbox if you wish to push helm charts to your registry | | **Use as chart repository** | Tick this checkbox if you want Devtron to pull helm charts from your registry and display them on its chart store. Also, you will have to provide a list of repositories (present within your registry) for Devtron to successfully pull the helm charts. | | **Set as default registry** | Tick this checkbox to set your registry as the default registry hub for your images or artifacts |