Skip to content

Commit 638b8a1

Browse files
authored
[docsy] Promote Metadata section to top-level docs (#98)
1 parent 723e332 commit 638b8a1

File tree

7 files changed

+14
-18
lines changed

7 files changed

+14
-18
lines changed

content/en/docs/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Frequently Asked Questions
33
LinkTitle: FAQ
4-
weight: 450
4+
weight: 800
55
description: Get your questions answered!
66
aliases: [/faq]
77
---

content/en/docs/overview/metadata.md content/en/docs/metadata.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
2-
title: Roles and Metadata
3-
LinkTitle: Metadata
4-
weight: 15
5-
description: Understand Roles and Metadata
2+
title: Roles and metadata
63
aliases: [/metadata]
4+
weight: 300
75
---
86

97
TUF uses roles to define the set of actions a party can perform. The concept of
@@ -85,13 +83,13 @@ available from a given repository mirror.
8583

8684
A delegated role file is located at:
8785

88-
/DELEGATED_ROLE.json
86+
`/DELEGATED_ROLE.json`
8987

9088
where DELEGATED_ROLE is the name of the role specified in targets.json. If this
9189
role further delegates trust to a role named ANOTHER_ROLE, that role's signed
9290
metadata file would be found at:
9391

94-
/ANOTHER_ROLE.json
92+
`/ANOTHER_ROLE.json`
9593

9694
See
9795
[example](https://raw.githubusercontent.com/theupdateframework/tuf/develop/tests/repository_data/repository/metadata/role1.json)

content/en/docs/overview/_index.md content/en/docs/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,5 +96,5 @@ Your software update system never has to deal with this additional metadata or
9696
understand what's going on underneath. TUF identifies the updates, downloads
9797
them, and checks them against the metadata that it also downloads from the
9898
repository. If the downloaded target files are trustworthy, TUF hands them over
99-
to your software update system. See [metadata](docs/overview/metadata) for more
100-
information and examples.
99+
to your software update system. For more information and examples, see
100+
[Roles and metadata](docs/metadata/)

content/en/docs/project/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Project
33
aliases: [/project]
4-
weight: 400
4+
weight: 600
55
---
66

77
The TUF project consists of three components:

content/en/docs/project/history.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,4 @@ four core principles continue to be central to its design.
3535
reduces the risk that they can be stolen or compromised. In 2016, the TUF
3636
research group set up a process whereby the community could
3737

38-
[paper]:
39-
https://theupdateframework.github.io/papers/survivable-key-compromise-ccs2010.pdf?raw=true
38+
[paper]: /papers/survivable-key-compromise-ccs2010.pdf

content/en/docs/security/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Security
3-
weight: 300
3+
weight: 400
44
description: Security properties of TUF repositories
55
aliases: [/security]
66
---
@@ -76,8 +76,8 @@ system.
7676

7777
To ensure systems are secure against all of the above attacks, the design and
7878
implementation of TUF relies on a few basic concepts. For details of how TUF
79-
conveys the information discussed below, see the
80-
[Metadata documentation](docs/overview/metadata).
79+
conveys the information discussed below, see
80+
[Roles and metadata](docs/metadata/).
8181

8282
### Trust
8383

content/en/resources/news.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: News
3-
description: TUF news coverage
43
aliases: [/news, /press]
54
---
65

@@ -110,8 +109,8 @@ projects to be adopted by CNCF.
110109

111110
Lukas Pühringer presented the talk "Rough Times? TUF Shines" at
112111
[DebConf17](https://debconf17.debconf.org/talks/153/), an "annual conference for
113-
Debian contributors, and users interested in improving Debian."
114-
The conference took place in Montreal, Canada, August 6-12, 2017.
112+
Debian contributors, and users interested in improving Debian." The conference
113+
took place in Montreal, Canada, August 6-12, 2017.
115114

116115
**July 3, 2017**
117116

0 commit comments

Comments
 (0)