refactor(docs): Disambiguate sigstoreSigned documentation #1890
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
Delet0r
force-pushed
the
docs_improvement
branch
from
fa0ae69
to
7673a86
Compare
mtrmac
reviewed
Mar 17, 2023
docs/containers-policy.json.5.md
Outdated
| @@ -282,7 +282,7 @@ signed by the provided public key. | |||
| The `signedIdentity` field has the same semantics as in the `signedBy` requirement described above. | |||
| Note that `cosign`-created signatures only contain a repository, so only `matchRepository` and `exactRepository` can be used to accept them (and that does not protect against substitution of a signed image with an unexpected tag). | |||
|
|
|||
| To use this with images hosted on image registries, the relevant registry or repository must have the `use-sigstore-attachments` option enabled in containers-registries.d(5). | |||
| To use this with images hosted on image registries, the `use-sigstore-attachments` option needs to be enabled for any registry specifically in the client's containers-registries.d(5). | |||
There was a problem hiding this comment.
“the relevant registry or repository” is right; “any registry” is not saying the same thing, and I don’t understand “any registry specifically” at all.
There was a problem hiding this comment.
Yeah, you are right. That sounded better when is was writing it. I'll change that back.
From the current documentation, one could mistakenly assume, that `use-sigstore-attachments` needs to be enabled by the registry and not in the client. This commit rephrases the part of the documentation to make it more clear, that this needs to be done on the client side. Signed-off-by: Lucas Humfeldt <[email protected]>
Delet0r
force-pushed
the
docs_improvement
branch
from
7673a86
to
b3e0ba2
Compare
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.
From the current documentation, one could mistakenly assume, that
use-sigstore-attachmentsneeds to be enabled by the registry and not in the client. This commit rephrases the part of the documentation to make it more clear, that this needs to be done on the client side.