From e5de36f4e06b154ea5fa3b931533f7999457eaab Mon Sep 17 00:00:00 2001 From: Teodora Sechkova Date: Wed, 25 Aug 2021 16:59:31 +0300 Subject: [PATCH] docs: Add links to the specification Signed-off-by: Teodora Sechkova --- docs/api/api-reference.rst | 13 ++++++++----- docs/api/tuf.ngclient.rst | 4 +++- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/api/api-reference.rst b/docs/api/api-reference.rst index 68fb0541..0c4b17bc 100644 --- a/docs/api/api-reference.rst +++ b/docs/api/api-reference.rst @@ -6,14 +6,14 @@ TUF provides multiple APIs: * The low-level :doc:`tuf.api` provides access to a Metadata file abstraction - that closely follows the TUF specification and the file format: This API - handles de/serialization to and from files and makes it easier to access + that closely follows the TUF specification's `document formats`_. + This API handles de/serialization to and from files and makes it easier to access and modify metadata content safely. It is purely focused on individual pieces of Metadata and provides no concepts like "repository" or "update workflow". -* The client update workflow is implemented in the :doc:`tuf.ngclient` module: It is - a higher-level API that provides ways to query and download target files +* The `client update workflow`_ is implemented in the :doc:`tuf.ngclient` module: + It is a higher-level API that provides ways to query and download target files securely, while handling the TUF update workflow behind the scenes. ngclient is implemented on top of the Metadata API and can be used to implement various TUF clients with relatively little effort. @@ -30,4 +30,7 @@ TUF provides multiple APIs: :caption: Contents: tuf.api - tuf.ngclient \ No newline at end of file + tuf.ngclient + +.. _client update workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow +.. _document formats: https://theupdateframework.github.io/specification/latest/#document-formats diff --git a/docs/api/tuf.ngclient.rst b/docs/api/tuf.ngclient.rst index df705bbf..31b7ba7e 100644 --- a/docs/api/tuf.ngclient.rst +++ b/docs/api/tuf.ngclient.rst @@ -3,7 +3,7 @@ ngclient The ngclient module contains a complete TUF client library implementation. -* :doc:`tuf.ngclient.updater` implements the client update workflow +* :doc:`tuf.ngclient.updater` implements the `detailed client workflow`_ * :doc:`tuf.ngclient.config` provides optional configuration for the updater * :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control @@ -15,3 +15,5 @@ The ngclient module contains a complete TUF client library implementation. tuf.ngclient.config tuf.ngclient.fetcher +.. _detailed client workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow +