From ec986020acf7cc7a878183bb29871231acd2e11a Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 16 Oct 2024 17:38:54 +0200 Subject: [PATCH] docs: add front matter title to attestation docs When republish these on docs.docker.com, having the title in front matter means we can access it programmatically in templates. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/attestations/attestation-storage.md | 4 +++- docs/attestations/sbom-protocol.md | 4 +++- docs/attestations/sbom.md | 4 +++- docs/attestations/slsa-definitions.md | 4 +++- docs/attestations/slsa-provenance.md | 4 +++- 5 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/attestations/attestation-storage.md b/docs/attestations/attestation-storage.md index 18095d05e13a..a42fab303a5e 100644 --- a/docs/attestations/attestation-storage.md +++ b/docs/attestations/attestation-storage.md @@ -1,4 +1,6 @@ -# Image Attestation Storage +--- +title: Image attestation storage +--- Buildkit supports creating and attaching attestations to build artifacts. These attestations can provide valuable information from the build process, diff --git a/docs/attestations/sbom-protocol.md b/docs/attestations/sbom-protocol.md index e261fecfce08..5978871da9b9 100644 --- a/docs/attestations/sbom-protocol.md +++ b/docs/attestations/sbom-protocol.md @@ -1,4 +1,6 @@ -# SBOM Scanning Protocol +--- +title: SBOM scanning protocol +--- BuildKit supports automatic creation of [SBOMs](https://en.wikipedia.org/wiki/Software_supply_chain) for builds, attaching them as [image attestations](./attestation-storage.md). diff --git a/docs/attestations/sbom.md b/docs/attestations/sbom.md index 9cb008775a36..f129415a5466 100644 --- a/docs/attestations/sbom.md +++ b/docs/attestations/sbom.md @@ -1,4 +1,6 @@ -# SBOMs +--- +title: SBOMs +--- BuildKit supports automatic creation of [SBOMs](https://en.wikipedia.org/wiki/Software_supply_chain) to record the software components that make up the final image. These consist diff --git a/docs/attestations/slsa-definitions.md b/docs/attestations/slsa-definitions.md index 313d8114f440..08b692df3d3b 100644 --- a/docs/attestations/slsa-definitions.md +++ b/docs/attestations/slsa-definitions.md @@ -1,4 +1,6 @@ -# SLSA definitions +--- +title: SLSA definitions +--- BuildKit supports the [creation of SLSA Provenance](./slsa-provenance.md) for builds that it runs. diff --git a/docs/attestations/slsa-provenance.md b/docs/attestations/slsa-provenance.md index a1437e717027..bd77d32d4c4c 100644 --- a/docs/attestations/slsa-provenance.md +++ b/docs/attestations/slsa-provenance.md @@ -1,4 +1,6 @@ -# SLSA provenance +--- +title: SLSA provenance +--- BuildKit supports automatic creation of provenance attestations for the build process. Provenance attestations record information describing how a build was