Skip to content

Commit

Permalink
doc: Fixed Redirections and Broken Links (#4634)
Browse files Browse the repository at this point in the history
* Fixed Redirections and Broken Links

* Rolling back license-related changes

* CO Feedback Incorporated - Removed License Section
  • Loading branch information
ashokdevtron committed Feb 15, 2024
1 parent de6f677 commit 285a2e4
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 26 deletions.
8 changes: 7 additions & 1 deletion .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,10 @@ redirects:
user-guide/use-cases/connect-django-with-mysql-database: resources/use-cases/connect-django-with-mysql-database
user-guide/telemetry: resources/telemetry
getting-started/global-configurations/container-registries: user-guide/global-configurations/container-registries.md
getting-started/global-configurations/sso-login: user-guide/global-configurations/sso-login.md
getting-started/global-configurations/sso-login: user-guide/global-configurations/sso-login.md
getting-started/global-configurations/docker-registries: user-guide/global-configurations/container-registries.md
global-configurations/sso-login: user-guide/global-configurations/sso-login
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

4 changes: 0 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,3 @@ Get updates on Devtron's development and chat with the project maintainers, cont
## Vulnerability Reporting

We, at Devtron, take security and our users' trust very seriously. If you believe you have found a security issue in Devtron, please responsibly disclose it by contacting us at **security@devtron.ai**.

## License

Devtron is available under the [Apache License, Version 2.0](https://github.com/devtron-labs/devtron/blob/main/LICENSE).
4 changes: 0 additions & 4 deletions docs/hyperion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,3 @@ Get updates on Devtron's development and chat with the project maintainers, cont
## Vulnerability Reporting

We at Devtron take security and our users' trust very seriously. If you believe you have found a security issue in Devtron, please responsibly disclose by contacting us at security@devtron.ai.

## License

Devtron is available under the [Apache License, Version 2.0](https://github.com/devtron-labs/devtron/blob/main/LICENSE)
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,7 @@ It gives the realtime metrics of the deployed applications
## 2. Show application metrics

If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/deployment-template/deployment_application_metrics.jpg)

Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](workflow/) to do CI/CD.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -968,6 +968,7 @@ It gives the realtime metrics of the deployed applications
## 2. Show application metrics

If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/deployment-template/deployment_application_metrics.jpg)

Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](workflow/) to do CI/CD.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following fields are provided on the **Store Container Image** section:

| Field | Description |
| --- | --- |
| **Container Registry** | Select the container registry from the drop-down list or you can click **Add Container Registry**. This registry will be used to [store docker images](../global-configurations/docker-registries.md). |
| **Container Registry** | Select the container registry from the drop-down list or you can click **Add Container Registry**. This registry will be used to [store docker images](../global-configurations/container-registries.md). |
| **Container Repository** | Enter the name of your container repository, preferably in the format `username/repo-name`. The repository that you specify here will store a collection of related docker images. Whenever an image is added here, it will be stored with a new tag version. |

**If you are using docker hub account, you need to enter the repository name along with your username. For example - If my username is *kartik579* and repo name is *devtron-trial*, then enter kartik579/devtron-trial instead of only devtron-trial.**
Expand Down
8 changes: 5 additions & 3 deletions docs/user-guide/global-configurations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,20 @@ Before you start creating an application, we recommend to provide basic informat

[Custom Charts](custom-charts.md)

[SSO Login Services](sso-login.md)

[Authorization](authorization.md)
[Authorization](authorization/README.md)

[Notifications](manage-notification.md)

[External Links](external-links.md)

[Catalog Framework](catalog-framework.md)

[Scoped Variables](scoped-variables.md)

[Tags Policy](tags-policy.md)

[Filter Condition](filter-condition.md)

You can also refer our YouTube video provided here.

{% embed url="https://www.youtube.com/watch?v=4VFjrjtieMI" caption="" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Using the `Permission groups`, you can assign a user to a particular group and a
The advantage of the `Permission groups` is to define a set of privileges like create, edit, or delete for the given set of resources that can be shared among the users within the group.

{% hint style="info" %}
The [User permissions](../../global-configurations/authorization/user-access) section for `Specific permissions` contains a drop-down list of all existing groups for which a user has an access. This is an optional field and more than one groups can be selected for a user.
The [User permissions](../../global-configurations/authorization/user-access.md) section for `Specific permissions` contains a drop-down list of all existing groups for which a user has an access. This is an optional field and more than one groups can be selected for a user.
{% endhint %}

## Add Group
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/jobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There are two main steps in executing Job:

* [Configurations](configuration-job.md)

* [Trigger Job](triggering-cd.md)
* [Trigger Job](triggering-job.md)

In the next section, we will learn on how to create, configure, trigger a job. You can also view the details on the [Overview](overview-job.md) tab and `Run History`.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/security-features/security-policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
### Prerequisite

Install any one of the following integrations for scanning vulnerabilities:
* [Clair](../user-guide/integrations/clair.md)
* [Clair](../../user-guide/integrations/clair.md)
* Trivy
{% endhint %}

Expand Down
12 changes: 6 additions & 6 deletions docs/user-guide/security-features/security-scans.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
### Prerequisite

Install any one of the following integrations for scanning vulnerabilities:
* [Clair](../user-guide/integrations/clair.md)
* [Clair](../../user-guide/integrations/clair.md)
* Trivy
{% endhint %}

Devtron's CI pipeline provides a [**Scan for vulnerabilities**](creating-application/workflow/ci-pipeline.md#scan-for-vulnerabilities) option as shown below. Once you enable this option, it will automatically scan the image for vulnerabilities.
Devtron's CI pipeline provides a [**Scan for vulnerabilities**](../creating-application/workflow/ci-pipeline.md#scan-for-vulnerabilities) option as shown below. Once you enable this option, it will automatically scan the image for vulnerabilities.

![Figure 1: Scan for vulnerabilities](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/security-features/new/enable-image-scan.jpg)

Expand All @@ -25,10 +25,10 @@ To access the comprehensive security scan reports, follow these steps:

1. In the left sidebar, click **Security** and go to the `Security Scans` tab.

{% hint style="warning" %}
### Who Can Perform This Action?
Users need to have super-admin permission to view the 'Security Scans' page.
{% endhint %}
{% hint style="warning" %}
### Who Can Perform This Action?
Users need to have super-admin permission to view the 'Security Scans' page.
{% endhint %}

2. Select the desired application from the available list.

Expand Down
4 changes: 0 additions & 4 deletions docs/user-guide/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,3 @@ Check out our [contributing guidelines](https://github.com/devtron-labs/devtron-

We at Devtron take security and our users' trust very seriously. If you believe you have found a security issue in Devtron, please responsibly disclose by contacting us at security@devtron.ai.

## License

Devtron is available under the [Apache License, Version 2.0](https://github.com/devtron-labs/devtron-documentation/tree/1c2b95254995286ac0c3e8379117eb82a7ed8407/LICENSE/README.md)

0 comments on commit 285a2e4

Please sign in to comment.