Skip to content

Commit c26ac89

Browse files
committed
Update references to python-tuf repo
In preparation for the 1.0.0 release of the TUF reference implementation python-tuf documentation linked on the TUF website is being moved. This patch updates these links. In particular: - In menu item "Getting started" Point to "Reference implementation" repo instead of "Implementation Getting Started" page. The Getting Started page is being deprecated, and the repo (i.e. README.md) should be just as informative. - In "FAQ: Are there ways to reduce bandwidth costs?" Point to new hashed bin delegation example and specific section in spec (old tutorial is deprecated) - In "FAQ: 13. How can I try TUF?" Point to API reference on RTD and up-to-date source code examples in python-tuf (getting started is deprecated) Signed-off-by: Lukas Puehringer <[email protected]>
1 parent 889d6ea commit c26ac89

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

config.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ weight = 5
108108

109109

110110
[[menu.main]]
111-
name = "Implementation"
111+
name = "Reference implementation"
112112
parent = "getting-started"
113-
url = "https://github.com/theupdateframework/python-tuf/blob/develop/docs/GETTING_STARTED.rst#getting-started"
113+
url = "https://github.com/theupdateframework/python-tuf"
114114
weight = 6
115115

116116
[[menu.main]]

content/faq.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ title: Frequently Asked Questions
114114
the bandwidth associated with downloading the large file many times can be
115115
saved. The reference implementation provides an [easy way to distribute
116116
target files across many targets
117-
metadata](https://github.com/theupdateframework/python-tuf/blob/d4b308ae13acfe832bfb7f993108e5e065d44c04/tuf/repository_tool.py#L2387)
118-
(i.e., delegating to hashed bins), which the
119-
[specification](https://github.com/theupdateframework/specification/blob/master/tuf-spec.md)
120-
refers to as path hash prefixes.
117+
metadata](https://github.com/theupdateframework/python-tuf/blob/v0.20.0/examples/repo_example/hashed_bin_delegation.py)
118+
(i.e., delegating to hashed bins), which the specification refers to as [path
119+
hash
120+
prefixes](https://theupdateframework.github.io/specification/latest/#path_hash_prefixes).
121121

122122
**10. Can TUF be used with devices that lack the CPU power or memory to
123123
verify metadata?**
@@ -145,11 +145,12 @@ title: Frequently Asked Questions
145145

146146
**13. How can I try TUF?**
147147

148-
The [Getting
149-
Started](https://github.com/theupdateframework/python-tuf/blob/develop/docs/GETTING_STARTED.rst)
150-
page contains instructions to install and run the reference implementation.
151-
The client and repo tools can be used to quickly create TUF repositories and
152-
experiment with software updates.
148+
The `python-tuf` reference implementation provides a [well-documented
149+
API](https://theupdateframework.readthedocs.io/en/latest/api/api-reference.html)
150+
to create and manage TUF metadata on a server-side repository, and to perform
151+
TUF-compliant updates on a client, as well as basic Python [code
152+
examples](https://github.com/theupdateframework/python-tuf/tree/develop/examples)
153+
that demonstrate the usage.
153154

154155
**14. Is there a presentation or video about TUF?**
155156

0 commit comments

Comments
 (0)