Skip to content

Commit a5ea2b0

Browse files
committed
[docsy] Adjust links to spec, community contrib page, repo src
1 parent be0c41a commit a5ea2b0

File tree

7 files changed

+23
-21
lines changed

7 files changed

+23
-21
lines changed

Diff for: .cspell.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ words:
2626
- Cappos
2727
- CNCF
2828
- Docsy
29+
- Uptane

Diff for: content/en/community/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Community
33
menu: { main: { weight: 40 } }
44
cascade: { type: docs }
5-
contributingUrl: https://github.com/theupdateframework/community/blob/main/CONTRIBUTING.md
5+
contributingUrl: /docs/contributing/
66
aliases: [/contact]
77
---
88

Diff for: content/en/docs/contributing.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ title: Contributing
33
weight: 700
44
---
55

6-
There are many opportunities to contribute to TUF project. You can contribute to
7-
the [specification](/specification/) or [documentation](/docs/).
6+
There are several opportunities to contribute to the TUF project. You can
7+
contribute to the [specification](/specification/), [documentation](/docs/), or
8+
any one of the TUF implementations from the [TUF organization].
89

9-
For guidance on how to contribute, see the
10-
[TUF Contributor Guide](https://github.com/theupdateframework/community/blob/main/CONTRIBUTING.md).
10+
For guidance, see the [Community] repo [Contributing] page.
1111

12-
For more information on how to contribute, reach out to the
13-
[TUF community site](/community/) or check out areas of contribution on GitHub
14-
[The Update Framework]({{% param github_repo %}}).
12+
[Community]: https://github.com/theupdateframework/community/
13+
[Contributing]:
14+
https://github.com/theupdateframework/community/blob/main/CONTRIBUTING.md
15+
[TUF organization]: https://github.com/theupdateframework

Diff for: content/en/docs/faq.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ rotate offline keys), and how to periodically update and re-sign metadata.
2020

2121
For (2), an adopter has to figure out how to ship the initial Root file, and
2222
implement
23-
[the TUF download and verification workflow](https://theupdateframework.github.io/specification/latest/#detailed-client-workflow)
23+
[the TUF download and verification workflow](/specification/latest/#detailed-client-workflow)
2424
in their language of choice if one of the existing implementations is
2525
insufficient.
2626

@@ -116,7 +116,7 @@ bandwidth associated with downloading the large file many times can be saved.
116116
The reference implementation provides an
117117
[easy way to distribute target files across many targets metadata](https://github.com/theupdateframework/python-tuf/blob/v0.20.0/examples/repo_example/hashed_bin_delegation.py)
118118
(i.e., delegating to hashed bins), which the specification refers to as
119-
[path hash prefixes](https://theupdateframework.github.io/specification/latest/#path_hash_prefixes).
119+
[path hash prefixes](/specification/latest/#path_hash_prefixes).
120120

121121
**10. Can TUF be used with devices that lack the CPU power or memory to verify
122122
metadata?**
@@ -138,8 +138,8 @@ in [TAP 4](https://github.com/theupdateframework/taps/blob/master/tap4.md).
138138

139139
**12. Has there been a security audit of TUF?**
140140

141-
The [Security Audits](docs/security/) page links to a few of the security audits
142-
of TUF.
141+
The [Security audits](docs/security/audits/) page links to a few of the security
142+
audits of TUF.
143143

144144
**13. How can I try TUF?**
145145

@@ -152,5 +152,5 @@ that demonstrate the usage.
152152

153153
**14. Is there a presentation or video about TUF?**
154154

155-
The [Videos]() page contains links to presentations that have been given by both
156-
TUF developer personnel, as well as adopters.
155+
The [Videos](/resources/videos/) page contains links to presentations that have
156+
been given by both TUF developer personnel, as well as adopters.

Diff for: content/en/docs/project/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ the project roles used below, see [Governance].
3030
https://github.com/theupdateframework/python-tuf/blob/develop/docs/AUTHORS.txt
3131
[Governance]:
3232
https://github.com/theupdateframework/specification/blob/master/GOVERNANCE.md
33-
[Specification]: https://theupdateframework.github.io/specification/latest
33+
[Specification]: /specification/latest
3434
[Standardization process]:
3535
https://github.com/theupdateframework/taps/blob/master/tap1.md
3636
[Reference implementation]: https://theupdateframework.readthedocs.io/en/latest/

Diff for: content/en/resources/news.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: News
33
aliases: [/news, /press]
4+
cSpell:ignore: Sigstore
45
---
56

67
## Highlights
@@ -18,14 +19,12 @@ root, and shorter root key lifespan than traditional PKI models.
1819

1920
**March 5, 2021**
2021

21-
The
22-
[TUF specification](https://theupdateframework.github.io/specification/latest/index.html)
23-
is now published as a rich HTML document with a table of contents, syntax
24-
highlighting, cross-linking, and other features.
22+
The [TUF specification](/specification/latest/) is now published as a rich HTML
23+
document with a table of contents, syntax highlighting, cross-linking, and other
24+
features.
2525

2626
The new publication machinery also maintains a
27-
[list of all versions ](https://theupdateframework.github.io/specification/)
28-
published since the format change.
27+
[list of all versions](/specification/list/) published since the format change.
2928

3029
**October 30, 2020**
3130

Diff for: hugo.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ params:
8383
[Funding](/docs/project/funding/) |
8484
# from_year: 2024
8585
github_repo: &repo https://github.com/theupdateframework/theupdateframework.io
86+
github_branch: docsy # FIXME - remove once this get merged into main
8687
## 2024-10-05 Disabling search until we agree on a viable solution. For context
8788
## see https://github.com/theupdateframework/theupdateframework.io/pull/92
8889
# gcs_engine_id: 06ecafa260afd40f9 # Also see layouts/partials/hooks/head-end.html

0 commit comments

Comments
 (0)