From 0eea727e4e1c495aec4639cc4388264393fd0b33 Mon Sep 17 00:00:00 2001 From: Vladimir Diaz Date: Tue, 23 Jan 2018 17:06:05 -0500 Subject: [PATCH] Add TAP.rst and USAGE.rst Signed-off-by: Vladimir Diaz --- TAP.rst | 12 ++++++++++++ USAGE.rst | 18 ++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 TAP.rst create mode 100644 USAGE.rst diff --git a/TAP.rst b/TAP.rst new file mode 100644 index 00000000..3c20fde4 --- /dev/null +++ b/TAP.rst @@ -0,0 +1,12 @@ +What is a TAP? +-------------- + +A TAP (TUF Augmentation Proposal) is a design document providing information to +the TUF community, or describing a new feature for TUF or its processes or +environment. We intend TAPs to be the primary mechanisms for proposing major +new features, for collecting community input on an issue, and for documenting +the design decisions that have gone into TUF. + +Please visit the `TAPs GitHub repo `_ +to review design changes that have been proposed to date, or to submit +your own new feature. diff --git a/USAGE.rst b/USAGE.rst new file mode 100644 index 00000000..11216137 --- /dev/null +++ b/USAGE.rst @@ -0,0 +1,18 @@ +Using TUF +--------- + +TUF has four major classes of users: clients, for whom TUF is largely +transparent; mirrors, who will (in most cases) have nothing at all to do +with TUF; upstream servers, who will largely be responsible for care and +feeding of repositories; and integrators, who do the work of putting TUF +into existing projects. + +An integration requires importing a single module into the new or existing +software updater and calling particular methods to perform updates. Generating +metadata files stored on upstream servers can be handled by repository tools that +we provide for this purpose. + + +- `Integrating with a Software Updater `_ + +- `Creating a TUF Repository `_