Update broken links in docs

kosli-dev · Nov 8, 2023 · 752f0a6 · 752f0a6
1 parent 07ab99a
commit 752f0a6
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 25 deletions.
diff --git a/charts/k8s-reporter/README.md b/charts/k8s-reporter/README.md
@@ -61,7 +61,7 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 | kosliApiToken.secretKey | string | `""` | the name of the key in the secret data which contains the kosli API token |
 | kosliApiToken.secretName | string | `""` | the name of the secret containing the kosli API token |
 | nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
-| podAnnotations | object | `{}` |  |
+| podAnnotations | object | `{}` | any custom annotations to be added to the cronjob |
 | reporterConfig.dryRun | bool | `false` | whether the dry run mode is enabled or not. In dry run mode, the reporter logs the reports to stdout and does not send them to kosli. |
 | reporterConfig.kosliEnvironmentName | string | `""` | the name of kosli environment that the k8s cluster/namespace correlates to |
 | reporterConfig.kosliOrg | string | `""` | the name of the kosli org |
@@ -74,5 +74,5 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 | serviceAccount.name | string | `""` | the name of the service account to use. If not set and create is true, a name is generated using the fullname template |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
 
diff --git a/docs.kosli.com/content/getting_started/approvals.md b/docs.kosli.com/content/getting_started/approvals.md
@@ -39,7 +39,7 @@ $ kosli pipeline approval report project-a-app.bin \
 approval created for artifact: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
 
-See [kosli pipeline approval report](/legacy_ref/v0.1.37/kosli_pipeline_approval_report/) and [kosli pipeline approval request](/legacy_ref/v0.1.37/kosli_pipeline_approval_request/) for more details. 
+See [kosli pipeline approval report](/legacy_ref/v0.1.41/kosli_pipeline_approval_report/) and [kosli pipeline approval request](/legacy_ref/v0.1.41/kosli_pipeline_approval_request/) for more details. 
 {{< /tab >}}
 
 {{< /tabs >}}

diff --git a/docs.kosli.com/content/getting_started/artifacts.md b/docs.kosli.com/content/getting_started/artifacts.md
@@ -49,7 +49,7 @@ $ kosli pipeline artifact report creation project-a-app.bin \
 
 artifact project-a-app.bin was reported with fingerprint: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
-See [kosli pipeline artifact report creation](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_creation/) for more details. 
+See [kosli pipeline artifact report creation](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_creation/) for more details. 
 
 {{< /tab >}}
 

diff --git a/docs.kosli.com/content/getting_started/deployments.md b/docs.kosli.com/content/getting_started/deployments.md
@@ -42,7 +42,7 @@ $ kosli expect deployment project-a-app.bin \
 
 expect deployment of artifact 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf was reported to: server-prod
 ```
-See [kosli expect deployment](/legacy_ref/v0.1.37/kosli_expect_deployment/) for more details.
+See [kosli expect deployment](/legacy_ref/v0.1.41/kosli_expect_deployment/) for more details.
 {{< /tab >}}
 
 {{< /tabs >}}
diff --git a/docs.kosli.com/content/getting_started/environments.md b/docs.kosli.com/content/getting_started/environments.md
@@ -139,7 +139,7 @@ $ kosli snapshot docker docs-demo-docker
 ```
 
 More details in [kosli snapshot docker](/client_reference/kosli_snapshot_docker/) reference  
-for v0.1.x: [kosli environment report docker](/legacy_ref/v0.1.37/kosli_environment_report_docker/) 
+for v0.1.x: [kosli environment report docker](/legacy_ref/v0.1.41/kosli_environment_report_docker/) 
 {{< /tab >}}
 
 {{< tab "ecs" >}}
@@ -169,7 +169,7 @@ $ kosli snapshot ecs ecs-prod \
 ```
 
 More details in [kosli snapshot ecs](/client_reference/kosli_snapshot_ecs/) reference  
-for v0.1.x: [kosli environment report ecs](/legacy_ref/v0.1.37/kosli_environment_report_ecs/) 
+for v0.1.x: [kosli environment report ecs](/legacy_ref/v0.1.41/kosli_environment_report_ecs/) 
 {{< /tab >}}
 
 {{< tab "k8s" >}}
@@ -199,7 +199,7 @@ kosli snapshot k8s yourEnvironmentName \
 ```
 
 More details in [kosli snapshot k8s](/client_reference/kosli_snapshot_k8s/) reference  
