-
Notifications
You must be signed in to change notification settings - Fork 272
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
doc: consider re-adding a "quickstart" document #1797
Comments
I think the ideal place for quick start documentation for a library like python-tuf is the developer documentation on RTD. |
Remove documentation for legacy client, repository/developer tool and command line tools, which will be removed in subsequent commits. See theupdateframework#1797 and theupdateframework#1798 for replacing ATTACKS.md and QUICKSTART.md. Signed-off-by: Lukas Puehringer <[email protected]>
Also, we should keep in mind that we have the |
Exactly! That's what I meant with "...or better frame existing documentation" |
Remove documentation for legacy client, repository/developer tool and command line tools, which will be removed in subsequent commits. See theupdateframework#1797 and theupdateframework#1798 for replacing ATTACKS.md and QUICKSTART.md. Signed-off-by: Lukas Puehringer <[email protected]>
Hello @lukpueh, I would like to work on this issue. I have checked the previous quickstart guide we had and got an idea of it. I see we already have Installation guide, so it is just enough to refer to this page, isnt it? For outline of quickstart page, considering beginner audience as my target audience, I have following in my mind - Quickstart with TUF1. Introduction to TUF
2. Installing TUF(link of existing installation guide) 3. Using the TUF CLI Tools
4. Understanding the CLI Output
5. Next Steps
What do you think about it? How can I improve it? |
Those cli tools don't exist anymore. You could take a look the existing repository and client examples and see how they could be used for a quick start guide. |
It's not really a "quickstart" for integrating python-tuf, but I think we could build something around the examples that a newcomer would benefit from:
Each of these already has their own README but I can see benefit in a single page that creates a story around the whole thing and documents how to run all three. |
Supersedes #1006
Description of issue or feature request:
#1790 removes
QUICKSTART.md
because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar withpython-tuf
and are also easy to discover (e.g. via main README and main menu on RTD).Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).
Current behavior:
Expected behavior:
The text was updated successfully, but these errors were encountered: