Commit graph

16 commits

Author SHA1 Message Date
1seal
d5fa0b0594 address review feedback: remove redundant root.json writes, rename docs section
Signed-off-by: 1seal <security@1seal.org>
2026-02-19 14:46:40 +01:00
1seal
c49bdb9322 feat(ngclient): require explicit bootstrap argument
make bootstrap required and explicit: callers must pass bootstrap=<root_bytes> or bootstrap=None.

also tighten docs, examples, and tests to reflect the explicit trust anchor choice.

Signed-off-by: 1seal <security@1seal.org>
2026-01-25 11:58:09 +00:00
Jussi Kukkonen
6d5c5cd867 requirements: pynacl is no longer needed
This is obsolete by now.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2024-12-31 11:05:43 +02:00
Jussi Kukkonen
70555f6e1b build: shorten requirements file names
Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2023-02-06 14:52:07 +02:00
Jussi Kukkonen
33829fdbab build: Move requirements file to a directory
We already have 6 files and I'm planning to add another one: maybe it's
time to move these out of the top level directory.

Signed-off-by: Jussi Kukkonen <jkukkonen@google.com>
2023-02-06 14:50:47 +02:00
Lukas Puehringer
02167403f2 doc: move verify section in install docs
Move release signature verification instructions to bottom of
install docs. The doc is short, so the section is still prominent
enough for promoting verification, but does not break the reading
flow as much anymore.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-10 10:07:13 +01:00
Lukas Puehringer
5ec4c95538 doc: update installation documentation
Update severely outdated installation documentation.

- Simplify "Simple Installation" section
- Update "Release Verification" section to actually verify a tuf
  release and with a key of an active maintainer
- Update and simplify section about non-python dependencies
  (just point to installation instructions for underlying crypto
  backends, they are up-to-date and have become a lot easier)
- Add "Development installation" section

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
2022-02-09 17:55:23 +01:00
Joshua Lock
3dc5594242 Update links to account for repository rename
We have renamed the repository from tuf->python-tuf

Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-09-01 11:15:33 +01:00
Jussi Kukkonen
3ee6a3e786
docs: Tweak INSTALLATION.rst
* Remove link to outdated roadmap
* Link to maintainers file in the same way as two lines earlier
* Fix formatting issues with code blocks

These fixes allow the installation rst to be used from sphinx sources
and from docs root.

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-25 17:05:05 +03:00
samuelgregorovic
112575d987 updated docs and comments
Updated/removed documented commands and comments which were referencing Python2. Also updated links to documentation referencing Python2 docs (unchanged where needed)

Signed-off-by: Samuel Gregorovic <samuelgregorovic@gmail.com>
Signed-off-by: samuelgregorovic <samuelgregorovic@gmail.com>
2021-07-14 10:37:08 +03:00
Domenico Andreoli
feaf88e33b Fix typo in section "Release Verification"
Signed-off-by: Domenico Andreoli <domenico.andreoli@linux.com>
2019-12-20 10:06:44 +01:00
Sebastien Awwad
56a2928952
DOC: move full install instructions to INSTALLATION.rst
and note that if errors occur while installing the optional
crypto dependencies, that the non-Python dependencies section
should be consulted.

Also adds a git clone step to the development installation
instructions in the contributors' instructions, and other
minor installation notes for contributors.

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
2019-04-08 17:13:11 -04:00
Vladimir Diaz
be4e31c969
Update installation instructions to mention extra dependencies
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-06-04 14:52:05 -04:00
Vladimir Diaz
0592df5126
Link to resources that contain our maintainer's PGP keys
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-03-23 15:55:55 -04:00
Vladimir Diaz
1212594a57
More organizational changes
Modified documentation links in README.
Added a Getting Started doc

Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-24 14:09:48 -05:00
Vladimir Diaz
5aecea70b9
Move docs to the docs/ directory
Signed-off-by: Vladimir Diaz <vladimir.v.diaz@gmail.com>
2018-01-24 10:57:01 -05:00
Renamed from INSTALLATION.rst (Browse further)