Skip to content

doc: reword announcement about upcoming 1.0.0 #1869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Feb 15, 2022

NOTE: Should be merged directly before release (coordinate with #1851)

Fixes #1795

Description of the changes being introduced by the pull request:
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

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@coveralls
Copy link

coveralls commented Feb 15, 2022

Pull Request Test Coverage Report for Build 1851738368

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.2%) to 98.574%

Totals Coverage Status
Change from base Build 1847342708: 0.2%
Covered Lines: 1095
Relevant Lines: 1107

💛 - Coveralls

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]>
@lukpueh lukpueh force-pushed the minor-pre-1.0-doc-changes branch from 1c1d07c to baf33c4 Compare February 15, 2022 13:59
Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. This looks good. I made a few minor suggestions, WDYT?

Comment on lines 12 to 15
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that this code has been removed, should this statement be moved down? The next paragraph seems more important.

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 <[email protected]>
Signed-off-by: Lukas Puehringer <[email protected]>
@lukpueh lukpueh force-pushed the minor-pre-1.0-doc-changes branch from aafcd4e to 399a482 Compare February 16, 2022 08:38
@lukpueh
Copy link
Member Author

lukpueh commented Feb 16, 2022

Thanks for the review, @joshuagl! All your suggestions make sense and are now in 399a482

Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick edits, LGTM

@jku jku mentioned this pull request Feb 18, 2022
@lukpueh
Copy link
Member Author

lukpueh commented Feb 18, 2022

Superseded by #1873

@lukpueh lukpueh closed this Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: remove/reword announcement about upcoming 1.0.0 on release
3 participants