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

Improve notation download and installation instructions #83

Closed
toddysm opened this issue Nov 7, 2022 · 7 comments · Fixed by #93
Closed

Improve notation download and installation instructions #83

toddysm opened this issue Nov 7, 2022 · 7 comments · Fixed by #93
Assignees
Milestone

Comments

@toddysm
Copy link
Contributor

toddysm commented Nov 7, 2022

The only installation experience that Notation currently has is for users to download the binary and manually copy to the appropriate folder on their machine. At a minimum, we need to provide the right instructions how to download, verify the binaries, and the correct places to copy the binaries for various operating systems.

Starting a HackMD spec for that on https://hackmd.io/@toddysm/SJhUuI7Bi

Related information is available in https://github.com/notaryproject/notation/blob/main/specs/directory.md

@zr-msft to prepare an article

@zr-msft
Copy link
Collaborator

zr-msft commented Nov 7, 2022

thanks @toddysm feel free to assign to me

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

zr-msft commented Nov 9, 2022

@FeynmanZhou @shizhMSFT @yizha1

are NOTATION_LIBEXEC, NOTATION_CONFIG, and NOTATION_CACHE directories created automatically after the CLI binary installed and executed? Do users need to set those environment variables or is it optional?

zr-msft added a commit to zr-msft/notaryproject.dev that referenced this issue Nov 9, 2022
Signed-off-by: Zach Rhoads <[email protected]>
@FeynmanZhou
Copy link
Member

@FeynmanZhou @shizhMSFT @yizha1

are NOTATION_LIBEXEC, NOTATION_CONFIG, and NOTATION_CACHE directories created automatically after the CLI binary installed and executed? Do users need to set those environment variables or is it optional?

@zr-msft
In general, notation cert add will create ~/.config/notation/truststore so users don't need to create NOTATION_LIBEXEC, NOTATION_CONFIG after they add a cert using Notation.

NOTATION_CACHE was desecrated in Beta.1 so we can ignore it.

We are updating and migrating this guide from notation repo to the website repo, you can find the updated version here.

@zr-msft
Copy link
Collaborator

zr-msft commented Nov 10, 2022

Thank you @FeynmanZhou

I'll review/sign-off the linked PR and wait for merge to update my PR.

zr-msft added a commit to zr-msft/notaryproject.dev that referenced this issue Nov 10, 2022
Signed-off-by: Zach Rhoads <[email protected]>
@zr-msft
Copy link
Collaborator

zr-msft commented Nov 10, 2022

I'll need to make updates after #80 is merged. @FeynmanZhou @toddysm @dtzar you're welcome to merge now and I'll do a fast follow PR, otherwise will updated after #80 is merged.

@dtzar
Copy link
Contributor

dtzar commented Nov 10, 2022

Merged @zr-msft

zr-msft added a commit to zr-msft/notaryproject.dev that referenced this issue Nov 10, 2022
Signed-off-by: Zach Rhoads <[email protected]>
@zr-msft
Copy link
Collaborator

zr-msft commented Nov 10, 2022

thank you @dtzar for merging. PR is updated to include links to new docs for more details on notation config

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 a pull request may close this issue.

4 participants