Skip to content

Add an FAQ and/or high-level overview of how to integrate TUF #486

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

Open
vladimir-v-diaz opened this issue Aug 28, 2017 · 3 comments
Open
Labels
documentation Documentation of the project as well as procedural documentation

Comments

@vladimir-v-diaz
Copy link
Contributor

vladimir-v-diaz commented Aug 28, 2017

We are often asked the same questions regarding delegations, how to organize TUF metadata, key management, etc. There should be an FAQ page for these sorts of questions.

The Survivable Key Compromise paper provides an overview of TUF's design, and the specification and other documents available here capture most of what it contains. However, the integration side of things is not adequately explained outside of the Diplomat and Mercury papers. The PEP 458 document is also a good resource for how to integrate TUF with an existing software updater and community repository.

We should provide a condensed, high-level document that contains the information in the papers and documents that have been written since the Survivable Key Compromise paper.

@vladimir-v-diaz vladimir-v-diaz changed the title Add an FAQ and/or high-level overview of how to integrate TUF. Add an FAQ and/or high-level overview of how to integrate TUF Aug 28, 2017
@vladimir-v-diaz vladimir-v-diaz added the good first issue Bite-sized items for first time contributors label Nov 30, 2017
@vladimir-v-diaz
Copy link
Contributor Author

We are working on an FAQ page for the website. See theupdateframework/theupdateframework.github.io#29. There should also be a document that captures more of the recent developments from the Mercury and Diplomat papers.

@joshuagl joshuagl added this to the 1.0.0 milestone Jul 7, 2020
@joshuagl joshuagl removed this from the 1.0.0 milestone Sep 8, 2020
@MVrachev
Copy link
Collaborator

MVrachev commented Sep 25, 2020

I don't think this is a good-first-issue. To write such a page one should understand how TUF works.

@joshuagl joshuagl removed the good first issue Bite-sized items for first time contributors label Sep 25, 2020
@lukpueh lukpueh added the documentation Documentation of the project as well as procedural documentation label Sep 28, 2020
@lukpueh lukpueh closed this as completed Apr 1, 2025
@lukpueh lukpueh reopened this Apr 1, 2025
@lukpueh
Copy link
Member

lukpueh commented Apr 1, 2025

Duplicate of #2452

@lukpueh lukpueh marked this as a duplicate of #2452 Apr 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of the project as well as procedural documentation
Projects
None yet
Development

No branches or pull requests

4 participants