Skip to content

Commit b179618

Browse files
committed
docs: fix slsa definition markup issues
Headings containing a link causes rendering issues in the `docker/docs` downstream. Moving the link into each section fixes the issue. Signed-off-by: David Karlsson <[email protected]>
1 parent 9da03ce commit b179618

File tree

1 file changed

+36
-12
lines changed

1 file changed

+36
-12
lines changed

docs/attestations/slsa-definitions.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ The provenance format generated by BuildKit is defined by the
99
This page describes how BuildKit populate each field, and whether the field gets
1010
included when you generate attestations `mode=min` and `mode=max`.
1111

12-
## `builder.id` [(SLSA)](https://slsa.dev/provenance/v0.2#builder.id)
12+
## `builder.id`
13+
14+
Corresponds to [SLSA `builder.id`](https://slsa.dev/provenance/v0.2#builder.id).
1315

1416
Included with `mode=min` and `mode=max`.
1517

@@ -23,7 +25,9 @@ The `builder.id` field is set to the URL of the build, if available.
2325

2426
This value can be set using the `builder-id` attestation parameter.
2527

26-
## `buildType` [(SLSA)](https://slsa.dev/provenance/v0.2#buildType)
28+
## `buildType`
29+
30+
Corresponds to [SLSA `buildType`](https://slsa.dev/provenance/v0.2#buildType).
2731

2832
Included with `mode=min` and `mode=max`.
2933

@@ -34,7 +38,9 @@ used to determine the structure of the provenance content.
3438
"buildType": "https://mobyproject.org/buildkit@v1",
3539
```
3640

37-
## `invocation.configSource` [(SLSA)](https://slsa.dev/provenance/v0.2#invocation.configSource)
41+
## `invocation.configSource`
42+
43+
Corresponds to [SLSA `invocation.configSource`](https://slsa.dev/provenance/v0.2#invocation.configSource).
3844

3945
Included with `mode=min` and `mode=max`.
4046

@@ -58,7 +64,9 @@ object defines the context URL and its immutable digest in the `uri` and `digest
5864
For builds using a local frontend, such as a Dockerfile, the `entryPoint` field defines the path
5965
for the frontend file that initialized the build (`filename` frontend option).
6066

61-
## `invocation.parameters` [(SLSA)](https://slsa.dev/provenance/v0.2#invocation.parameters)
67+
## `invocation.parameters`
68+
69+
Corresponds to [SLSA `invocation.parameters`](https://slsa.dev/provenance/v0.2#invocation.parameters).
6270

6371
Partially included with `mode=min`.
6472

@@ -108,7 +116,9 @@ The following fields are only included with `mode=max`:
108116
values are not included.
109117
- `ssh` defines the ssh forwards used during the build.
110118

111-
## `invocation.environment` [(SLSA)](https://slsa.dev/provenance/v0.2#invocation.environment)
119+
## `invocation.environment`
120+
121+
Corresponds to [SLSA `invocation.environment`](https://slsa.dev/provenance/v0.2#invocation.environment).
112122

113123
Included with `mode=min` and `mode=max`.
114124

@@ -125,7 +135,9 @@ The only value BuildKit currently sets is the `platform` of the current build
125135
machine. Note that this is not necessarily the platform of the build result that
126136
can be determined from the `in-toto` subject field.
127137

128-
## `materials` [(SLSA)](https://slsa.dev/provenance/v0.2#materials)
138+
## `materials`
139+
140+
Corresponds to [SLSA `materials`](https://slsa.dev/provenance/v0.2#materials).
129141

130142
Included with `mode=min` and `mode=max`.
131143

@@ -162,7 +174,9 @@ determine if the artifact has been updated compared to when the build ran.
162174
],
163175
```
164176

165-
## `buildConfig` [(SLSA)](https://slsa.dev/provenance/v0.2#buildConfig)
177+
## `buildConfig`
178+
179+
Corresponds to [SLSA `buildConfig`](https://slsa.dev/provenance/v0.2#buildConfig).
166180

167181
Only included with `mode=max`.
168182

@@ -212,7 +226,9 @@ field for every step.
212226
},
213227
```
214228

215-
## `metadata.buildInvocationId` [(SLSA)](https://slsa.dev/provenance/v0.2#metadata.buildIncocationId)
229+
## `metadata.buildInvocationId`
230+
231+
Corresponds to [SLSA `metadata.buildInvocationId`](https://slsa.dev/provenance/v0.2#metadata.buildIncocationId).
216232

217233
Included with `mode=min` and `mode=max`.
218234

@@ -227,7 +243,9 @@ versions of the image.
227243
},
228244
```
229245

230-
## `metadata.buildStartedOn` [(SLSA)](https://slsa.dev/provenance/v0.2#metadata.buildStartedOn)
246+
## `metadata.buildStartedOn`
247+
248+
Corresponds to [SLSA `metadata.buildStartedOn`](https://slsa.dev/provenance/v0.2#metadata.buildStartedOn).
231249

232250
Included with `mode=min` and `mode=max`.
233251

@@ -240,7 +258,9 @@ Timestamp when the build started.
240258
},
241259
```
242260

243-
## `metadata.buildFinishedOn` [(SLSA)](https://slsa.dev/provenance/v0.2#metadata.buildFinishedOn)
261+
## `metadata.buildFinishedOn`
262+
263+
Corresponds to [SLSA `metadata.buildFinishedOn`](https://slsa.dev/provenance/v0.2#metadata.buildFinishedOn).
244264

245265
Included with `mode=min` and `mode=max`.
246266

@@ -253,7 +273,9 @@ Timestamp when the build finished.
253273
},
254274
```
255275

256-
## `metadata.completeness` [(SLSA)](https://slsa.dev/provenance/v0.2#metadata.completeness)
276+
## `metadata.completeness`
277+
278+
Corresponds to [SLSA `metadata.completeness`](https://slsa.dev/provenance/v0.2#metadata.completeness).
257279

258280
Included with `mode=min` and `mode=max`.
259281

@@ -284,7 +306,9 @@ is true.
284306
},
285307
```
286308

287-
## `metadata.reproducible` [(SLSA)](https://slsa.dev/provenance/v0.2#metadata.reproducible)
309+
## `metadata.reproducible`
310+
311+
Corresponds to [SLSA `metadata.reproducible`](https://slsa.dev/provenance/v0.2#metadata.reproducible).
288312

289313
Defines if the build result is supposed to be byte-by-byte reproducible. This
290314
value can be set by the user with the `reproducible=true` attestation parameter.

0 commit comments

Comments
 (0)