-for v0.1.x: [kosli environment report k8s](/legacy_ref/v0.1.37/kosli_environment_report_k8s/) 
+for v0.1.x: [kosli environment report k8s](/legacy_ref/v0.1.41/kosli_environment_report_k8s/) 
 {{< /tab >}}
 
 {{< tab "lambda" >}}
@@ -228,7 +228,7 @@ reporter-app-prod lambda function was reported to environment lambda-prod
 ```
 
 More details in [kosli snapshot lambda](/client_reference/kosli_snapshot_lambda/) reference   
-for v0.1.x: [kosli environment report lambda](/legacy_ref/v0.1.37/kosli_environment_report_lambda/) 
+for v0.1.x: [kosli environment report lambda](/legacy_ref/v0.1.41/kosli_environment_report_lambda/) 
 {{< /tab >}}
 
 {{< tab "s3" >}}
@@ -257,7 +257,7 @@ bucket app-public was reported to environment s3-prod
 ```
 
 More details in [kosli snapshot s3](/client_reference/kosli_snapshot_s3/) reference  
-for v0.1.x: [kosli environment report s3](/legacy_ref/v0.1.37/kosli_environment_report_s3/) 
+for v0.1.x: [kosli environment report s3](/legacy_ref/v0.1.41/kosli_environment_report_s3/) 
 {{< /tab >}}
 
 {{< tab "server" >}}
@@ -285,7 +285,7 @@ $ kosli snapshot server docs-demo-server --paths build/index.html
 ```
 
 More details in [kosli snapshot server](/client_reference/kosli_snapshot_server/)reference  
-for v0.1.x: [kosli environment report server](/legacy_ref/v0.1.37/kosli_environment_report_server/) 
+for v0.1.x: [kosli environment report server](/legacy_ref/v0.1.41/kosli_environment_report_server/) 
 {{< /tab >}}
 
 {{< /tabs >}}

diff --git a/docs.kosli.com/content/getting_started/evidence.md b/docs.kosli.com/content/getting_started/evidence.md
@@ -123,9 +123,9 @@ $ kosli pipeline artifact report evidence github-pullrequest project-a-app.bin \
 github pull request evidence is reported to artifact: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
 For more details see:  
-[kosli pipeline artifact report evidence github-pullrequest](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_github-pullrequest/)  
-[kosli pipeline artifact report evidence bitbucket-pullrequest](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest/)  
-[kosli pipeline artifact report evidence gitlab-mergerequest](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest/)
+[kosli pipeline artifact report evidence github-pullrequest](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_github-pullrequest/)  
+[kosli pipeline artifact report evidence bitbucket-pullrequest](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest/)  
+[kosli pipeline artifact report evidence gitlab-mergerequest](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest/)
 {{< /tab >}}
 
 {{< tab "Commit v2" >}}
@@ -161,9 +161,9 @@ $ kosli commit report evidence github-pullrequest \
 github pull request evidence is reported to commit: e67f2f2b121f9325ebf166b7b3c707f73cb48b14
 ```
 For more details see:  
-[kosli commit report evidence github-pullrequest](/legacy_ref/v0.1.37/kosli_commit_report_evidence_github-pullrequest/)  
-[kosli commit report evidence bitbucket-pullrequest](/legacy_ref/v0.1.37/kosli_commit_report_evidence_bitbucket-pullrequest/)  
-[kosli commit report evidence gitlab-mergerequest](/legacy_ref/v0.1.37/kosli_commit_report_evidence_gitlab-mergerequest/)
+[kosli commit report evidence github-pullrequest](/legacy_ref/v0.1.41/kosli_commit_report_evidence_github-pullrequest/)  
+[kosli commit report evidence bitbucket-pullrequest](/legacy_ref/v0.1.41/kosli_commit_report_evidence_bitbucket-pullrequest/)  
+[kosli commit report evidence gitlab-mergerequest](/legacy_ref/v0.1.41/kosli_commit_report_evidence_gitlab-mergerequest/)
 {{< /tab >}}
 
 {{< /tabs >}}
