Skip to content

Commit 49456ba

Browse files
itayskDmitriyLewen
itaysk
and
DmitriyLewen
authored
fix: update all documentation links (#8045)
Co-authored-by: DmitriyLewen <[email protected]>
1 parent b3521e8 commit 49456ba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1293
-309
lines changed

‎.github/DISCUSSION_TEMPLATE/bugs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
1111
**Do not open a GitHub issue, please.** Maintainers triage discussions and then create issues.
1212
13-
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
13+
Please also check [our contribution guidelines](https://trivy.dev/latest/community/contribute/discussion/).
1414
- type: textarea
1515
attributes:
1616
label: Description
@@ -117,7 +117,7 @@ body:
117117
description: Have you tried the following?
118118
options:
119119
- label: Run `trivy clean --all`
120-
- label: Read [the troubleshooting](https://aquasecurity.github.io/trivy/latest/docs/references/troubleshooting/)
120+
- label: Read [the troubleshooting](https://trivy.dev/latest/docs/references/troubleshooting/)
121121
- type: markdown
122122
attributes:
123123
value: |

‎.github/DISCUSSION_TEMPLATE/documentation.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ body:
77
Feel free to create a docs report if something doesn't work as expected or is unclear in the documentation.
88
Please ensure that you're not creating a duplicate report by searching the [issues](https://github.com/aquasecurity/trivy/issues)/[discussions](https://github.com/aquasecurity/trivy/discussions) beforehand.
99
10-
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
10+
Please also check [our contribution guidelines](https://trivy.dev/latest/community/contribute/discussion/).
1111
- type: textarea
1212
attributes:
1313
label: Description

‎.github/DISCUSSION_TEMPLATE/false-detection.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
99
**Do not open a GitHub issue, please.** Maintainers triage discussions and then create issues.
1010
11-
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
11+
Please also check [our contribution guidelines](https://trivy.dev/latest/community/contribute/discussion/).
1212
- type: input
1313
attributes:
1414
label: IDs
@@ -86,7 +86,7 @@ body:
8686
attributes:
8787
label: Checklist
8888
options:
89-
- label: Read [the documentation regarding wrong detection](https://aquasecurity.github.io/trivy/dev/community/contribute/discussion/#false-detection)
89+
- label: Read [the documentation regarding wrong detection](https://trivy.dev/dev/community/contribute/discussion/#false-detection)
9090
- label: Ran Trivy with `-f json` that shows data sources and confirmed that the security advisory in data sources was correct
9191
validations:
9292
required: true

‎.github/DISCUSSION_TEMPLATE/ideas.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
1010
**Do not open a GitHub issue, please.** Maintainers triage discussions and then create issues.
1111
12-
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
12+
Please also check [our contribution guidelines](https://trivy.dev/latest/community/contribute/discussion/).
1313
- type: textarea
1414
attributes:
1515
label: Description

‎.github/DISCUSSION_TEMPLATE/q-a.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
1010
**Do not open a GitHub issue, please.** Maintainers triage discussions and then create issues.
1111
12-
Please also check [our contribution guidelines](https://aquasecurity.github.io/trivy/latest/community/contribute/discussion/).
12+
Please also check [our contribution guidelines](https://trivy.dev/latest/community/contribute/discussion/).
1313
- type: textarea
1414
attributes:
1515
label: Question

‎.github/pull_request_template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
Remove this section if you don't have related PRs.
1111

1212
## Checklist
13-
- [ ] I've read the [guidelines for contributing](https://aquasecurity.github.io/trivy/latest/community/contribute/pr/) to this repository.
14-
- [ ] I've followed the [conventions](https://aquasecurity.github.io/trivy/latest/community/contribute/pr/#title) in the PR title.
13+
- [ ] I've read the [guidelines for contributing](https://trivy.dev/latest/community/contribute/pr/) to this repository.
14+
- [ ] I've followed the [conventions](https://trivy.dev/latest/community/contribute/pr/#title) in the PR title.
1515
- [ ] I've added tests that prove my fix is effective or that my feature works.
1616
- [ ] I've updated the [documentation](https://github.com/aquasecurity/trivy/blob/main/docs) with the relevant information (if needed).
1717
- [ ] I've added usage information (if the PR introduces new options)

‎.github/workflows/auto-close-issue.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
2727
// If the user does not have write or admin permissions, leave a comment and close the issue
2828
if (permission !== 'write' && permission !== 'admin') {
29-
const commentBody = "Please see https://aquasecurity.github.io/trivy/latest/community/contribute/issue/";
29+
const commentBody = "Please see https://trivy.dev/latest/community/contribute/issue/";
3030
await github.rest.issues.createComment({
3131
owner: context.repo.owner,
3232
repo: context.repo.repo,

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
See [Issues](https://aquasecurity.github.io/trivy/latest/community/contribute/issue/) and [Pull Requests](https://aquasecurity.github.io/trivy/latest/community/contribute/pr/)
1+
See [Issues](https://trivy.dev/latest/community/contribute/issue/) and [Pull Requests](https://trivy.dev/latest/community/contribute/pr/)

‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ Please ensure to abide by our [Code of Conduct][code-of-conduct] during all inte
131131
[license]: https://github.com/aquasecurity/trivy/blob/main/LICENSE
132132
[license-img]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
133133
[homepage]: https://trivy.dev
134-
[docs]: https://aquasecurity.github.io/trivy
134+
[docs]: https://trivy.dev/trivy
135135
[pronunciation]: #how-to-pronounce-the-name-trivy
136136
[slack]: https://slack.aquasec.com
137137
[code-of-conduct]: https://github.com/aquasecurity/community/blob/main/CODE_OF_CONDUCT.md
138138

139-
[Installation]:https://aquasecurity.github.io/trivy/latest/getting-started/installation/
140-
[Ecosystem]: https://aquasecurity.github.io/trivy/latest/ecosystem/
141-
[Scanning Coverage]: https://aquasecurity.github.io/trivy/latest/docs/coverage/
139+
[Installation]:https://trivy.dev/latest/getting-started/installation/
140+
[Ecosystem]: https://trivy.dev/latest/ecosystem/
141+
[Scanning Coverage]: https://trivy.dev/latest/docs/coverage/
142142

143143
[alpine]: https://ariadne.space/2021/06/08/the-vulnerability-remediation-lifecycle-of-alpine-containers/
144144
[rego]: https://www.openpolicyagent.org/docs/latest/#rego

‎docs/commercial/compare.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ If you'd like to learn more or request a demo, [click here to contact us](./cont
6666

6767
| Feature | Trivy OSS | Aqua |
6868
| --- | --- | --- |
69-
| Infrastructure as Code (IaC) | Many popular languages as detailed [here](https://aquasecurity.github.io/trivy/latest/docs/scanner/misconfiguration/policy/builtin/) | In addition, Build Pipeline configuration scanning |
69+
| Infrastructure as Code (IaC) | Many popular languages as detailed [here](https://trivy.dev/latest/docs/scanner/misconfiguration/policy/builtin/) | In addition, Build Pipeline configuration scanning |
7070
| Checks customization | Create custom checks with Rego | Create custom checks in no-code interface <br> Customize existing checks with organizational preferences |
7171
| Cloud scanning | AWS (subset of services) | AWS, Azure, GCP, Alibaba Cloud, Oracle Cloud |
7272
| Compliance frameworks | CIS, NSA, vendor guides | More than 25 compliance programs |

‎docs/community/contribute/discussion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ There are 4 categories:
2424
If you find any false positives or false negatives, please make sure to report them under the "False Detection" category, not "Bugs".
2525

2626
## False detection
27-
Trivy depends on [multiple data sources](https://aquasecurity.github.io/trivy/latest/docs/scanner/vulnerability/#data-sources).
27+
Trivy depends on [multiple data sources](https://trivy.dev/latest/docs/scanner/vulnerability/#data-sources).
2828
Sometime these databases contain mistakes.
2929

3030
If Trivy can't detect any CVE-IDs or shows false positive result, at first please follow the next steps:

‎docs/docs/advanced/air-gap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ External Resource | Feature | Details
1010
Vulnerability Database | Vulnerability scanning | [Trivy DB](../scanner/vulnerability.md)
1111
Java Vulnerability Database | Java vulnerability scanning | [Trivy Java DB](../coverage/language/java.md)
1212
Checks Bundle | Misconfigurations scanning | [Trivy Checks](../scanner/misconfiguration/check/builtin.md)
13-
VEX Hub | VEX Hub | [VEX Hub](../supply-chain/vex/repo/#vex-hub)
13+
VEX Hub | VEX Hub | [VEX Hub](../supply-chain/vex/repo.md)
1414
Maven Central / Remote Repositories | Java vulnerability scanning | [Java Scanner/Remote Repositories](../coverage/language/java.md#remote-repositories)
1515

1616
!!! note

‎docs/docs/advanced/self-hosting.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@ To make a copy of VEX Hub in a location that is accessible to Trivy.
123123

124124
To configure Trivy to use the local VEX Repository:
125125

126-
1. Locate your [Trivy VEX configuration file](../supply-chain/vex/repo/#configuration-file) by running `trivy vex repo init`. Make the following changes to the file.
126+
1. Locate your [Trivy VEX configuration file](../supply-chain/vex/repo.md#configuration-file) by running `trivy vex repo init`. Make the following changes to the file.
127127
1. Disable the default VEX Hub repo (`enabled: false`)
128-
1. Add your internal VEX Hub repository as a [custom repository](../supply-chain/vex/repo/#custom-repositories) with the URL pointing to your local server (e.g `url: https://server.local`).
128+
1. Add your internal VEX Hub repository as a [custom repository](../supply-chain/vex/repo.md#custom-repositories) with the URL pointing to your local server (e.g `url: https://server.local`).
129129

130130
### Authentication
131131

132-
If your server requires authentication, you can configure it as described in the [VEX Repository Authentication document](../supply-chain/vex/repo/#authentication).
132+
If your server requires authentication, you can configure it as described in the [VEX Repository Authentication document](../supply-chain/vex/repo.md#authentication).

‎docs/docs/compliance/compliance.md

-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ For the list of built-in compliance reports, please see the relevant section:
3535

3636
- [Docker compliance](../target/container_image.md#compliance)
3737
- [Kubernetes compliance](../target/kubernetes.md#compliance)
38-
- [AWS compliance](../target/aws.md#compliance)
3938

4039
## Contribute a Built-in Compliance Report
4140

‎docs/docs/configuration/cache.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ $ trivy server --cache-backend redis://localhost:6379 \
9696
--redis-key /path/to/key.pem
9797
```
9898

99-
[trivy-db]: ./db.md#vulnerability-database
100-
[trivy-java-db]: ./db.md#java-index-database
99+
[trivy-db]: ./db.md
100+
[trivy-java-db]: ./db.md
101101
[misconf-checks]: ../scanner/misconfiguration/check/builtin.md
102102
[boltdb]: https://github.com/etcd-io/bbolt
103-
[parallel-run]: https://aquasecurity.github.io/trivy/v0.52/docs/references/troubleshooting/#running-in-parallel-takes-same-time-as-series-run
103+
[parallel-run]: https://trivy.dev/{{ git.tag}}/docs/references/troubleshooting/#running-in-parallel-takes-same-time-as-series-run
104104

105105
[^1]: Downloaded when scanning for vulnerabilities
106106
[^2]: Downloaded when scanning `jar/war/par/ear` files

‎docs/docs/configuration/filtering.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ $ trivy image --ignorefile ./.trivyignore.yaml python:3.9.16-alpine3.16
394394
2023-08-31T11:10:27.155+0600 INFO Vulnerability scanning is enabled
395395
2023-08-31T11:10:27.155+0600 INFO Secret scanning is enabled
396396
2023-08-31T11:10:27.155+0600 INFO If your scanning is slow, please try '--scanners vuln' to disable secret scanning
397-
2023-08-31T11:10:27.155+0600 INFO Please see also https://aquasecurity.github.io/trivy/dev/docs/scanner/secret/#recommendation for faster secret detection
397+
2023-08-31T11:10:27.155+0600 INFO Please see also https://trivy.dev/dev/docs/scanner/secret/#recommendation for faster secret detection
398398
2023-08-31T11:10:29.164+0600 INFO Detected OS: alpine
399399
2023-08-31T11:10:29.164+0600 INFO Detecting Alpine vulnerabilities...
400400
2023-08-31T11:10:29.169+0600 INFO Number of language-specific files: 1

‎docs/docs/configuration/reporting.md

-16
Original file line numberDiff line numberDiff line change
@@ -124,22 +124,6 @@ Then, you can try to update **[email protected]** and **[email protected]** to reso
124124
$ trivy image -f json -o results.json alpine:latest
125125
```
126126

127-
<details>
128-
<summary>Result</summary>
129-
130-
```
131-
2024-12-26T22:01:18+05:30 INFO [vuln] Vulnerability scanning is enabled
132-
2024-12-26T22:01:18+05:30 INFO [secret] Secret scanning is enabled
133-
2024-12-26T22:01:18+05:30 INFO [secret] If your scanning is slow, please try '--scanners vuln' to disable secret scanning
134-
2024-12-26T22:01:18+05:30 INFO [secret] Please see also https://aquasecurity.github.io/trivy/v0.58/docs/scanner/secret#recommendation for faster secret detection
135-
2024-12-26T22:01:18+05:30 INFO Detected OS family="alpine" version="3.20.3"
136-
2024-12-26T22:01:18+05:30 INFO [alpine] Detecting vulnerabilities... os_version="3.20" repository="3.20" pkg_num=14
137-
2024-12-26T22:01:18+05:30 INFO Number of language-specific files num=0
138-
2024-12-26T22:01:18+05:30 WARN Using severities from other vendors for some vulnerabilities. Read https://aquasecurity.github.io/trivy/v0.58/docs/scanner/vulnerability#severity-selection for details.
139-
```
140-
141-
</details>
142-
143127
<details>
144128
<summary>JSON</summary>
145129

‎docs/docs/references/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,5 +277,5 @@ $ trivy clean --all
277277
```
278278

279279
[air-gapped]: ../advanced/air-gap.md
280-
[network]: ../advanced/air-gap.md#network-requirements
280+
[network]: ../advanced/air-gap.md#connectivity-requirements
281281
[redis-cache]: ../configuration/cache.md#redis

‎docs/docs/supply-chain/attestation/rekor.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ trivy image --sbom-sources rekor otms61/alpine:3.7.3
2222
2022-09-16T17:37:13.258+0900 INFO Vulnerability scanning is enabled
2323
2022-09-16T17:37:13.258+0900 INFO Secret scanning is enabled
2424
2022-09-16T17:37:13.258+0900 INFO If your scanning is slow, please try '--scanners vuln' to disable secret scanning
25-
2022-09-16T17:37:13.258+0900 INFO Please see also https://aquasecurity.github.io/trivy/dev/docs/secret/scanning/#recommendation for faster secret detection
25+
2022-09-16T17:37:13.258+0900 INFO Please see also https://trivy.dev/dev/docs/secret/scanning/#recommendation for faster secret detection
2626
2022-09-16T17:37:14.827+0900 INFO Detected SBOM format: cyclonedx-json
2727
2022-09-16T17:37:14.901+0900 INFO Found SBOM (cyclonedx) attestation in Rekor
2828
2022-09-16T17:37:14.903+0900 INFO Detected OS: alpine

0 commit comments

Comments
 (0)