Skip to content

Commit baf33c4

Browse files
committed
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 <[email protected]>
1 parent 0b64056 commit baf33c4

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@
66
[![CII](https://bestpractices.coreinfrastructure.org/projects/1351/badge)](https://bestpractices.coreinfrastructure.org/projects/1351)
77
[![PyPI](https://img.shields.io/pypi/v/tuf)](https://pypi.org/project/tuf/)
88

9-
----------------------------
10-
*__IMPORTANT NOTICE:__ A stable 1.0.0 release of the modern implementation only
11-
is scheduled for January 2022. Please see the [*1.0.0
12-
announcement*](https://github.com/theupdateframework/python-tuf/blob/develop/docs/1.0.0-ANNOUNCEMENT.md)
13-
page for more details about the release and the deprecation of the legacy
14-
implementation, including migration instructions.*
15-
169
----------------------------
1710
[The Update Framework (TUF)](https://theupdateframework.io/) is a framework for
1811
secure content delivery and updates. It protects against various types of
@@ -30,7 +23,7 @@ Python-TUF provides two APIs:
3023

3124
High-level support for implementing
3225
[repository operations](https://theupdateframework.github.io/specification/latest/#repository-operations)
33-
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).
26+
is planned but not yet provided: see [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md).
3427

3528
The reference implementation strives to be a readable guide and demonstration
3629
for those working on implementing TUF in their own languages, environments, or

docs/1.0.0-ANNOUNCEMENT.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Announcing TUF 1.0.0
22

3-
In the past year we have made an effort to revise, redesign and rewrite this
4-
python-tuf reference implementation, and we are very excited to announce a
5-
stable 1.0.0 release scheduled for January 2022. The release *will* include:
3+
Python-TUF v1.0.0 is a rewritten stable reference implementation of the TUF
4+
specification, which *includes*:
65
- a modern low-level [*metadata
76
API*](https://theupdateframework.readthedocs.io/en/latest/api/tuf.api.html)
87
- a fully specification-compliant [*updater
@@ -11,7 +10,7 @@ stable 1.0.0 release scheduled for January 2022. The release *will* include:
1110
for the legacy client updater
1211

1312
As discussed in [ADR 2](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0002-pre-1-0-deprecation-strategy.md), this
14-
release *will not* include any legacy code, as its maintenance has become
13+
release *does not* include any legacy code, as its maintenance has become
1514
infeasible for the python-tuf team. The pre-1.0.0 deprecation strategy from ADR
1615
2 applies as follows:
1716

@@ -22,13 +21,11 @@ processes). Note that there may be delays due to the lack of developer resources
2221
for reviewing such pull requests.*
2322

2423
For the reasons outlined in [ADR 10](https://github.com/theupdateframework/python-tuf/blob/develop/docs/adr/0010-repository-library-design.md
25-
), this release *will not yet* include a new *repository tool*. However, the new
24+
), this release *does not yet* include a new *repository tool*. However, the new
2625
*metadata API* makes it easy to replicate the desired functionality tailored to
2726
the specific needs of any given repository (see *Migration* for details).
2827

2928

30-
31-
3229
## Migration
3330

3431
Given the clean cut with the legacy reference implementation, we provide the

0 commit comments

Comments
 (0)