Skip to content

Commit 149b590

Browse files
authored
nonspec: New navigation (#1275)
Here is my first take on the new navigation approach. This PR doesn't make any changes to how the specification is organized with regard to the tracks, etc. It is meant to be merely a UI modification, essentially changing the navigation bar so that the various versions of the specification are directly visible and accessible rather than dependent on using the version selector which only appears once you go into the specification. I didn't include the older versions: 0.1 and 1.0-rc1 and rc2. All of these are however still there and can be accessed directly via their respective URLs or from any page linking to them such as past blog posts. Let me know if you think we should add 0.1 to the navigation bar. I'm also not sure there is value in having the 1.1 RC given that I think it's a dead-end (if anything I think this should be 1.0.1). In the process of making this change I found a few bugs that I was able to fix. Any feedback or suggestions welcome but please keep in mind that Jekyll is a **static** page generator so anything that requires dynamic processing (either server-side or client-side) is out of scope. These would require PHP and/or Javascript. I've more or less managed to get my head around Jekyll and its template programming language Liquid but I'm not up for the added complexity any of this would imply. PR #1268 will have a small impact that I'll handle once it is merged. --------- Signed-off-by: Arnaud J Le Hors <lehors@us.ibm.com>
1 parent 8941620 commit 149b590

33 files changed

+1636
-65
lines changed

docs/_data/nav/draft.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Pages that show in the nav aside and in the spec index page.
22
# The spec index does not show top-level elements without children.
33

4-
- title: Overview
5-
url: /spec/draft/
4+
- title: Home
5+
url: /
66

77
- title: Current activities
88
url: /current-activities
99
description: What the SLSA community is currently working on
1010

11+
- title: SLSA Working Draft
12+
url: /spec/draft/
13+
1114
- title: Understanding SLSA
1215
description: >
1316
These pages provide an overview of SLSA, how it helps protect against common
@@ -94,7 +97,7 @@
9497
children:
9598

9699
- title: General model
97-
url: /attestation-model
100+
url: /spec/draft/attestation-model
98101
description: General attestation mode
99102

100103
- title: Provenance

docs/_data/nav/main.yml

Lines changed: 344 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,344 @@
1+
# Global side menu
2+
# Children are only visible when the item or one of its children is selected
3+
4+
- title: Home
5+
url: /
6+
7+
- title: Current activities
8+
url: /current-activities
9+
description: What the SLSA community is currently working on
10+
11+
- title: SLSA Specification 1.1 Draft
12+
description: >
13+
These pages describe SLSA's security levels and requirements for each track.
14+
If you want to achieve SLSA a particular level, these are the requirements
15+
you'll need to meet.
16+
url: /spec/v1.1/
17+
children:
18+
19+
- title: Understanding SLSA
20+
description: >
21+
These pages provide an overview of SLSA, how it helps protect against common
22+
supply chain attacks, and common use cases. If you're new to SLSA or
23+
supply chain security, start here.
24+
children:
25+
26+
- title: What's new in v1.1
27+
url: /spec/v1.1/whats-new
28+
description: What's new in SLSA Version 1.1
29+
30+
- title: About SLSA
31+
url: /spec/v1.1/about
32+
description: An introductory guide to SLSA
33+
34+
- title: Supply chain threats
35+
url: /spec/v1.1/threats-overview
36+
description: An introduction to supply chain threats
37+
38+
- title: Use cases
39+
url: /spec/v1.1/use-cases
40+
description: Use cases
41+
42+
- title: Guiding principles
43+
url: /spec/v1.1/principles
44+
description: Use cases
45+
46+
- title: FAQ
47+
url: /spec/v1.1/faq
48+
description: Questions and more information
49+
50+
- title: Future directions
51+
url: /spec/v1.1/future-directions
52+
description: Additions and changes being considered for future SLSA versions
53+
54+
- title: Core specification
55+
description: >
56+
These pages describe SLSA's security levels and requirements for each track.
57+
If you want to achieve SLSA a particular level, these are the requirements
58+
you'll need to meet.
59+
children:
60+
61+
- title: Terminology
62+
url: /spec/v1.1/terminology
63+
description: Terminology and model used by SLSA
64+
65+
- title: Security levels
66+
url: /spec/v1.1/levels
67+
description: Overview of SLSA's tracks and levels, intended for all audiences
68+
69+
- title: Producing artifacts
70+
url: /spec/v1.1/requirements
71+
description: Detailed technical requirements for producing software artifacts, intended for platform implementers
72+
73+
- title: Distributing provenance
74+
url: /spec/v1.1/distributing-provenance
75+
description: Detailed technical requirements for distributing provenance, intended for platform implementers and software distributors
76+
77+
- title: Verifying artifacts
78+
url: /spec/v1.1/verifying-artifacts
79+
description: Guidance for verifying software artifacts and their SLSA provenance, intended for platform implementers and software consumers
80+
81+
- title: Verifying build platforms
82+
url: /spec/v1.1/verifying-systems
83+
description: Guidelines for securing SLSA Build L3+ builders, intended for platform implementers
84+
85+
- title: Threats & mitigations
86+
url: /spec/v1.1/threats
87+
description: Detailed information about specific supply chain attacks and how SLSA helps
88+
89+
- title: Attestation formats
90+
description: >
91+
These pages include the concrete schemas for SLSA attestations. The
92+
Provenance and VSA formats are recommended, but not required by the
93+
specification.
94+
children:
95+
96+
- title: General model
97+
url: /spec/v1.1/attestation-model
98+
description: General attestation mode
99+
100+
- title: Provenance
101+
url: /spec/v1.1/provenance
102+
description: Suggested provenance format and explanation
103+
104+
- title: Verification Summary
105+
url: /spec/v1.1/verification_summary
106+
description: Suggested VSA format and explanation
107+
108+
- title: Single-page view
109+
url: /spec/v1.1/onepage
110+
skip_next_prev: true # don't show as a next/prev link
111+
112+
- title: SLSA Specification 1.0
113+
description: >
114+
These pages describe SLSA's security levels and requirements for each track.
115+
If you want to achieve SLSA a particular level, these are the requirements
116+
you'll need to meet.
117+
url: /spec/v1.0/
118+
children:
119+
120+
- title: Understanding SLSA
121+
description: >
122+
These pages provide an overview of SLSA, how it helps protect against common
123+
supply chain attacks, and common use cases. If you're new to SLSA or
124+
supply chain security, start here.
125+
children:
126+
127+
- title: What's new in v1.0
128+
url: /spec/v1.0/whats-new
129+
description: What's new in SLSA Version 1.0
130+
131+
- title: About SLSA
132+
url: /spec/v1.0/about
133+
description: An introductory guide to SLSA
134+
135+
- title: Supply chain threats
136+
url: /spec/v1.0/threats-overview
137+
description: An introduction to supply chain threats
138+
139+
- title: Use cases
140+
url: /spec/v1.0/use-cases
141+
description: Use cases
142+
143+
- title: Guiding principles
144+
url: /spec/v1.0/principles
145+
description: Use cases
146+
147+
- title: FAQ
148+
url: /spec/v1.0/faq
149+
description: Questions and more information
150+
151+
- title: Future directions
152+
url: /spec/v1.0/future-directions
153+
description: Additions and changes being considered for future SLSA versions
154+
155+
- title: Core specification
156+
description: >
157+
These pages describe SLSA's security levels and requirements for each track.
158+
If you want to achieve SLSA a particular level, these are the requirements
159+
you'll need to meet.
160+
children:
161+
162+
- title: Terminology
163+
url: /spec/v1.0/terminology
164+
description: Terminology and model used by SLSA
165+
166+
- title: Security levels
167+
url: /spec/v1.0/levels
168+
description: Overview of SLSA's tracks and levels, intended for all audiences
169+
170+
- title: Producing artifacts
171+
url: /spec/v1.0/requirements
172+
description: Detailed technical requirements for producing software artifacts, intended for platform implementers
173+
174+
- title: Distributing provenance
175+
url: /spec/v1.0/distributing-provenance
176+
description: Detailed technical requirements for distributing provenance, intended for platform implementers and software distributors
177+
178+
- title: Verifying artifacts
179+
url: /spec/v1.0/verifying-artifacts
180+
description: Guidance for verifying software artifacts and their SLSA provenance, intended for platform implementers and software consumers
181+
182+
- title: Verifying build platforms
183+
url: /spec/v1.0/verifying-systems
184+
description: Guidelines for securing SLSA Build L3+ builders, intended for platform implementers
185+
186+
- title: Threats & mitigations
187+
url: /spec/v1.0/threats
188+
description: Detailed information about specific supply chain attacks and how SLSA helps
189+
190+
- title: Attestation formats
191+
description: >
192+
These pages include the concrete schemas for SLSA attestations. The
193+
Provenance and VSA formats are recommended, but not required by the
194+
specification.
195+
children:
196+
197+
- title: General model
198+
url: /spec/v1.0/attestation-model
199+
description: General attestation mode
200+
201+
- title: Provenance
202+
url: /spec/v1.0/provenance
203+
description: Suggested provenance format and explanation
204+
205+
- title: Verification Summary
206+
url: /spec/v1.0/verification_summary
207+
description: Suggested VSA format and explanation
208+
209+
- title: Single-page view
210+
url: /spec/v1.0/onepage
211+
skip_next_prev: true # don't show as a next/prev link
212+
213+
- title: SLSA Working Draft
214+
url: /spec/draft/
215+
children:
216+
217+
- title: Understanding SLSA
218+
description: >
219+
These pages provide an overview of SLSA, how it helps protect against common
220+
supply chain attacks, and common use cases. If you're new to SLSA or
221+
supply chain security, start here.
222+
children:
223+
224+
- title: What's new
225+
url: /spec/draft/whats-new
226+
description: The changes brought by this Working Draft.
227+
228+
- title: About SLSA
229+
url: /spec/draft/about
230+
description: An introductory guide to SLSA
231+
232+
- title: Supply chain threats
233+
url: /spec/draft/threats-overview
234+
description: An introduction to supply chain threats
235+
236+
- title: Use cases
237+
url: /spec/draft/use-cases
238+
description: Use cases
239+
240+
- title: Guiding principles
241+
url: /spec/draft/principles
242+
description: Use cases
243+
244+
- title: FAQ
245+
url: /spec/draft/faq
246+
description: Questions and more information
247+
248+
- title: Future directions
249+
url: /spec/draft/future-directions
250+
description: Additions and changes being considered for future SLSA versions
251+
252+
- title: Core specification
253+
description: >
254+
These pages describe SLSA's security levels and requirements for each track.
255+
If you want to achieve SLSA a particular level, these are the requirements
256+
you'll need to meet.
257+
children:
258+
259+
- title: Terminology
260+
url: /spec/draft/terminology
261+
description: Terminology and model used by SLSA
262+
263+
- title: Security levels
264+
url: /spec/draft/levels
265+
description: Overview of SLSA's tracks and levels, intended for all audiences
266+
267+
- title: Producing artifacts
268+
url: /spec/draft/requirements
269+
description: Detailed technical requirements for producing software artifacts, intended for platform implementers
270+
271+
- title: Distributing provenance
272+
url: /spec/draft/distributing-provenance
273+
description: Detailed technical requirements for distributing provenance, intended for platform implementers and software distributors
274+
275+
- title: Verifying artifacts
276+
url: /spec/draft/verifying-artifacts
277+
description: Guidance for verifying software artifacts and their SLSA provenance, intended for platform implementers and software consumers
278+
279+
- title: Verifying build platforms
280+
url: /spec/draft/verifying-systems
281+
description: Guidelines for securing SLSA Build L3+ builders, intended for platform implementers
282+
283+
- title: Integrity levels for attested build environments
284+
url: /spec/draft/attested-build-env-levels
285+
description: Overview of SLSA's Attested Build Environment track, intended for all audiences
286+
287+
- title: Threats & mitigations
288+
url: /spec/draft/threats
289+
description: Detailed information about specific supply chain attacks and how SLSA helps
290+
291+
- title: Securing Source Code
292+
url: /spec/draft/source-requirements
293+
description: Overview of the Source track
294+
295+
- title: Attestation formats
296+
description: >
297+
These pages include the concrete schemas for SLSA attestations. The
298+
Provenance and VSA formats are recommended, but not required by the
299+
specification.
300+
children:
301+
302+
- title: General model
303+
url: /spec/draft/attestation-model
304+
description: General attestation mode
305+
306+
- title: Provenance
307+
url: /spec/draft/provenance
308+
description: Suggested provenance format and explanation
309+
310+
- title: Verification Summary
311+
url: /spec/draft/verification_summary
312+
description: Suggested VSA format and explanation
313+
314+
- title: Single-page view
315+
url: /spec/draft/onepage
316+
skip_next_prev: true # don't show as a next/prev link
317+
318+
- title: How to SLSA
319+
description: >
320+
These instructions tell you how to apply the core SLSA specification to use
321+
SLSA in your specific situation.
322+
url: /how-to/
323+
children:
324+
325+
- title: For developers
326+
url: /how-to/get-started
327+
description: How to apply SLSA requirements to your build
328+
329+
- title: For organizations
330+
url: /how-to/how-to-orgs
331+
description: How to apply SLSA to an organization
332+
333+
- title: For infrastructure providers
334+
url: /how-to/how-to-infra
335+
description: How to implement SLSA in source, build, and package platforms
336+
337+
- title: Specification stages
338+
url: /spec-stages
339+
340+
- title: Community
341+
url: /community
342+
343+
- title: Blog
344+
url: /blog

0 commit comments

Comments
 (0)