doc: Fixes in Documentation for May Month (#5150)

ashokdevtron · web-flow · commit 3bf0f386846b · 2024-05-21T22:36:46.000+05:30
* Fixed Broken Links, Typos, and Errors in Docs

* Incorporated Old Suggestions
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -76,5 +76,4 @@ redirects:
     user-guide/use-cases/untitled-3: user-guide/use-cases/connect-django-with-mysql-database.md
     global-configurations/api-token: user-guide/global-configurations/authorization/api-tokens.md
     user-guide/creating-application/workflow/ci-pipeline2: user-guide/creating-application/workflow/ci-pipeline.md
-    usage/clusters: usage/resource-browser
-
+    user-guide/clusters: user-guide/resource-browser.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -114,23 +114,22 @@
 * [Security](user-guide/security-features.md)
   * [Security Scans](user-guide/security-features/security-scans.md)
   * [Security Policies](user-guide/security-features/security-policies.md)
-* [Clusters](user-guide/clusters.md)
 * [Bulk Edit](user-guide/bulk-update.md)
 * [Integrations](user-guide/integrations/README.md)
   * [Build and Deploy (CI/CD)](user-guide/integrations/build-and-deploy-ci-cd.md)
   * [GitOps (Argo CD)](user-guide/integrations/argocd.md)
   * [Vulnerability Scanning (Clair)](user-guide/integrations/clair.md)
   * [Notifications](user-guide/integrations/notifications.md)
   * [Monitoring (Grafana)](user-guide/integrations/grafana.md)
-* [Preset Plugins](user-guide/plugins/README.md)
-  * [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
-  * [SonarQube](user-guide/plugins/sonarqube.md)
-  * [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
-  * [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
-  * [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
-  * [Semgrep](user-guide/plugins/semgrep.md)
+* [Pipeline Plugins](user-guide/plugins/README.md)
   * [Codacy](user-guide/plugins/codacy.md)
   * [Copy Container Image](user-guide/plugins/copy-container-image.md)
+  * [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
+  * [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
+  * [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
+  * [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
+  * [Semgrep](user-guide/plugins/semgrep.md)
+  * [SonarQube](user-guide/plugins/sonarqube.md)
   * [SonarQube v1.1.0](user-guide/plugins/sonarqube-v1.1.0.md)
 
 
diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md
@@ -38,7 +38,7 @@ A place where all Helm charts are centrally listed for users to deploy applicati
 
 A cluster in Kubernetes refers to a set of connected computers (nodes) that collectively manage containerized applications using Kubernetes. It provides resources and services to run, manage, and scale applications. 
 
-In Devtron, you can view the list of clusters in ‘Global Configurations’ available in the left sidebar. [Read More...](../user-guide/clusters.md)
+In Devtron, you can view the list of clusters in 'Global Configurations' as well as 'Resource Browser'. [Read More...](../user-guide/resource-browser.md)
 
 ### Commit Hash
 
@@ -180,7 +180,7 @@ In Devtron, you can view nodes by going to Resource Browser → (choose a cluste
 
 Kubernetes objects are the building blocks that define and manage your applications running on the platform. They are also known as 'Resources' or 'Kinds'. This includes nodes, pods, deployment, cronjob, configmap, and many more. 
 
-Devtron's [Resource Browser](../user-guide/resource-browser/README.md) helps you manage all such objects present in your clusters.
+Devtron's [Resource Browser](../user-guide/resource-browser.md) helps you manage all such objects present in your clusters.
 
 ### Pod
 
diff --git a/docs/setup/getting-started/getting-started.md b/docs/setup/getting-started/getting-started.md
@@ -10,7 +10,7 @@ Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes clu
 In this section, we will cover the basic details on how you can quickly get started with **Devtron**.
 First, lets see what are the prerequisite requirements before you install Devtron.
 
-## Pre-requisite Requirements
+## Prerequisites
 * Create a [Kubernetes cluster, preferably K8s version 1.16 or higher](#create-a-kubernetes-cluster)
 * [Helm Installation](https://helm.sh/docs/intro/install/)
 * [Recommended Resources](#recommended-resources)
diff --git a/docs/setup/install/install-devtron-with-cicd.md b/docs/setup/install/install-devtron-with-cicd.md
@@ -4,7 +4,7 @@ In this section, we describe the steps in detail on how you can install Devtron
 
 ---
 
-## Pre-requisites
+## Prerequisites
 
 Install [Helm](https://helm.sh/docs/intro/install/), if you have not installed it already.
 
diff --git a/docs/user-guide/application-groups.md b/docs/user-guide/application-groups.md
@@ -139,7 +139,7 @@ Users need to have [Build and deploy permission](../user-guide/global-configurat
 
 {% hint style="warning" %}
 ### Who Can Perform This Action?
-Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to hibernate or unhibernate applications.
+Users need to have [Build & deploy permission](./global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to hibernate or unhibernate applications.
 {% endhint %}
 
 Since every application comes with an option to hibernate, the same is true for application groups. Using application group, you can hibernate one or more applications belonging to the same environment if you do not want them to consume resources (replica count will be set to 0). 
diff --git a/docs/user-guide/global-configurations/README.md b/docs/user-guide/global-configurations/README.md
@@ -34,11 +34,11 @@ Before you start creating an application, we recommend to provide basic informat
 
 [Tags Policy](tags-policy.md)
 
-[Filter Condition](filter-condition.md)
+[Lock Deployment Configuration](lock-deployment-config.md)
 
-[Image Promotion](image-promotion-policy.md)
+[Image Promotion Policy](image-promotion-policy.md)
 
-[Lock Deployment Configuration](lock-deployment-config.md)
+[Filter Condition](filter-condition.md)
 
 [Build Infra](build-infra.md)
 
diff --git a/docs/user-guide/global-configurations/build-infra.md b/docs/user-guide/global-configurations/build-infra.md
@@ -10,7 +10,7 @@ With the 'Build Infra' feature, Devtron makes it possible for you to tweak the r
 
 {% hint style="warning" %}
 ### Who Can Perform This Action?
-Users need to have super-admin permission to configure build Infra.
+Users need to have super-admin permission to configure Build Infra.
 {% endhint %}
 
 ---
diff --git a/docs/user-guide/global-configurations/filter-condition.md b/docs/user-guide/global-configurations/filter-condition.md
@@ -14,7 +14,8 @@ Using filter conditions, you can control the progression of events. Here are a f
 ## Steps to Create a Filter
 
 {% hint style="info" %}
-**Pre-requisite**: You must have application(s) with CI-CD workflow(s) configured
+### Prerequisites
+You must have application(s) with CI-CD workflow(s) configured
 {% endhint %}
 
 1. From the left sidebar, go to **Global Configurations** → **Filter Condition**.
diff --git a/docs/user-guide/global-configurations/image-promotion-policy.md b/docs/user-guide/global-configurations/image-promotion-policy.md
@@ -144,7 +144,7 @@ Moreover, there are three filters available to make the selections easier for yo
 Users need to have super-admin permission to apply an image promotion policy.
 {% endhint %}
 
-You can apply a policy using our APIs or through [Devtron CLI](https://github.com/devtron-labs/devtron-cli). Here is the CLI approach:
+You can apply a policy using our APIs or through Devtron CLI. Here is the CLI approach:
 
 * Create a YAML file and give it a name (say `applyPolicy.yaml`). Within the file, define the applications and environments to which the image promotion policy should apply, as shown below.
 
diff --git a/docs/user-guide/plugins/README.md b/docs/user-guide/plugins/README.md
@@ -1,6 +1,6 @@
-# Preset Plugins
+# Pipeline Plugins
 
-Preset plugins are micro tools that allow you to enhance and refine the [CI/CD workflow](../creating-application/workflow/README.md) of your application by adding new features, integrating with external tools, and automating tasks.
+Pipeline plugins (a.k.a. preset plugins) are micro tools that allow you to enhance and refine the [CI/CD workflow](../creating-application/workflow/README.md) of your application by adding new features, integrating with external tools, and automating tasks.
 
 Unlike [custom scripts](../creating-application/workflow/ci-build-pre-post-plugins.md#execute-custom-script), preset plugins come bundled with specific variables and conditions that help you make the plugins work seamlessly with your CI/CD pipeline.
 
diff --git a/docs/user-guide/resource-browser.md b/docs/user-guide/resource-browser.md
@@ -2,19 +2,19 @@
 
 ## Introduction
 
-The Devtron Resource Browser provides you a central interface to view and manage all your [Kubernetes objects](../../reference/glossary.md#objects) across clusters.  It helps you perform key actions like viewing logs, editing live manifests, and even creating/deleting resources directly from the user interface. This is especially useful for troubleshooting purposes as it supports multi-cluster too.
+The Devtron Resource Browser provides you a central interface to view and manage all your [Kubernetes objects](../reference/glossary.md#objects) across clusters.  It helps you perform key actions like viewing logs, editing live manifests, and even creating/deleting resources directly from the user interface. This is especially useful for troubleshooting purposes as it supports multi-cluster too.
 
 {% hint style="info" %}
 ### Additional References
 * [Resource browser versus traditional tools like kubectl](https://devtron.ai/blog/managing-kubernetes-resources-across-multiple-clusters)
 * [Why you should use Devtron's Resource Browser](https://devtron.ai/blog/what-is-the-kubernetes-resource-browser-in-devtron)
 {% endhint %}
 
-First, the Resource Browser shows you a list of clusters added to your Devtron setup. By default, it displays a cluster named '*default_cluster*' after the [initial setup](../../setup/install/README.md) is successful.
+First, the Resource Browser shows you a list of clusters added to your Devtron setup. By default, it displays a cluster named '*default_cluster*' after the [initial setup](../setup/install/README.md) is successful.
 
 ![Figure 1: Devtron Resource Browser - List of Clusters](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-browser.jpg)
 
-You can easily connect more clusters by clicking the **Add Cluster** button located at the top of the browser. This will take you to the [Cluster & Environments](../global-configurations/cluster-and-environments.md) configuration within [Global Configurations](../global-configurations/README.md).
+You can easily connect more clusters by clicking the **Add Cluster** button located at the top of the browser. This will take you to the [Cluster & Environments](./global-configurations/cluster-and-environments.md) configuration within [Global Configurations](./global-configurations/README.md).
 
 You may click a cluster to view and manage all its resources as shown below.
 
diff --git a/docs/user-guide/use-cases/oci-pull.md b/docs/user-guide/use-cases/oci-pull.md
@@ -4,7 +4,7 @@
 
 Devtron supports the installation of [Helm charts](../../reference/glossary.md#helm-chartspackages) from both: Helm [repos](../../reference/glossary.md#repo) and [Container/OCI registries](../../reference/glossary.md#containeroci-registry). Unlike Helm repos, OCI registries do not have an index file to discover all the charts. However, Devtron makes it easier for you to populate your charts from multiple sources to the [chart store](../../reference/glossary.md#chart-store).
 
-**Pre-requisites**
+**Prerequisites**
 
 * Helm Chart(s)
 * OCI-compliant Registry (e.g. Docker Hub and [many more](../global-configurations/container-registries.md#supported-registry-providers))
