doc: consider re-adding a "quickstart" document

[lukpueh]

trafficstars

Supersedes https://github.com/theupdateframework/python-tuf/issues/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 with python-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:

• no explicit "quick start" documentation

Expected behavior:

• consider adding quick start documentation or better frame existing documentation

[joshuagl]

I think the ideal place for quick start documentation for a library like python-tuf is the developer documentation on RTD.

[MVrachev]

Also, we should keep in mind that we have the examples/ folder with some great examples. I think we would need a quickstart document if we are going to showcase the usage of a TUF CLI. I see that in examples/client.py we do provide a CLI for the client. Maybe a small QUICKSTART.md document showcasing how to use the examples/client.py CLI and a reference to the examples/basic_repo.py could be enough.

[lukpueh]

Also, we should keep in mind that we have the examples/ folder with some great examples. I think we would need a quickstart document if we are going to showcase the usage of a TUF CLI. I see that in examples/client.py we do provide a CLI for the client. Maybe a small QUICKSTART.md document showcasing how to use the examples/client.py CLI and a reference to the examples/basic_repo.py could be enough.

Exactly! That's what I meant with "...or better frame existing documentation"