From baf33c4898ab11b894bdc844d6aa8c51f97e7159 Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Tue, 15 Feb 2022 13:49:11 +0100 Subject: [PATCH 1/2] doc: reword announcement about upcoming 1.0.0 Change docs in preparation of close v1.0.0 release. - Remove important notice about upcoming 1.0.0 release from README - Reword 1.0.0-ANNOUNCEMENT.md to not sound outdated after release Signed-off-by: Lukas Puehringer --- README.md | 9 +-------- docs/1.0.0-ANNOUNCEMENT.md | 11 ++++------- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c3b24f3c2d..54823ba531 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,6 @@ [![CII](https://bestpractices.coreinfrastructure.org/projects/1351/badge)](https://bestpractices.coreinfrastructure.org/projects/1351) [![PyPI](https://img.shields.io/pypi/v/tuf)](https://pypi.org/project/tuf/) ----------------------------- -*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only -is scheduled for January 2022. Please see the [*1.0.0 -announcement*](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md) -page for more details about the release and the deprecation of the legacy -implementation, including migration instructions.* - ---------------------------- [The Update Framework (TUF)](https://theupdateframework.io/) is a framework for secure content delivery and updates. It protects against various types of @@ -30,7 +23,7 @@ Python-TUF provides two APIs: High-level support for implementing [repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations) -is planned but not yet provided: see [1.0.0 plans](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md). +is planned but not yet provided: see [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md). The reference implementation strives to be a readable guide and demonstration for those working on implementing TUF in their own languages, environments, or diff --git a/docs/1.0.0-ANNOUNCEMENT.md b/docs/1.0.0-ANNOUNCEMENT.md index 9d4bc6ff4b..c874d7ce2a 100644 --- a/docs/1.0.0-ANNOUNCEMENT.md +++ b/docs/1.0.0-ANNOUNCEMENT.md @@ -1,8 +1,7 @@ # Announcing TUF 1.0.0 -In the past year we have made an effort to revise, redesign and rewrite this -python-tuf reference implementation, and we are very excited to announce a -stable 1.0.0 release scheduled for January 2022. The release *will* include: +Python-TUF v1.0.0 is a rewritten stable reference implementation of the TUF +specification, which *includes*: - a modern low-level [*metadata API*](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html) - a fully specification-compliant [*updater @@ -11,7 +10,7 @@ stable 1.0.0 release scheduled for January 2022. The release *will* include: for the legacy client updater As discussed in [ADR 2](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0002-pre-1-0-deprecation-strategy.md), this -release *will not* include any legacy code, as its maintenance has become +release *does not* include any legacy code, as its maintenance has become infeasible for the python-tuf team. The pre-1.0.0 deprecation strategy from ADR 2 applies as follows: @@ -22,13 +21,11 @@ processes). Note that there may be delays due to the lack of developer resources for reviewing such pull requests.* For the reasons outlined in [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md -), this release *will not yet* include a new *repository tool*. However, the new +), this release *does not yet* include a new *repository tool*. However, the new *metadata API* makes it easy to replicate the desired functionality tailored to the specific needs of any given repository (see *Migration* for details). - - ## Migration Given the clean cut with the legacy reference implementation, we provide the From 399a4823b49b2ec7232c75bc1eb225d2d831b6a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20P=C3=BChringer?= Date: Wed, 16 Feb 2022 09:33:10 +0100 Subject: [PATCH 2/2] doc: tweak announcement about upcoming 1.0.0 Further tweak doc in preparation of close v1.0.0 release: - Minor rewords/re-formats - Swap paragraphs according to importance Co-authored-by: Joshua Lock Signed-off-by: Lukas Puehringer --- docs/1.0.0-ANNOUNCEMENT.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/1.0.0-ANNOUNCEMENT.md b/docs/1.0.0-ANNOUNCEMENT.md index c874d7ce2a..0020632b22 100644 --- a/docs/1.0.0-ANNOUNCEMENT.md +++ b/docs/1.0.0-ANNOUNCEMENT.md @@ -1,7 +1,7 @@ # Announcing TUF 1.0.0 Python-TUF v1.0.0 is a rewritten stable reference implementation of the TUF -specification, which *includes*: +specification, which *currently* includes: - a modern low-level [*metadata API*](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html) - a fully specification-compliant [*updater @@ -9,6 +9,12 @@ specification, which *includes*: serving as a more robust and yet more flexible stand-in replacement for the legacy client updater +For the reasons outlined in [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md +), this release *does not yet* include *repository tool*-like functionality. +However, the new *metadata API* makes it easy to replicate the desired +functionality tailored to the specific needs of any given repository (see +*Migration* for details). + As discussed in [ADR 2](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0002-pre-1-0-deprecation-strategy.md), this release *does not* include any legacy code, as its maintenance has become infeasible for the python-tuf team. The pre-1.0.0 deprecation strategy from ADR @@ -20,11 +26,6 @@ prior to 1.0.0 will be considered, and merged (subject to normal review processes). Note that there may be delays due to the lack of developer resources for reviewing such pull requests.* -For the reasons outlined in [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md -), this release *does not yet* include a new *repository tool*. However, the new -*metadata API* makes it easy to replicate the desired functionality tailored to -the specific needs of any given repository (see *Migration* for details). - ## Migration