Skip to content

Commit

Permalink
editorial: tweak presentation of VSA pages (#980)
Browse files Browse the repository at this point in the history
- Expand VSA --> Verification Summary in the left-hand nav menu. The VSA
acronym only makes sense to readers familiar with the VSA.
- Remove redundant "SLSA" prefix from VSA page titles
- Remove specification version from VSA page descriptions

Signed-off-by: Joshua Lock <joshuagloe@gmail.com>
  • Loading branch information
joshuagl authored Oct 20, 2023
1 parent f5d5e57 commit 105ecca
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/_data/nav/v0.1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
- title: Provenance
url: /spec/v0.1/provenance

- title: VSA
- title: Verification Summary
url: /spec/v0.1/verification_summary

- title: Stages
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/nav/v0.2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
- title: Provenance
url: /spec/v0.2/provenance

- title: VSA
- title: Verification Summary
url: /spec/v0.2/verification_summary

- title: Stages
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/nav/v1.0-rc1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
- title: Provenance
url: /spec/v1.0-rc1/provenance

- title: VSA
- title: Verification Summary
# There was no v1.0-rc VSA. This confuses the version selector.
url: /spec/v0.2/verification_summary

Expand Down
2 changes: 1 addition & 1 deletion docs/_data/nav/v1.0-rc2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
url: /spec/v1.0-rc2/provenance
description: Suggested provenance format and explanation

- title: VSA
- title: Verification Summary
url: /spec/v1.0-rc2/verification_summary
description: Suggested VSA format and explanation

Expand Down
2 changes: 1 addition & 1 deletion docs/_data/nav/v1.0.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
url: /spec/v1.0/provenance
description: Suggested provenance format and explanation

- title: VSA
- title: Verification Summary
url: /spec/v1.0/verification_summary
description: Suggested VSA format and explanation

Expand Down
2 changes: 1 addition & 1 deletion docs/_data/nav/v1.1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
url: /spec/v1.1/provenance
description: Suggested provenance format and explanation

- title: VSA
- title: Verification Summary
url: /spec/v1.1/verification_summary
description: Suggested VSA format and explanation

Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v0.1/verification_summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SLSA Verification Summary Attestation (VSA)
description: SLSA v0.1 specification for a verification summary of artifacts by a trusted verifier entity.
title: Verification Summary Attestation (VSA)
description: Specification for a verification summary of artifacts by a trusted verifier entity.
layout: standard
---

Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v0.2/verification_summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SLSA Verification Summary Attestation (VSA)
description: SLSA v0.2 specification for a verification summary of artifacts by a trusted verifier entity.
title: Verification Summary Attestation (VSA)
description: Specification for a verification summary of artifacts by a trusted verifier entity.
layout: standard
---

Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v1.0-rc2/verification_summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SLSA Verification Summary Attestation (VSA)
description: SLSA v1.0 RC2 specification for a verification summary of artifacts by a trusted verifier entity.
title: Verification Summary Attestation (VSA)
description: Specification for a verification summary of artifacts by a trusted verifier entity.
layout: standard
---

Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v1.0/verification_summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SLSA Verification Summary Attestation (VSA)
description: SLSA v1.0 specification for a verification summary of artifacts by a trusted verifier entity.
title: Verification Summary Attestation (VSA)
description: Specification for a verification summary of artifacts by a trusted verifier entity.
layout: standard
---

Expand Down
4 changes: 2 additions & 2 deletions docs/spec/v1.1/verification_summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: SLSA Verification Summary Attestation (VSA)
description: SLSA v1.0 specification for a verification summary of artifacts by a trusted verifier entity.
title: Verification Summary Attestation (VSA)
description: Specification for a verification summary of artifacts by a trusted verifier entity.
layout: standard
---

Expand Down

0 comments on commit 105ecca

Please sign in to comment.