From 638b8a1d81632df4c27553044a2e43e3f7abe7c4 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Fri, 4 Oct 2024 13:38:03 -0400 Subject: [PATCH] [docsy] Promote Metadata section to top-level docs (#98) --- content/en/docs/faq.md | 2 +- content/en/docs/{overview => }/metadata.md | 10 ++++------ content/en/docs/{overview/_index.md => overview.md} | 4 ++-- content/en/docs/project/_index.md | 2 +- content/en/docs/project/history.md | 3 +-- content/en/docs/security/_index.md | 6 +++--- content/en/resources/news.md | 5 ++--- 7 files changed, 14 insertions(+), 18 deletions(-) rename content/en/docs/{overview => }/metadata.md (97%) rename content/en/docs/{overview/_index.md => overview.md} (97%) diff --git a/content/en/docs/faq.md b/content/en/docs/faq.md index 6757961..3ba6925 100644 --- a/content/en/docs/faq.md +++ b/content/en/docs/faq.md @@ -1,7 +1,7 @@ --- title: Frequently Asked Questions LinkTitle: FAQ -weight: 450 +weight: 800 description: Get your questions answered! aliases: [/faq] --- diff --git a/content/en/docs/overview/metadata.md b/content/en/docs/metadata.md similarity index 97% rename from content/en/docs/overview/metadata.md rename to content/en/docs/metadata.md index 1fb2072..c11efcf 100644 --- a/content/en/docs/overview/metadata.md +++ b/content/en/docs/metadata.md @@ -1,9 +1,7 @@ --- -title: Roles and Metadata -LinkTitle: Metadata -weight: 15 -description: Understand Roles and Metadata +title: Roles and metadata aliases: [/metadata] +weight: 300 --- 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. A delegated role file is located at: -/DELEGATED_ROLE.json +`/DELEGATED_ROLE.json` where DELEGATED_ROLE is the name of the role specified in targets.json. If this role further delegates trust to a role named ANOTHER_ROLE, that role's signed metadata file would be found at: -/ANOTHER_ROLE.json +`/ANOTHER_ROLE.json` See [example](https://raw.githubusercontent.com/theupdateframework/tuf/develop/tests/repository_data/repository/metadata/role1.json) diff --git a/content/en/docs/overview/_index.md b/content/en/docs/overview.md similarity index 97% rename from content/en/docs/overview/_index.md rename to content/en/docs/overview.md index d57a761..cb04fb1 100644 --- a/content/en/docs/overview/_index.md +++ b/content/en/docs/overview.md @@ -96,5 +96,5 @@ Your software update system never has to deal with this additional metadata or understand what's going on underneath. TUF identifies the updates, downloads them, and checks them against the metadata that it also downloads from the repository. If the downloaded target files are trustworthy, TUF hands them over -to your software update system. See [metadata](docs/overview/metadata) for more -information and examples. +to your software update system. For more information and examples, see +[Roles and metadata](docs/metadata/) diff --git a/content/en/docs/project/_index.md b/content/en/docs/project/_index.md index 7a1b3f0..4636c40 100644 --- a/content/en/docs/project/_index.md +++ b/content/en/docs/project/_index.md @@ -1,7 +1,7 @@ --- title: Project aliases: [/project] -weight: 400 +weight: 600 --- The TUF project consists of three components: diff --git a/content/en/docs/project/history.md b/content/en/docs/project/history.md index 571d507..ac3ba79 100644 --- a/content/en/docs/project/history.md +++ b/content/en/docs/project/history.md @@ -35,5 +35,4 @@ four core principles continue to be central to its design. reduces the risk that they can be stolen or compromised. In 2016, the TUF research group set up a process whereby the community could -[paper]: - https://theupdateframework.github.io/papers/survivable-key-compromise-ccs2010.pdf?raw=true +[paper]: /papers/survivable-key-compromise-ccs2010.pdf diff --git a/content/en/docs/security/_index.md b/content/en/docs/security/_index.md index 978fc5f..b7ce96f 100644 --- a/content/en/docs/security/_index.md +++ b/content/en/docs/security/_index.md @@ -1,6 +1,6 @@ --- title: Security -weight: 300 +weight: 400 description: Security properties of TUF repositories aliases: [/security] --- @@ -76,8 +76,8 @@ system. To ensure systems are secure against all of the above attacks, the design and implementation of TUF relies on a few basic concepts. For details of how TUF -conveys the information discussed below, see the -[Metadata documentation](docs/overview/metadata). +conveys the information discussed below, see +[Roles and metadata](docs/metadata/). ### Trust diff --git a/content/en/resources/news.md b/content/en/resources/news.md index 8a3a553..1cac81d 100644 --- a/content/en/resources/news.md +++ b/content/en/resources/news.md @@ -1,6 +1,5 @@ --- title: News -description: TUF news coverage aliases: [/news, /press] --- @@ -110,8 +109,8 @@ projects to be adopted by CNCF. Lukas Pühringer presented the talk "Rough Times? TUF Shines" at [DebConf17](https://debconf17.debconf.org/talks/153/), an "annual conference for -Debian contributors, and users interested in improving Debian." -The conference took place in Montreal, Canada, August 6-12, 2017. +Debian contributors, and users interested in improving Debian." The conference +took place in Montreal, Canada, August 6-12, 2017. **July 3, 2017**