doc: remove duplicate outdated docs #1769
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These documents are also hosted on our website and in a better shape too (kudos to @jhdalek55!). There is no need to maintain outdated duplicates. This patch removes the documents and updates references as needed. Note, the full history of these docs can be tracked in the old archived website repo and in the new one (filenames may vary in case and extension): old: https://github.com/theupdateframework/theupdateframework.github.io new: https://github.com/theupdateframework/theupdateframework.io/tree/master/content Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Pull Request Test Coverage Report for Build 1693636531
💛 - Coveralls |
mnm678
approved these changes
Jan 13, 2022
kairoaraujo
pushed a commit
to kairoaraujo/python-tuf
that referenced
this pull request
Jan 14, 2022
This commit is a simple trailing whitespaces cleanup from the files inside the docs folder. The files on docs sub-directories are not part of this commit. The docs/SECURITY.md will be removed on PR theupdateframework#1769 Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
jku
approved these changes
Jan 14, 2022
There was a problem hiding this comment.
I agree with this, looks good to me.
I wonder if we want to be more explicit in naming TUF as the specification (as in reference "TUF specification website" instead of "TUF website") to make the distinction between the projects (python-tuf and TUF) more clear to new readers? Anyway, it's already good ✔️ .
IMO it's okay as it is because python-tuf is the official TUF reference implementation, which makes it less of an autonomous project than other TUF implementations. 🤷 |
|
I was more worried about confusion of type "a link to TUF website when I'm already on the TUF website, that's just silly" -- but I agree it's pretty clear |
lukpueh
added a commit
to lukpueh/peps
that referenced
this pull request
Jan 14, 2022
In preparation for the 1.0.0** release of the TUF reference implementation `python-tuf` documentation referenced in this PEP is being moved. This patch updates the corresponding links in the PEP. ** See https://github.com/theupdateframework/python-tuf/blob/059bfda391893a7e502ed3da5a185ab174e977dc/docs/1.0.0-ANNOUNCEMENT.md More specifically, the following link changes are performed: - METADATA.md to: metadata format section in TUF spec Note: alternatively this could link to the new location of METADATA.md (see theupdateframework/python-tuf#1769), but the spec seems like a better resource - TUTORIAL.md#repo-management to: new metadata API doc on readthedocs and new repo example/tutorial - TUTORIAL.md#lazy-bin-walk to: new hashed bin delegation example/tutorial - client implementation to: new client doc on readthedocs Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
brettcannon
pushed a commit
to python/peps
that referenced
this pull request
Jan 14, 2022
In preparation for the 1.0.0** release of the TUF reference implementation `python-tuf` documentation referenced in this PEP is being moved. This patch updates the corresponding links in the PEP. ** See https://github.com/theupdateframework/python-tuf/blob/059bfda391893a7e502ed3da5a185ab174e977dc/docs/1.0.0-ANNOUNCEMENT.md More specifically, the following link changes are performed: - METADATA.md to: metadata format section in TUF spec Note: alternatively this could link to the new location of METADATA.md (see theupdateframework/python-tuf#1769), but the spec seems like a better resource - TUTORIAL.md#repo-management to: new metadata API doc on readthedocs and new repo example/tutorial - TUTORIAL.md#lazy-bin-walk to: new hashed bin delegation example/tutorial - client implementation to: new client doc on readthedocs Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #-
Description of the changes being introduced by the pull request:
These documents are also hosted on our website and in a better shape too (kudos to @jhdalek55!). There is no need to maintain outdated duplicates.
This patch removes the documents and updates references as needed.
Note, the full history of these docs can be tracked in the old archived website repo and in the new one (filenames may vary in case and extension):
old: https://github.com/theupdateframework/theupdateframework.github.io
new: https://github.com/theupdateframework/theupdateframework.io/tree/master/content
Please verify and check that the pull request fulfills the following
requirements: