Skip to content

Commit 6ce62e7

Browse files
committed
adding <details> disclosure element
Signed-off-by: h4l0gen <[email protected]>
1 parent fa7b152 commit 6ce62e7

File tree

1 file changed

+31
-20
lines changed

1 file changed

+31
-20
lines changed

content/metadata.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Specifies the other top-level roles. When specifying these roles, the trusted
4040
keys for each are listed, along with the minimum number of those keys required
4141
to sign the role's metadata. We call this number the signature threshold.
4242

43-
See an **example**
44-
45-
```
43+
<details>
44+
<summary><strong>Example Root metadata</strong></summary>
45+
<pre><code>
4646
{
4747
"signatures": [
4848
{
@@ -150,7 +150,8 @@ See an **example**
150150
"version": 1
151151
}
152152
}
153-
```
153+
</code></pre>
154+
</details>
154155

155156
## Targets Metadata (targets.json)
156157

@@ -167,8 +168,9 @@ so in a way similar to how the Root role specifies the top-level roles: by givin
167168
the trusted keys and signature threshold for each role. Additionally, one or more
168169
[glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)) will be specified to indicate the target file paths for which clients should trust each delegated role.
169170

170-
See as an **example**
171-
```
171+
<details>
172+
<summary><strong>Example Targets metadata</strong></summary>
173+
<pre><code>
172174
{
173175
"signatures": [
174176
{
@@ -236,7 +238,8 @@ See as an **example**
236238
"version": 1
237239
}
238240
}
239-
```
241+
</code></pre>
242+
</details>
240243

241244
## Delegated Targets Metadata (role1.json)
242245

@@ -260,8 +263,9 @@ metadata file would be found at:
260263

261264
/ANOTHER_ROLE.json
262265

263-
See **example** of delegated Targets metadata
264-
```
266+
<details>
267+
<summary><strong>Example delegated Targets metadata</strong></summary>
268+
<pre><code>
265269
{
266270
"signatures": [
267271
{
@@ -317,10 +321,12 @@ See **example** of delegated Targets metadata
317321
"version": 1
318322
}
319323
}
320-
```
321-
322-
and **example** of a nested delegation
323-
```
324+
</code></pre>
325+
</details>
326+
and
327+
<details>
328+
<summary><strong>Example nested delegation</strong></summary>
329+
<pre><code>
324330
{
325331
"signatures": [
326332
{
@@ -338,7 +344,8 @@ and **example** of a nested delegation
338344
"version": 1
339345
}
340346
}
341-
```
347+
</code></pre>
348+
</details>
342349

343350
## Snapshot Metadata (snapshot.json)
344351

@@ -350,8 +357,9 @@ view of all files on the repository. That is, metadata files (and thus Target
350357
files) that existed on the repository at different times cannot be combined
351358
and presented to clients by an attacker.
352359

353-
​See **example** of Snapshot metadata.
354-
```
360+
<details>
361+
<summary><strong>Example Snapshot metadata</strong></summary>
362+
<pre><code>
355363
{
356364
"signatures": [
357365
{
@@ -379,7 +387,8 @@ and presented to clients by an attacker.
379387
"version": 1
380388
}
381389
}
382-
```
390+
</code></pre>
391+
</details>
383392

384393
## Timestamp Metadata (timestamp.json)
385394

@@ -403,8 +412,9 @@ keys should be used for signing the snapshot.json file so that the
403412
Snapshot role's keys can be kept offline, and thus more secure.
404413
* Timestamp.json may be given to mirrors.
405414

406-
See **example** of Timestamp metadata.
407-
```
415+
<details>
416+
<summary><strong>Example Timestamp metadata</strong></summary>
417+
<pre><code>
408418
{
409419
"signatures": [
410420
{
@@ -430,4 +440,5 @@ See **example** of Timestamp metadata.
430440
"version": 1
431441
}
432442
}
433-
```
443+
</code></pre>
444+
</details>

0 commit comments

Comments
 (0)