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

Document how to manually create trust policy for RC1 first run experience #84

Closed
toddysm opened this issue Nov 8, 2022 · 7 comments
Closed
Milestone

Comments

@toddysm
Copy link
Contributor

toddysm commented Nov 8, 2022

For RC1 we don't have good experience to create trust policy even for the test scenario notation cert generate-test. We should document the manual steps to create policy for the test cert and place it in the correct place depending on the OS folder structure.

CC:// @zr-msft

@toddysm toddysm added this to the RC-1 milestone Nov 8, 2022
@vaninrao10
Copy link

@toddysm - Can you please add few scenarios so the documentation covers those user experience. Once we establish the expectation from RC-1 and document the user scenarios described in our meeting, it will help our team to accurately narrate it in the documentation.

@toddysm
Copy link
Contributor Author

toddysm commented Nov 8, 2022

I believe the agreement here was to just document the manual creation of the policy for the test cert as part of the first run experience. We will document the scenarios in notaryproject/notation#438

@yizha1
Copy link
Contributor

yizha1 commented Nov 10, 2022

@toddysm should we improve the quick start https://notaryproject.dev/docs/quickstart/?

@yizha1
Copy link
Contributor

yizha1 commented Nov 10, 2022

@toddysm @dtzar How about creating a document of FAQ for user to easily configure trust policies?

  • Why do I need to configure a trust policy?
  • How do I create multiple policies for different repositories?
  • How do I apply a policy for multiple repositories?
  • How do I trust any signing certificates?
  • How do I trust specific signing certificates?
  • How do I apply trust policy for all artifacts?
  • Can I use asterisk character * in a repository URI?
  • more...

@zr-msft
Copy link
Collaborator

zr-msft commented Nov 10, 2022

@yizha1 @toddysm I think we should keep the current quickstart and create an additional guide/quickstart with this flow. They both have value

@zr-msft
Copy link
Collaborator

zr-msft commented Nov 10, 2022

@toddysm @dtzar How about creating a document of FAQ for user to easily configure trust policies?

  • Why do I need to configure a trust policy?

  • How do I create multiple policies for different repositories?

  • How do I apply a policy for multiple repositories?

  • How do I trust any signing certificates?

  • How do I trust specific signing certificates?

  • How do I apply trust policy for all artifacts?

  • Can I use asterisk character * in a repository URI?

  • more...

We can create content on all of the above, but I don't think an FAQ is a good fit for everything.

FAQ guides tend to work best when they answer questions and provide context, not necessarily telling a user how to do something.

These are good FAQ questions:

  • Why do I need to configure a trust policy?
  • Can I use asterisk character * in a repository URI?

Everything else would work better as part of a how-to guide.

@toddysm
Copy link
Contributor Author

toddysm commented Nov 10, 2022

@yizha1 I think the current quick guide https://notaryproject.dev/docs/quickstart/ is good enough. Few comments about it though:

  • @zr-msft I believe there are some grammatical and misspelling mistakes, can you proof-read?
  • Should this be after the installation guide in the navigation?
  • @yizha1 do we need the following:

For users want to enable trust policy for specific repositories, set the registryScopes as following

registryScopes": [ 
    "localhost:5000/net-monitor",
    "localhost:5000/nginx",
    "localhost:5000/hello-world"
]

zr-msft added a commit to zr-msft/notaryproject.dev that referenced this issue Nov 29, 2022
Signed-off-by: Zach Rhoads <[email protected]>
FeynmanZhou added a commit that referenced this issue Dec 5, 2022
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

No branches or pull requests

4 participants