Skip to content

Commit 887771a

Browse files
committed
#1963 Regenerate docs with updated .gotmpl files for absolute links
Update the documentation by regenerating it from the updated .helm-docs.gotmpl files, ensuring that the latest template changes, specifically the conversion to absolute links, are applied. Signed-off-by: Boris Shek <[email protected]>
1 parent abf8262 commit 887771a

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

hooks/finding-post-processing/docs/README.ArtifactHub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Kubernetes: `>=v1.11.0-0`
6060

6161
### Rule Configuration
6262
The _rules_ can be defined in the `values` of the HelmChart.
63-
The syntax and semantic for these rules are quite similar to CascadingRules (See: [secureCodeBox | CascadingRules](/docs/api/crds/cascading-rule))
63+
The syntax and semantic for these rules are quite similar to CascadingRules (See: [secureCodeBox | CascadingRules](https://www.securecodebox.io/docs/api/crds/cascading-rule))
6464

6565
To define rules you will have to provide the `rules` field with one or more `matches` elements.
6666
Each `machtes` defines one Rule.

hooks/notification/docs/README.ArtifactHub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ This means that you can define key-value pairs as well as providing envs via sec
133133
#### Rule Configuration
134134
135135
The rules can be defined in the values of the Chart.
136-
The syntax and semantic for these rules are quite similar to CascadingRules (See: [secureCodeBox | CascadingRules](/docs/api/crds/cascading-rule))
136+
The syntax and semantic for these rules are quite similar to CascadingRules (See: [secureCodeBox | CascadingRules](https://www.securecodebox.io/docs/api/crds/cascading-rule))
137137
To define Rules you will have to provide the `rules` field with one or more `matches` elements.
138138
Each `matches` defines one Rule.
139139
For example:

scanners/git-repo-scanner/docs/README.ArtifactHub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can find resources to help you get started on our [documentation website](ht
4343
## What is Git-Repo-Scanner?
4444

4545
Git-Repo-Scanner is a small Python script which discovers repositories on GitHub or GitLab. The main purpose of this scanner
46-
is to provide a cascading input for the [gitleaks](/docs/scanners/gitleaks) and [semgrep](/docs/scanners/semgrep) scanners.
46+
is to provide a cascading input for the [gitleaks](https://www.securecodebox.io/docs/scanners/gitleaks) and [semgrep](https://www.securecodebox.io/docs/scanners/semgrep) scanners.
4747

4848
## Deployment
4949
The git-repo-scanner chart can be deployed via helm:

scanners/git-repo-scanner/docs/README.DockerHub-Parser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ docker pull securecodebox/parser-git-repo-scanner
5454
## What is Git-Repo-Scanner?
5555

5656
Git-Repo-Scanner is a small Python script which discovers repositories on GitHub or GitLab. The main purpose of this scanner
57-
is to provide a cascading input for the [gitleaks](/docs/scanners/gitleaks) and [semgrep](/docs/scanners/semgrep) scanners.
57+
is to provide a cascading input for the [gitleaks](https://www.securecodebox.io/docs/scanners/gitleaks) and [semgrep](https://www.securecodebox.io/docs/scanners/semgrep) scanners.
5858

5959
## Community
6060

scanners/git-repo-scanner/docs/README.DockerHub-Scanner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ docker pull securecodebox/scanner-git-repo-scanner
5454
## What is Git-Repo-Scanner?
5555

5656
Git-Repo-Scanner is a small Python script which discovers repositories on GitHub or GitLab. The main purpose of this scanner
57-
is to provide a cascading input for the [gitleaks](/docs/scanners/gitleaks) and [semgrep](/docs/scanners/semgrep) scanners.
57+
is to provide a cascading input for the [gitleaks](https://www.securecodebox.io/docs/scanners/gitleaks) and [semgrep](https://www.securecodebox.io/docs/scanners/semgrep) scanners.
5858

5959
## Scanner Configuration
6060

scanners/semgrep/docs/README.ArtifactHub.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ Due to the large variety of options, we do not provide documentation for all of
108108
Refer to the linked documentation for details on the different methods, and remember to use [Kubernetes secrets](https://kubernetes.io/docs/concepts/configuration/secret/) to manage keys and tokens.
109109
110110
## Cascading Rules
111-
By default, the semgrep scanner does not install any [cascading rules](/docs/hooks/cascading-scans), as some aspects of the semgrep scan (like the used ruleset) should be customized.
112-
However, you can easily create your own cascading rule, for example to run semgrep on the output of [git-repo-scanner](/docs/scanners/git-repo-scanner).
111+
By default, the semgrep scanner does not install any [cascading rules](https://www.securecodebox.io/docs/hooks/cascading-scans), as some aspects of the semgrep scan (like the used ruleset) should be customized.
112+
However, you can easily create your own cascading rule, for example to run semgrep on the output of [git-repo-scanner](https://www.securecodebox.io/docs/scanners/git-repo-scanner).
113113
As a starting point, consider the following cascading rule to scan all public GitHub repositories found by git-repo-scanner using the p/ci ruleset of semgrep:
114114
115115
```yaml

0 commit comments

Comments
 (0)