From 973184a071d9147e253c66a09054a65cb1c3277b Mon Sep 17 00:00:00 2001 From: sandra Date: Thu, 5 Sep 2024 11:48:23 +0300 Subject: [PATCH 1/6] Add alisases to web pages Signed-off-by: sandra --- content/en/community/_index.md | 1 + content/en/docs/faq.md | 1 + content/en/docs/get-started/_index.md | 2 +- content/en/docs/get-started/adopter.md | 2 +- content/en/docs/history.md | 1 + content/en/docs/overview/_index.md | 1 + content/en/docs/overview/metadata.md | 1 + content/en/docs/overview/project/tap.md | 1 + content/en/docs/overview/security.md | 1 + content/en/docs/timeline.md | 1 + content/en/resources/publications.md | 1 + content/en/resources/videos.md | 1 + content/en/specifications/specs.md | 1 + themes/docsy | 2 +- 14 files changed, 14 insertions(+), 3 deletions(-) diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 8dbef1a..41b19e7 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -1,6 +1,7 @@ --- title: Community menu: { main: { weight: 40 } } +aliases: [/adoptions] cascade: type: docs # If your project has a local or external contributing page, then diff --git a/content/en/docs/faq.md b/content/en/docs/faq.md index 4e675a0..ac3f635 100644 --- a/content/en/docs/faq.md +++ b/content/en/docs/faq.md @@ -3,6 +3,7 @@ title: Frequently Asked Questions LinkTitle: FAQ weight: 45 description: Get your questions answered! +aliases: [/faq] --- **1. How difficult is it to integrate TUF?** diff --git a/content/en/docs/get-started/_index.md b/content/en/docs/get-started/_index.md index 97ebb1a..4e316d7 100644 --- a/content/en/docs/get-started/_index.md +++ b/content/en/docs/get-started/_index.md @@ -1,8 +1,8 @@ --- title: Get started weight: 17 -# aliases: [/docs/getting-started/] description: Get started with TUF based on your role. +aliases: [/getting-started] --- Want to learn more about TUF? Select a role to get started: diff --git a/content/en/docs/get-started/adopter.md b/content/en/docs/get-started/adopter.md index ac61842..e7aeb87 100644 --- a/content/en/docs/get-started/adopter.md +++ b/content/en/docs/get-started/adopter.md @@ -1,6 +1,6 @@ --- title: Adopter -weight: 100 +weight: 15 description: Get started with TUF as an adopter. --- diff --git a/content/en/docs/history.md b/content/en/docs/history.md index 7aaf158..a45f965 100644 --- a/content/en/docs/history.md +++ b/content/en/docs/history.md @@ -2,6 +2,7 @@ title: History weight: 18 description: Learn TUF history and core principles +aliases: [/history] --- The basic technology behind TUF was developed at the University of Washington in diff --git a/content/en/docs/overview/_index.md b/content/en/docs/overview/_index.md index df06cda..c57c82f 100644 --- a/content/en/docs/overview/_index.md +++ b/content/en/docs/overview/_index.md @@ -2,6 +2,7 @@ title: Overview weight: 10 description: Find out what TUF is all about! +aliases: [/overview] --- ### Purpose, or Why Get TUF? diff --git a/content/en/docs/overview/metadata.md b/content/en/docs/overview/metadata.md index 384814c..1fb2072 100644 --- a/content/en/docs/overview/metadata.md +++ b/content/en/docs/overview/metadata.md @@ -3,6 +3,7 @@ title: Roles and Metadata LinkTitle: Metadata weight: 15 description: Understand Roles and Metadata +aliases: [/metadata] --- TUF uses roles to define the set of actions a party can perform. The concept of diff --git a/content/en/docs/overview/project/tap.md b/content/en/docs/overview/project/tap.md index 1a401c5..d6f2855 100644 --- a/content/en/docs/overview/project/tap.md +++ b/content/en/docs/overview/project/tap.md @@ -3,6 +3,7 @@ title: Enhancement Proposals LinkTitle: Tap weight: 16 description: Learn more about TUF Augmentation Proposals +aliases: [/taps] --- ### What is a TAP? diff --git a/content/en/docs/overview/security.md b/content/en/docs/overview/security.md index 47dd3f0..10b0d52 100644 --- a/content/en/docs/overview/security.md +++ b/content/en/docs/overview/security.md @@ -2,6 +2,7 @@ title: Security weight: 35 description: Security properties of TUF repositories +aliases: [/security] --- We can think of a software update system as "secure" if: diff --git a/content/en/docs/timeline.md b/content/en/docs/timeline.md index 84b3fd6..7ecfc7b 100644 --- a/content/en/docs/timeline.md +++ b/content/en/docs/timeline.md @@ -2,6 +2,7 @@ title: Timeline weight: 19 Description: See the project timeline +aliases: [/timeline] --- **2010**: Improving upon the Thandy software updater for the Tor private diff --git a/content/en/resources/publications.md b/content/en/resources/publications.md index 3121272..7d9424b 100644 --- a/content/en/resources/publications.md +++ b/content/en/resources/publications.md @@ -1,5 +1,6 @@ --- title: Publications +aliases: [/publications] --- The following papers provide detailed information on securing software updater diff --git a/content/en/resources/videos.md b/content/en/resources/videos.md index 18c4f72..74bfc83 100644 --- a/content/en/resources/videos.md +++ b/content/en/resources/videos.md @@ -2,6 +2,7 @@ title: Videos description: Sample videos of presentations given by project members and adopters. +aliases: [/videos] --- ## TUF-en Up Your Signatures diff --git a/content/en/specifications/specs.md b/content/en/specifications/specs.md index c76ade9..0d3ef43 100644 --- a/content/en/specifications/specs.md +++ b/content/en/specifications/specs.md @@ -1,6 +1,7 @@ --- title: Specification linkTitle: Spec +aliases: [/theupdateframework.github.io/specification/latest] menu: { main: { weight: 35 } } cascade: type: docs diff --git a/themes/docsy b/themes/docsy index 7951194..309da20 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit 7951194954708d7cc992e3540c8fc823cc99a953 +Subproject commit 309da207e5deeda762348bfd0cc32367c5565a1e From 4fe82d70c3c0faf3519bd2ae90043bc65ffd3cf0 Mon Sep 17 00:00:00 2001 From: sandra Date: Thu, 5 Sep 2024 23:30:29 +0300 Subject: [PATCH 2/6] Add aliases Signed-off-by: sandra --- content/en/community/_index.md | 2 +- content/en/community/adoptions/index.md | 1 + content/en/docs/overview/project/_index.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/community/_index.md b/content/en/community/_index.md index 41b19e7..b5ee6d2 100644 --- a/content/en/community/_index.md +++ b/content/en/community/_index.md @@ -1,7 +1,7 @@ --- title: Community menu: { main: { weight: 40 } } -aliases: [/adoptions] +aliases: [/community] cascade: type: docs # If your project has a local or external contributing page, then diff --git a/content/en/community/adoptions/index.md b/content/en/community/adoptions/index.md index 5eb92bb..9c6aec3 100644 --- a/content/en/community/adoptions/index.md +++ b/content/en/community/adoptions/index.md @@ -2,6 +2,7 @@ title: Adoptions weight: 40 description: Explore practical adoptions of TUF +liases: [/adoptions] --- Each TUF adoption listed below links to an article, presentation, or repository diff --git a/content/en/docs/overview/project/_index.md b/content/en/docs/overview/project/_index.md index c5f83e5..1c23b47 100644 --- a/content/en/docs/overview/project/_index.md +++ b/content/en/docs/overview/project/_index.md @@ -3,6 +3,7 @@ title: Project LinkTitle: Project weight: 20 description: Learn more about the TUF project +liases: [/project] --- The TUF project consists of three components: From 3714867acf71c7a8b2294a5d8a1e08e4862a45a1 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 3 Oct 2024 12:02:42 -0400 Subject: [PATCH 3/6] Fix docsy theme retrograde Used: `npm run get:submodule -- --remote` --- package.json | 2 +- themes/docsy | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6770bad..6d5c0d3 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "diff:check": "npm run _diff:check || (echo; echo 'WARNING: the files above have not been committed'; echo)", "fix:filenames": "npm run _filenames-to-kebab-case", "fix:format": "npm run _check:format -- --write", - "get:submodule": "npm run _get:${GET:-submodule}", + "get:submodule": "npm run _get:${GET:-submodule} --", "make:public": "git init -b main public", "postbuild:preview": "npm run _check:links--warn", "postbuild:production": "npm run _check:links--warn", diff --git a/themes/docsy b/themes/docsy index 309da20..7951194 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit 309da207e5deeda762348bfd0cc32367c5565a1e +Subproject commit 7951194954708d7cc992e3540c8fc823cc99a953 From d027fdf205b38c8ba9440bddee06ffe24cf0ac84 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 3 Oct 2024 12:05:59 -0400 Subject: [PATCH 4/6] Remove invalid alias from Specs page --- content/en/specifications/specs.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/en/specifications/specs.md b/content/en/specifications/specs.md index 0d3ef43..c76ade9 100644 --- a/content/en/specifications/specs.md +++ b/content/en/specifications/specs.md @@ -1,7 +1,6 @@ --- title: Specification linkTitle: Spec -aliases: [/theupdateframework.github.io/specification/latest] menu: { main: { weight: 35 } } cascade: type: docs From f0064de9ffab4e62e0f1474a4999bcb9493320c9 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 3 Oct 2024 12:08:09 -0400 Subject: [PATCH 5/6] TAPs: make linkTitle match alias, and other adjustments --- content/en/docs/overview/project/tap.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/en/docs/overview/project/tap.md b/content/en/docs/overview/project/tap.md index d6f2855..ab3e8b6 100644 --- a/content/en/docs/overview/project/tap.md +++ b/content/en/docs/overview/project/tap.md @@ -1,9 +1,8 @@ --- title: Enhancement Proposals -LinkTitle: Tap -weight: 16 -description: Learn more about TUF Augmentation Proposals +LinkTitle: TAPs aliases: [/taps] +weight: 16 --- ### What is a TAP? From 2f1b7e3648121d6c5d3427068abacee6352fb303 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Thu, 3 Oct 2024 12:12:37 -0400 Subject: [PATCH 6/6] Rename tap.md to taps.md to match current site path --- content/en/docs/overview/project/{tap.md => taps.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename content/en/docs/overview/project/{tap.md => taps.md} (100%) diff --git a/content/en/docs/overview/project/tap.md b/content/en/docs/overview/project/taps.md similarity index 100% rename from content/en/docs/overview/project/tap.md rename to content/en/docs/overview/project/taps.md