Skip to content

docs: verify azure cmd doc updates#545

Merged
akashsinghal merged 10 commits intonotaryproject:mainfrom
cse-labs:josh/75-user-docs
Jan 17, 2023
Merged

docs: verify azure cmd doc updates#545
akashsinghal merged 10 commits intonotaryproject:mainfrom
cse-labs:josh/75-user-docs

Conversation

@joshuaphelpsms
Copy link
Contributor

Description

What this PR does / why we need it:

This updates docs/examples/ratify-verify-azure-cmd.md to work with the latest ratify changes as well as notation RC1.

  • updates the notation version to RC1
  • cleans up formatting and installs for consistency
  • updates SBOM artifact type to org.example.sbom.v0
  • fixes config policy in the Demo 2 by removing org.example.sbom.v0
  • updates verification certs in config to path ~/.config/notation/truststore for consistency (previously, it specified different paths for each demo)

NOTES:

  1. This doc currently instructs the user to use Ratify v1.0.0-beta.2 as RC1 has not been released yet. We should update this when RC1 is released

  2. When feat: update sbom verifier #536 gets merged we should update this doc to use the sbom-tool and update the media type of the sbom accordingly.

Type of change

Please delete options that are not relevant.

  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Manual testing. Ran through the doc from scratch and it works as expected

@binbin-li
Copy link
Contributor

thanks for making the doc update. Notation rc.2 seems coming soon, I wonder if you want to wait for it.

@joshuaphelpsms joshuaphelpsms marked this pull request as ready for review January 13, 2023 17:19
@joshuaphelpsms
Copy link
Contributor Author

joshuaphelpsms commented Jan 13, 2023

thanks for making the doc update. Notation rc.2 seems coming soon, I wonder if you want to wait for it.

No problem if you want to wait. I am also happy to come back with a follow up PR once Notation rc.2 lands. Just curious do you know what date Notation rc.2 will be released?

@akashsinghal akashsinghal changed the title verify azure cmd doc updates docs: verify azure cmd doc updates Jan 13, 2023
@binbin-li
Copy link
Contributor

thanks for making the doc update. Notation rc.2 seems coming soon, I wonder if you want to wait for it.

No problem if you want to wait. I am also happy to come back with a follow up PR once Notation rc.2 lands. Just curious do you know what date Notation rc.2 will be released?

RC.2 might be delayed to Feb. 6. I feel it's OK to merge it now since we're not urgent to bump up notation to RC.2.

Copy link
Collaborator

@akashsinghal akashsinghal left a comment

Choose a reason for hiding this comment

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

LGTM . Thanks for reviewing the comments

@akashsinghal
Copy link
Collaborator

@joshuaphelpsms could you merge latest changes from main?

@joshuaphelpsms
Copy link
Contributor Author

@joshuaphelpsms could you merge latest changes from main?

@akashsinghal Just merged

@akashsinghal akashsinghal merged commit 0dc8ad6 into notaryproject:main Jan 17, 2023
bspaans pushed a commit to bspaans/ratify that referenced this pull request Oct 17, 2023
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