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

README: TUF spec version, reference implementation, and other adjustments #853

Merged
merged 1 commit into from
Apr 10, 2019
Merged

README: TUF spec version, reference implementation, and other adjustments #853

merged 1 commit into from
Apr 10, 2019

Conversation

awwad
Copy link
Contributor

@awwad awwad commented Apr 9, 2019

Explain that this repository is a reference implementation, right at the top of the README.

Also:

  • note that this implementation is intended to conform to version
    1.0 of the TUF specification
  • draw some distinctions between the TUF design and this ref impl.
  • turn the older blurb about TUF into an About-TUF section
  • expand that blurb with a link to both an introduction in the repo
    and the TUF website
  • make the documentation links a bit more explicit
  • shuffle some graphical elements for better appeal
  • minor changes like extending some link text

@awwad
DOC: explain what this repo is: the reference implementation
06cdb21 
at the very top of the README.

and:
- note that this implementation is intended to conform to version
  1.0 of the TUF specification
- draw some distinctions between the TUF design and this ref impl.
- turn the older blurb about TUF into an About-TUF section
- expand that blurb with a link to both an introduction in the repo
  and the TUF website
- make the documentation links a bit more explicit
- shuffle some graphical elements for better appeal
- minor changes like extending some link text

Signed-off-by: Sebastien Awwad <sebastien.awwad@gmail.com>
@awwad awwad requested a review from JustinCappos April 9, 2019 21:00
@awwad awwad added the documentation Documentation of the project as well as procedural documentation label Apr 9, 2019
@awwad
Copy link
Contributor Author

awwad commented Apr 9, 2019

@jhdalek55, can you take a quick peek at this?

@jhdalek55
Copy link
Contributor

jhdalek55 commented Apr 9, 2019 via email

@awwad
Copy link
Contributor Author

awwad commented Apr 9, 2019

This is a PR on the TUF reference implementation. It makes some minor changes to the top of the README.

Link to the PR (also available as a "view it on GitHub" link in the email notification you get for this): #853

The diff: https://github.com/theupdateframework/tuf/pull/853/files

The rendered result: https://github.com/theupdateframework/tuf/blob/06cdb21efd7def16fd556d5a6ec911bf1dd77ec1/README.md

@jhdalek55
Copy link
Contributor

jhdalek55 commented Apr 9, 2019 via email

@awwad
Copy link
Contributor Author

awwad commented Apr 9, 2019

Oh, most definitely. This is not pressing.

@awwad
Copy link
Contributor Author

awwad commented Apr 10, 2019

@JustinCappos I'm gonna merge this, but it might be worth a quick peek since it's headline info, in case it's sending a message you don't want sent.

@awwad awwad merged commit b005002 into develop Apr 10, 2019
@JustinCappos
Copy link
Member

Looks good. Thanks for the edits.

@awwad awwad deleted the readme_improvements branch May 2, 2019 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JustinCappos JustinCappos Awaiting requested review from JustinCappos

Assignees
No one assigned
Labels
documentation Documentation of the project as well as procedural documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@awwad @jhdalek55 @JustinCappos