Is your feature request related to a problem?
It's currently extremely confusing for people who want to docker pull some image to use notation
What solution do you propose?
The main page of notation shouldn't link to a guide for how publishers can use notation to sign their images.
The main page of notation should link to a guide for how users can use notation to download and verify some existing image.
Specifically, I'm referring to the big "Get started" CTA button on this page:
...that currently links to a guide that tells me to create an OCI-compatible registry. Wut. No.
People who are looking to "get started" with notary shouldn't have to create an OCI-compatible registry. We're looking for just the bare-minimum commands to download and verify an image with notary.
I would recommend picking one very popular container that's signed with notation, and writing a as-few-commands-as-possible guide showing how to download the image.
The guide should show the output of the command when the verification was successful, so the user knows what "good" looks like.
And the guide should show the output of the command when the cryptographic verification of the image failed, so the user knows what "ABORT: DO NOT CONTINUE" looks like.
Of course, this guide should have a infobox that says something like "Are you a developer looking to sign your published image? Click here" -- which would link to the existing documentation. But the main link should link to the docs for the user, not for the developer
What alternatives have you considered?
not sure there is an alternative
Any additional context?
I spent a lot of time clicking around the documentation, but it was too confusing. It kept writing to me like I was some sort of person publishing docker images. Sure, that documentation should exist, but it should be in the "advanced" section of the docs.
The main link should demonstrate how notation works for the user, not the developer.
Is your feature request related to a problem?
It's currently extremely confusing for people who want to
docker pullsome image to use notationWhat solution do you propose?
The main page of notation shouldn't link to a guide for how publishers can use notation to sign their images.
The main page of notation should link to a guide for how users can use notation to download and verify some existing image.
Specifically, I'm referring to the big "Get started" CTA button on this page:
...that currently links to a guide that tells me to create an OCI-compatible registry. Wut. No.
People who are looking to "get started" with notary shouldn't have to create an OCI-compatible registry. We're looking for just the bare-minimum commands to download and verify an image with notary.
I would recommend picking one very popular container that's signed with notation, and writing a as-few-commands-as-possible guide showing how to download the image.
The guide should show the output of the command when the verification was successful, so the user knows what "good" looks like.
And the guide should show the output of the command when the cryptographic verification of the image failed, so the user knows what "ABORT: DO NOT CONTINUE" looks like.
Of course, this guide should have a infobox that says something like "Are you a developer looking to sign your published image? Click here" -- which would link to the existing documentation. But the main link should link to the docs for the user, not for the developer
What alternatives have you considered?
not sure there is an alternative
Any additional context?
I spent a lot of time clicking around the documentation, but it was too confusing. It kept writing to me like I was some sort of person publishing docker images. Sure, that documentation should exist, but it should be in the "advanced" section of the docs.
The main link should demonstrate how notation works for the user, not the developer.