Skip to content

Commit 8e4b378

Browse files
committed
📚 Sync docs from alaudadevops/tektoncd-operator on e251124341e4aa7ae4464c538ef3f8f3f87d1cf8
Source: fix: known doom lint issues (#1551) Author: JounQin Ref: refs/heads/release-4.8 Commit: e251124341e4aa7ae4464c538ef3f8f3f87d1cf8 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/tektoncd-operator@e251124 🤖 Synced on 2026-04-03 07:11:36 UTC
1 parent 6e2ed20 commit 8e4b378

49 files changed

Lines changed: 2925 additions & 3617 deletions

Some content is hidden

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

‎.github/SYNC_INFO.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2026-04-03 01:45:50 UTC
3+
- **Last synced**: 2026-04-03 07:11:36 UTC
44
- **Source repository**: alaudadevops/tektoncd-operator
5-
- **Source commit**: [30806f63ba2a1b166f84307d049ff51a6b1fe3c3](https://github.com/alaudadevops/tektoncd-operator/commit/30806f63ba2a1b166f84307d049ff51a6b1fe3c3)
5+
- **Source commit**: [e251124341e4aa7ae4464c538ef3f8f3f87d1cf8](https://github.com/alaudadevops/tektoncd-operator/commit/e251124341e4aa7ae4464c538ef3f8f3f87d1cf8)
66
- **Triggered by**: l-qing
7-
- **Workflow run**: [#176](https://github.com/alaudadevops/tektoncd-operator/actions/runs/23930121635)
7+
- **Workflow run**: [#183](https://github.com/alaudadevops/tektoncd-operator/actions/runs/23937735575)
88

99
## Files synced:
1010
- docs/

‎.yarn/releases/yarn-4.10.3.cjs‎

Lines changed: 0 additions & 942 deletions
This file was deleted.

‎.yarn/releases/yarn-4.13.0.cjs‎

Lines changed: 940 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/en/chains/concepts/core_concepts.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Image attestation is used for storing and verifying metadata information related
4444
- [SLSA Provenance](#slsa-provenance)
4545
- [SBOM](#sbom-software-bill-of-materials)
4646
- [Vulnerability scan results](#vulnerability-scan-results)
47-
- [Custom metadata](#custom-metadata-attestation)
47+
- [Custom metadata](#custom-metadata)
4848

49-
### SLSA Provenance
49+
### SLSA Provenance \{#slsa-provenance}
5050

5151
[SLSA Provenance](https://slsa.dev/provenance/v1) is metadata containing verifiable information about software artifacts, describing how they were built, what sources were used, and who built them. In Tekton Chains, provenance is cryptographically signed to ensure its integrity and authenticity.
5252

@@ -55,7 +55,7 @@ There are two types of provenance in Tekton Chains:
5555
- **Task-level provenance**: Captures details about a specific TaskRun execution
5656
- **Pipeline-level provenance**: Captures the entire PipelineRun execution, including all child TaskRuns
5757

58-
### SBOM (Software bill of materials)
58+
### SBOM (Software bill of materials) \{#sbom-software-bill-of-materials}
5959

6060
[SBOM](https://www.ntia.gov/page/software-bill-materials) is a nested inventory for software, a list of ingredients that make up software components, including:
6161
- Software components
@@ -67,15 +67,15 @@ SBOM can be in various formats, such as:
6767
- [SPDX](https://spdx.dev/use/specifications/)
6868
- [CycloneDX](https://cyclonedx.org/specification/overview/)
6969

70-
### Vulnerability scan results
70+
### Vulnerability scan results \{#vulnerability-scan-results}
7171

7272
[Cosign Vulnerability Scan results](https://github.com/sigstore/cosign/blob/main/specs/COSIGN_VULN_ATTESTATION_SPEC.md) record the security assessment of the software build process, including:
7373
- Scanner information (name, version)
7474
- Vulnerability database information
7575
- List of discovered vulnerabilities and their severity
7676
- Remediation recommendations
7777

78-
### Custom metadata
78+
### Custom metadata \{#custom-metadata}
7979

8080
Custom metadata can be added as needed to support specific security requirements.
8181

‎docs/en/chains/concepts/understanding_tekton_chains.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ data:
157157
artifacts.oci.signer: "x509"
158158
```
159159
160-
### Type Hinting
160+
### Type Hinting \{#type-hinting}
161161
162162
:::tip
163163
More details about type hinting can be found in the [Tekton Chains Type Hinting](https://tekton.dev/docs/chains/slsa-provenance/#type-hinting) documentation.

‎docs/en/chains/configure/authentication_for_chains.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Authentication must be set up to take advantage of the following features in Cha
1616
* Pushing signatures to an OCI registry after signing an image
1717
* Using Fulcio to get Signing Certificates when utilizing Keyless signing
1818

19-
## OCI Registry Authentication
19+
## OCI Registry Authentication \{#oci-registry-authentication}
2020

2121
To push to an OCI registry, the Chains controller will look for credentials in two places:
2222

@@ -94,7 +94,7 @@ spec:
9494
- name: registry-credentials
9595
```
9696
97-
#### Using ServiceAccount
97+
#### Using ServiceAccount \{#using-serviceaccount}
9898
9999
Give the service account access to the secret:
100100

‎docs/en/chains/configure/signing_key_configuration.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ metadata:
4747
type: Opaque
4848
```
4949

50-
### Get the Signing Public Key
50+
### Get the Signing Public Key \{#get-the-signing-public-key}
5151

5252
:::tip
5353
If you don't have permission, you can ask the administrator to get the public key.
@@ -58,7 +58,7 @@ $ export NAMESPACE=<tekton-pipelines>
5858
$ kubectl get secret -n $NAMESPACE signing-secrets -o jsonpath='{.data.cosign\.pub}' | base64 -d > cosign.pub
5959
```
6060

61-
### Get the Signing Secret
61+
### Get the Signing Secret \{#get-the-signing-secret}
6262

6363
```shell
6464
$ export NAMESPACE=<tekton-pipelines>
@@ -86,4 +86,3 @@ tekton-chains-controller-55876dfbbd-5wv5z 1/1 Running 0 1m30s
8686

8787
- [Tekton Chains Authentication](https://tekton.dev/docs/chains/authentication/)
8888
- [Tekton Chains Configuration](https://tekton.dev/docs/chains/config/)
89-

‎docs/en/chains/how_to/image_signature_verification.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ These steps are identical to the [Quick Start: Signed Provenance](../quick_start
7676
At [Step 8: Verifying the Image and Attestation](../quick_start/signed_provenance.mdx#step-8-verifying-the-image-and-attestation), we use `cosign` CLI to verify the signature.
7777
Here we use Kyverno to verify the signature.
7878

79-
#### Step 8.1: Create a Kyverno policy to allow only signed images to be deployed
79+
#### Step 8.1: Create a Kyverno policy to allow only signed images to be deployed \{#step-81-create-a-kyverno-policy-to-allow-only-signed-images-to-be-deployed}
8080

8181
:::tip
8282
This step requires cluster administrator privileges.

‎docs/en/chains/how_to/sbom_verification.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ spec:
265265
- The same as in [Step 5: Run a Sample Pipeline](../quick_start/signed_provenance.mdx#step-5-run-a-sample-pipeline). Below only introduces the differences.
266266
- `workspaces`
267267
- `signkey`: the secret name of the signing key.
268-
- `secret.secretName`: The signing secret prepared in the previous step [Get the signing secret](#get-the-signing-secret). But you need to create a new secret with the same namespace as the pipeline run.
268+
- `secret.secretName`: The signing secret prepared in the previous step [Get the signing secret](../configure/signing_key_configuration.mdx#get-the-signing-secret). But you need to create a new secret with the same namespace as the pipeline run.
269269
:::
270270

271271
Save into a yaml file named `chains-demo-5.pipelinerun.yaml` and apply it with:
@@ -585,4 +585,4 @@ This guide provides a foundation for implementing supply chain security in your
585585
## References
586586
587587
- [Chains Signed Provenance Tutorial](https://tekton.dev/docs/chains/signed-provenance-tutorial/)
588-
- [Chains Configuration](../configure/chains_configuration)
588+
- [Chains Configuration](../configure/chains_configuration)

‎docs/en/chains/how_to/vulnerability_scanning_verification.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ spec:
303303
- The same as in [Step 5: Run a Sample Pipeline](../quick_start/signed_provenance.mdx#step-5-run-a-sample-pipeline). Below only introduces the differences.
304304
- `workspaces`
305305
- `signkey`: the secret name of the signing key.
306-
- `secret.secretName`: The signing secret prepared in the previous step [Get the signing secret](#get-the-signing-secret). But you need to create a new secret with the same namespace as the pipeline run.
306+
- `secret.secretName`: The signing secret prepared in the previous step [Get the signing secret](../configure/signing_key_configuration.mdx#get-the-signing-secret). But you need to create a new secret with the same namespace as the pipeline run.
307307
:::
308308

309309
Save into a yaml file named `chains-demo-4.pipelinerun.yaml` and apply it with:
@@ -725,4 +725,4 @@ This guide provides a foundation for implementing supply chain security in your
725725
## References
726726

727727
- [Chains Signed Provenance Tutorial](https://tekton.dev/docs/chains/signed-provenance-tutorial/)
728-
- [Chains Configuration](../configure/chains_configuration)
728+
- [Chains Configuration](../configure/chains_configuration)

0 commit comments

Comments
 (0)