Skip to content

Commit 3bf0f38

Browse files
authored
doc: Fixes in Documentation for May Month (#5150)
* Fixed Broken Links, Typos, and Errors in Docs * Incorporated Old Suggestions
1 parent 93fbeae commit 3bf0f38

File tree

13 files changed

+26
-27
lines changed

13 files changed

+26
-27
lines changed

.gitbook.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,4 @@ redirects:
7676
user-guide/use-cases/untitled-3: user-guide/use-cases/connect-django-with-mysql-database.md
7777
global-configurations/api-token: user-guide/global-configurations/authorization/api-tokens.md
7878
user-guide/creating-application/workflow/ci-pipeline2: user-guide/creating-application/workflow/ci-pipeline.md
79-
usage/clusters: usage/resource-browser
80-
79+
user-guide/clusters: user-guide/resource-browser.md

docs/SUMMARY.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,23 +114,22 @@
114114
* [Security](user-guide/security-features.md)
115115
* [Security Scans](user-guide/security-features/security-scans.md)
116116
* [Security Policies](user-guide/security-features/security-policies.md)
117-
* [Clusters](user-guide/clusters.md)
118117
* [Bulk Edit](user-guide/bulk-update.md)
119118
* [Integrations](user-guide/integrations/README.md)
120119
* [Build and Deploy (CI/CD)](user-guide/integrations/build-and-deploy-ci-cd.md)
121120
* [GitOps (Argo CD)](user-guide/integrations/argocd.md)
122121
* [Vulnerability Scanning (Clair)](user-guide/integrations/clair.md)
123122
* [Notifications](user-guide/integrations/notifications.md)
124123
* [Monitoring (Grafana)](user-guide/integrations/grafana.md)
125-
* [Preset Plugins](user-guide/plugins/README.md)
126-
* [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
127-
* [SonarQube](user-guide/plugins/sonarqube.md)
128-
* [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
129-
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
130-
* [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
131-
* [Semgrep](user-guide/plugins/semgrep.md)
124+
* [Pipeline Plugins](user-guide/plugins/README.md)
132125
* [Codacy](user-guide/plugins/codacy.md)
133126
* [Copy Container Image](user-guide/plugins/copy-container-image.md)
127+
* [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
128+
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
129+
* [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
130+
* [K6 Load Testing](user-guide/plugins/k6-load-testing.md)
131+
* [Semgrep](user-guide/plugins/semgrep.md)
132+
* [SonarQube](user-guide/plugins/sonarqube.md)
134133
* [SonarQube v1.1.0](user-guide/plugins/sonarqube-v1.1.0.md)
135134

136135

docs/reference/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ A place where all Helm charts are centrally listed for users to deploy applicati
3838

3939
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.
4040

41-
In Devtron, you can view the list of clusters in Global Configurations’ available in the left sidebar. [Read More...](../user-guide/clusters.md)
41+
In Devtron, you can view the list of clusters in 'Global Configurations' as well as 'Resource Browser'. [Read More...](../user-guide/resource-browser.md)
4242

4343
### Commit Hash
4444

@@ -180,7 +180,7 @@ In Devtron, you can view nodes by going to Resource Browser → (choose a cluste
180180

181181
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.
182182

183-
Devtron's [Resource Browser](../user-guide/resource-browser/README.md) helps you manage all such objects present in your clusters.
183+
Devtron's [Resource Browser](../user-guide/resource-browser.md) helps you manage all such objects present in your clusters.
184184

185185
### Pod
186186

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Devtron is installed over a Kubernetes cluster. Once you create a Kubernetes clu
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.
1212

13-
## Pre-requisite Requirements
13+
## Prerequisites
1414
* Create a [Kubernetes cluster, preferably K8s version 1.16 or higher](#create-a-kubernetes-cluster)
1515
* [Helm Installation](https://helm.sh/docs/intro/install/)
1616
* [Recommended Resources](#recommended-resources)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In this section, we describe the steps in detail on how you can install Devtron
44

55
---
66

7-
## Pre-requisites
7+
## Prerequisites
88

99
Install [Helm](https://helm.sh/docs/intro/install/), if you have not installed it already.
1010

docs/user-guide/application-groups.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Users need to have [Build and deploy permission](../user-guide/global-configurat
139139

140140
{% hint style="warning" %}
141141
### Who Can Perform This Action?
142-
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.
142+
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.
143143
{% endhint %}
144144

145145
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).

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Before you start creating an application, we recommend to provide basic informat
3434

3535
[Tags Policy](tags-policy.md)
3636

37-
[Filter Condition](filter-condition.md)
37+
[Lock Deployment Configuration](lock-deployment-config.md)
3838

39-
[Image Promotion](image-promotion-policy.md)
39+
[Image Promotion Policy](image-promotion-policy.md)
4040

41-
[Lock Deployment Configuration](lock-deployment-config.md)
41+
[Filter Condition](filter-condition.md)
4242

4343
[Build Infra](build-infra.md)
4444

docs/user-guide/global-configurations/build-infra.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ With the 'Build Infra' feature, Devtron makes it possible for you to tweak the r
1010

1111
{% hint style="warning" %}
1212
### Who Can Perform This Action?
13-
Users need to have super-admin permission to configure build Infra.
13+
Users need to have super-admin permission to configure Build Infra.
1414
{% endhint %}
1515

1616
---

docs/user-guide/global-configurations/filter-condition.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Using filter conditions, you can control the progression of events. Here are a f
1414
## Steps to Create a Filter
1515

1616
{% hint style="info" %}
17-
**Pre-requisite**: You must have application(s) with CI-CD workflow(s) configured
17+
### Prerequisites
18+
You must have application(s) with CI-CD workflow(s) configured
1819
{% endhint %}
1920

2021
1. From the left sidebar, go to **Global Configurations****Filter Condition**.

docs/user-guide/global-configurations/image-promotion-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Moreover, there are three filters available to make the selections easier for yo
144144
Users need to have super-admin permission to apply an image promotion policy.
145145
{% endhint %}
146146

147-
You can apply a policy using our APIs or through [Devtron CLI](https://github.com/devtron-labs/devtron-cli). Here is the CLI approach:
147+
You can apply a policy using our APIs or through Devtron CLI. Here is the CLI approach:
148148

149149
* 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.
150150

docs/user-guide/plugins/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Preset Plugins
1+
# Pipeline Plugins
22

3-
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.
3+
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.
44

55
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.
66

docs/user-guide/resource-browser.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
## Introduction
44

5-
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.
5+
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.
66

77
{% hint style="info" %}
88
### Additional References
99
* [Resource browser versus traditional tools like kubectl](https://devtron.ai/blog/managing-kubernetes-resources-across-multiple-clusters)
1010
* [Why you should use Devtron's Resource Browser](https://devtron.ai/blog/what-is-the-kubernetes-resource-browser-in-devtron)
1111
{% endhint %}
1212

13-
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.
13+
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.
1414

1515
![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)
1616

17-
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).
17+
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).
1818

1919
You may click a cluster to view and manage all its resources as shown below.
2020

docs/user-guide/use-cases/oci-pull.md

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

55
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).
66

7-
**Pre-requisites**
7+
**Prerequisites**
88

99
* Helm Chart(s)
1010
* OCI-compliant Registry (e.g. Docker Hub and [many more](../global-configurations/container-registries.md#supported-registry-providers))

0 commit comments

Comments
 (0)