@@ -205,7 +205,7 @@ $ kosli pipeline artifact report evidence junit project-a-app.bin \
 
 junit test evidence is reported to artifact: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
-See [kosli pipeline artifact report evidence junit](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_junit/) for more details
+See [kosli pipeline artifact report evidence junit](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_junit/) for more details
 {{< /tab >}}
 
 {{< tab "Commit v2" >}}
@@ -233,7 +233,7 @@ $ kosli commit report evidence junit \
 
 junit test evidence is reported to commit: e67f2f2b121f9325ebf166b7b3c707f73cb48b14
 ```
-See [kosli commit report evidence junit](/legacy_ref/v0.1.37/kosli_commit_report_evidence_junit/) for more details
+See [kosli commit report evidence junit](/legacy_ref/v0.1.41/kosli_commit_report_evidence_junit/) for more details
 {{< /tab >}}
 
 
@@ -276,7 +276,7 @@ $ kosli pipeline artifact report evidence snyk project-a-app.bin \
 
 snyk scan evidence is reported to artifact: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
-See [kosli pipeline artifact report evidence snyk](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_snyk/) for more details
+See [kosli pipeline artifact report evidence snyk](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_snyk/) for more details
 {{< /tab >}}
 
 {{< tab "Commit v2" >}}
@@ -304,7 +304,7 @@ $ kosli commit report evidence snyk \
 
 snyk scan evidence is reported to commit: e67f2f2b121f9325ebf166b7b3c707f73cb48b14
 ```
-See [kosli commit report evidence snyk](/legacy_ref/v0.1.37/kosli_commit_report_evidence_snyk/) for more details
+See [kosli commit report evidence snyk](/legacy_ref/v0.1.41/kosli_commit_report_evidence_snyk/) for more details
 {{< /tab >}}
 
 {{< /tabs >}}
@@ -378,7 +378,7 @@ $ kosli pipeline artifact report evidence generic project-a-app.bin \
 
 generic evidence 'code-coverage' is reported to artifact: 53c97572093cc107c0caa2906d460ccd65083a4c626f68689e57aafa34b14cbf
 ```
-See [kosli pipeline artifact report evidence generic](/legacy_ref/v0.1.37/kosli_pipeline_artifact_report_evidence_generic/) for more details
+See [kosli pipeline artifact report evidence generic](/legacy_ref/v0.1.41/kosli_pipeline_artifact_report_evidence_generic/) for more details
 {{< /tab >}}
 
 {{< tab "Commit v2" >}}
@@ -406,7 +406,7 @@ $ kosli commit report evidence generic \
 
 generic evidence 'code-coverage' is reported to commit: e67f2f2b121f9325ebf166b7b3c707f73cb48b14
 ```
-See [kosli commit report evidence generic](/legacy_ref/v0.1.37/kosli_commit_report_evidence_generic/) for more details
+See [kosli commit report evidence generic](/legacy_ref/v0.1.41/kosli_commit_report_evidence_generic/) for more details
 {{< /tab >}}
 
 {{< /tabs >}}
diff --git a/docs.kosli.com/content/helm/_index.md b/docs.kosli.com/content/helm/_index.md
@@ -61,7 +61,7 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 | kosliApiToken.secretKey | string | `""` | the name of the key in the secret data which contains the kosli API token |
 | kosliApiToken.secretName | string | `""` | the name of the secret containing the kosli API token |
 | nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one |
-| podAnnotations | object | `{}` |  |
+| podAnnotations | object | `{}` | any custom annotations to be added to the cronjob |
 | reporterConfig.dryRun | bool | `false` | whether the dry run mode is enabled or not. In dry run mode, the reporter logs the reports to stdout and does not send them to kosli. |
 | reporterConfig.kosliEnvironmentName | string | `""` | the name of kosli environment that the k8s cluster/namespace correlates to |
 | reporterConfig.kosliOrg | string | `""` | the name of the kosli org |
@@ -74,5 +74,5 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter
 | serviceAccount.name | string | `""` | the name of the service account to use. If not set and create is true, a name is generated using the fullname template |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)