docs: rewrite README - continuation#634
Merged
jku merged 2 commits intosecure-systems-lab:mainfrom Sep 4, 2023
Merged
Conversation
- Switch from rst to markdown (syntax is just so much easier) - Add honest project description (securesystemslib is for TUF and in-toto). - Remove wordy Overview section. Relevant information about crypto backends, and key types and formats should be documented as part of the API on RTD. - Replace legacy interface snippets in Usage section with link to securesystemslib RTD page. Legacy interfaces have functional replacements in the new Signer API, i.e. CryptoSigner for file-based RSA, ed25519, ecdsa keys, and GPGSigner for GPG keys. Signer API docs are still WIP (see secure-systems-lab#622), but already seem more useful than the legacy docs. And we definitely don't want to encourage anyone to use legacy interfaces. - Shorten installation/testing sections. Signed-off-by: Lukas Puehringer <[email protected]>
Signed-off-by: Martin Vrachev <[email protected]>
Closed
jku
approved these changes
Sep 4, 2023
Collaborator
jku
left a comment
jku
left a comment
There was a problem hiding this comment.
Thanks for the tweaks, looks good to me now.
Closed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Superceds pr #624 with the only change that I applied Jussi's comment from the original pr.
Description from original pr:
Switch from rst to markdown (syntax is just so much easier)
Add honest project description (securesystemslib is for TUF and in-toto).
Remove wordy Overview section. Relevant information about crypto backends, and key types and formats should be documented as part of the API on RTD.
Replace legacy interface snippets in Usage section with link to securesystemslib RTD page.
Legacy interfaces have functional replacements in the new Signer API, i.e. CryptoSigner for file-based RSA, ed25519, ecdsa keys, and GPGSigner for GPG keys.
Signer API docs are still WIP (see #622), but already seem more useful than the legacy docs. And we definitely don't want to encourage anyone to use legacy interfaces.
Fixes README part of #511