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.

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

Remove obsolete client documentation #1001

Merged
merged 2 commits into from
Mar 16, 2020

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Mar 16, 2020

Fixes issue #:
Fixes #1000
Partially addresses #808

Description of the changes being introduced by the pull request:
Remove incomplete and severely outdated client_setup_and_repository_example.md. Similar but up-to-date information is available in the docs/TUTORIAL.md , and more extensive documentation can be found in tuf/client/README.md. The latter also needs revision.

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

Remove link to incomplete and severely outdated
client_setup_and_repository_example.md in client section of
TUTORIAL.md.

Instead we should link (or move the entire client tutorial part) to
tuf/client/README.md, which is more comprehensive and less outdated
than above document (see theupdateframework#808).

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
An up-to-date version of the minimal client usage instructions
from client_setup_and_repository_example.md can be found in
the main TUF tutorial.

More comprehensive documentation of the tuf client can be found in
tuf/client/README.md, which also needs a revision.

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks @lukpueh

@lukpueh lukpueh merged commit c63b7f3 into theupdateframework:develop Mar 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

File "tuf/client_setup_and_repository_example.md" is extermely outdated
2 participants