Skip to content

Commit 45c341c

Browse files
authored
Collated Doc Fixes for July (#5591)
1 parent a3c112c commit 45c341c

File tree

6 files changed

+19
-10
lines changed

6 files changed

+19
-10
lines changed

.gitbook.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,5 @@ redirects:
126126
user-guide/creating-application/workflow/ci-pipeline2: user-guide/creating-application/workflow/ci-pipeline.md
127127
user-guide/clusters: user-guide/resource-browser.md
128128
usage/clusters: user-guide/resource-browser.md
129-
global-configurations/authorization/sso-login/okta: user-guide/global-configurations/authorization/sso/okta.md
129+
global-configurations/authorization/sso-login/okta: user-guide/global-configurations/authorization/sso/okta.md
130+
usage/applications/creating-application/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/ci-build-pre-post-plugins.md

docs/user-guide/deploying-application/image-labels-and-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can add labels and comments from the following pages:
3535

3636
{% hint style="warning" %}
3737
You can add multiple labels to an image. but each label can be used only once 'per image, per application'. You may use it in an image of other application though. <br />
38-
Refer [Deleting Labels](#deleting-labels--comments) if you commit a mistake while adding labels.
38+
Refer [Deleting Labels](#deleting-labels-and-comments) if you commit a mistake while adding labels.
3939
{% endhint %}
4040

4141
### From Build & Deploy

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Before you start creating an application, we recommend to provide basic informat
2424

2525
[Notifications](manage-notification.md)
2626

27+
[Deployment Window](deployment-window.md)
28+
2729
[External Links](external-links.md)
2830

2931
[Catalog Framework](catalog-framework.md)
@@ -34,12 +36,12 @@ Before you start creating an application, we recommend to provide basic informat
3436

3537
[Tags Policy](tags-policy.md)
3638

39+
[Filter Condition](filter-condition.md)
40+
3741
[Lock Deployment Configuration](lock-deployment-config.md)
3842

3943
[Image Promotion Policy](image-promotion-policy.md)
4044

41-
[Filter Condition](filter-condition.md)
42-
4345
[Build Infra](build-infra.md)
4446

4547
You can also refer our YouTube video provided here.

docs/user-guide/plugins/plugin-list.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
We have multiple plugins available in Devtron. At the moment, here are the plugins for which user guide is available.
44

55
* [Codacy](./codacy.md)
6+
* [Code-Scan](./code-scan.md)
7+
* [Copacetic](./copacetic.md)
68
* [Copy Container Image](./copy-container-image.md)
79
* [Dependency track - Maven & Gradle](./dependency-track-maven-gradle.md)
810
* [Dependency track - NodeJS](./dependency-track-nodejs.md)
911
* [Dependency track - Python](./dependency-track-python.md)
1012
* [GoLang-migrate](./golang-migrate.md)
13+
* [Jenkins](./jenkins.md)
1114
* [K6 Load Testing](./k6-load-testing.md)
15+
* [Pull images from container repository](./pull-images-from-container-repository.md)
1216
* [Semgrep](./semgrep.md)
1317
* [SonarQube](./sonarqube.md)
1418
* [SonarQube v1.1.0](./sonarqube-v1.1.0.md)

docs/user-guide/resource-browser.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This shows the combined CPU and memory consumption of all running pods in the cl
4545

4646
This shows errors in the cluster. If no error is present in the cluster, Resource Browser will not display this section.
4747

48-
### Catalog Framework
48+
### Catalog Framework [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
4949

5050
{% hint style="warning" %}
5151
### Who Can Perform This Action?
@@ -72,12 +72,14 @@ You can also include additional information about your cluster using the Markdow
7272
Users need to have [access to the cluster](./global-configurations/authorization/user-access.md#kubernetes-resources-permissions) to discover resources.
7373
{% endhint %}
7474

75-
### Search and Filter
75+
### Search Resources
7676

7777
You can use the searchbox to browse the resources.
7878

7979
![Figure 4: Locate Resources using Searchbox](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/discover-resource.gif)
8080

81+
### Filter Resources [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
82+
8183
Moreover, you can use filters that allow you to quickly filter your workload as per labels, field selectors, or [CEL expression](https://kubernetes.io/docs/reference/using-api/cel/) as shown below.
8284

8385
{% embed url="https://www.youtube.com/watch?v=E-V-ELCXtfs" caption="Filtering Workloads in Devtron" %}
@@ -294,7 +296,7 @@ Moreover, you can download the pod logs for ease of sharing and troubleshooting
294296

295297
{% embed url="https://www.youtube.com/watch?v=PP0ZKAZCT58" caption="Downloading Pod Logs" %}
296298

297-
#### Pod Last Restart Snapshot
299+
#### Pod Last Restart Snapshot [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
298300

299301
Frequent pod restarts can impact your application as it might lead to unexpected downtimes. In such cases, it is important to determine the root cause and take actions (both preventive and corrective) if needed.
300302

@@ -451,7 +453,7 @@ spec:
451453
452454
---
453455
454-
## Running Kubectl Commands Locally
456+
## Running Kubectl Commands Locally [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
455457
456458
### Introduction
457459
@@ -522,7 +524,7 @@ If you are not a super-admin and can't generate a token yourself, you can find t
522524
Once the connection is successful, you may run any [kubectl operations](https://kubernetes.io/docs/reference/kubectl/#operations) from your system.
523525
{% endhint %}
524526

525-
### Use Case - Port Forwarding
527+
### Use Case - Port Forwarding [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
526528

527529
Assume your applications are running in a Kubernetes cluster on cloud. Now, if you wish to test or debug them on your local machine, you can perform [port forwarding](https://kubernetes.io/docs/tasks/access-application-cluster/port-forward-access-application-cluster/). It creates a tunnel between a port on your machine and a port on a resource within your cluster. Therefore, you can access applications running inside the cluster as though they are running locally on your machine.
528530

docs/user-guide/sdh/tenants.md

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

33
## Introduction [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
44

5-
This section allows you to add new [tenants](#tenants) and map environments to these [installations](./README.md#installations) to ensure updates [rollout](#rollout) correctly.
5+
This section allows you to add new [tenants](./README.md#tenants) and map environments to these [installations](./README.md#installations) to ensure updates [rollout](./README.md#rollout) correctly.
66

77
---
88

0 commit comments

Comments
 (0)