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

Alpha.1 release updates #111

Merged
merged 15 commits into from
Oct 21, 2021

Conversation

SteveLasker
Copy link
Contributor

Updates the docs for Alpha.1

@SteveLasker SteveLasker requested a review from a team October 20, 2021 20:59
Signed-off-by: Steve Lasker <[email protected]>
@@ -64,7 +70,8 @@ This project is covered under the Apache 2.0 license. You can read the license [

=======

[notation-releases]: https://github.com/shizhMSFT/notation/releases/tag/v0.5.0
[notation-releases]: https://github.com/notaryproject/notation/releases/tag/v0.7.0-alpha.1
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we point to this specific notation release, or to the generic release folder https://github.com/notaryproject/notation/releases to keep it compatible with future churns?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had a similar thought. Future churns will have commands that reference new releases. So, I kept the link to the specific release to assure folks don't get broken between releases.

@iamsamirzon
Copy link
Contributor

A generic comment on using the --plain-http flag with notation. Is that optional or mandatory for alpha.1 ? If mandatory, should it also be added with the below snippet in the Quick Start section of the Readme.MD ?

notation sign $IMAGE
notation list $IMAGE 
notation verify $IMAGE

@iamsamirzon
Copy link
Contributor

LGTM, provided the above comments are addressed

@SteveLasker
Copy link
Contributor Author

Thanks @iamsamirzon,
--plain-http is required if you don't configure insecure registries in the config file. I've captured the issue here: #95
The feedback for the root readme was to keep it as super simple as possible. The hello-signing doc goes into the detailed steps with descriptions

@SteveLasker SteveLasker changed the title Alpha.1 release notes Alpha.1 release updates Oct 21, 2021
Copy link
Contributor

@sajayantony sajayantony left a comment

Choose a reason for hiding this comment

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

Approved updates after rebase.

@SteveLasker SteveLasker merged commit fe4c9f9 into notaryproject:main Oct 21, 2021
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.

3 participants