Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: minor updates in readme and reference docs #1868

Merged
merged 2 commits into from
Feb 15, 2022
Merged

doc: minor updates in readme and reference docs #1868

merged 2 commits into from
Feb 15, 2022

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Feb 15, 2022

Fixes #1795 (comment)

Description of the changes being introduced by the pull request:

  • in README.md:
    • add generic opening sentence that says what TUF actually does.
    • add link to #tuf channel on CNCF slack to contact section
  • in RTD/reference docs: remove note about unstable API in RTD docs (it no longer is unstable)

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 •
edited
Loading

Pull Request Test Coverage Report for Build 1847002792

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.348%
Totals Coverage Status
Change from base Build 1840943084: 0.0%
Covered Lines: 1122
Relevant Lines: 1138
💛 - Coveralls

@lukpueh
doc: minor readme updates
24561bc 
- Add generic opening sentence that says what TUF actually does.
- Add link to #tuf channel on CNCF slack to contact section

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
@lukpueh
doc: remove note about unstable API in RTD docs
7a13933 
The API is no longer unstable.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
jku
jku approved these changes Feb 15, 2022
View reviewed changes
Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

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

Looks great. That first sentence in the README has been bugging me for a while, and I'm definitely stealing that description.

@lukpueh lukpueh merged commit 0b64056 into theupdateframework:develop Feb 15, 2022
@lukpueh lukpueh mentioned this pull request Feb 15, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jku jku jku approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: remove/reword announcement about upcoming 1.0.0 on release
3 participants
@lukpueh @coveralls @jku