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

Invalid link in notation login error message #783

Closed
Wwwsylvia opened this issue Sep 14, 2023 · 3 comments · Fixed by notaryproject/notaryproject.dev#375
Closed

Invalid link in notation login error message #783

Wwwsylvia opened this issue Sep 14, 2023 · 3 comments · Fixed by notaryproject/notaryproject.dev#375
Assignees
Labels
bug Something isn't working
Milestone

Comments

@Wwwsylvia
Copy link
Contributor

What is not working as expected?

The troubleshooting link in the error message of notation login is not working (404 Not Found).

Error: failed to log in to docker.io: the credential could not be saved because a credentials store is required to securely store the password. See https://notaryproject.dev/docs/how-to/registry-authentication/

Looks like the corresponding page has been moved to https://notaryproject.dev/docs/user-guides/how-to/registry-authentication/.

What did you expect to happen?

The error message should be updated with the correct link.

How can we reproduce it?

Run notation login on a Linux machine with no credentials store installed.

Describe your environment

Notation installation method : wget
OS version: Ubuntu 18.04.4 LTS (WSL)
Shell type: Bash on Windows

What is the version of your Notation CLI or Notation Library?

Version: 1.0.0
Go version: go1.20.7
Git commit: 80e3fc4

@Wwwsylvia Wwwsylvia added bug Something isn't working triage Need to triage labels Sep 14, 2023
@FeynmanZhou FeynmanZhou removed the triage Need to triage label Sep 19, 2023
@FeynmanZhou FeynmanZhou self-assigned this Sep 19, 2023
@FeynmanZhou FeynmanZhou added this to the 1.1.0 milestone Sep 19, 2023
@FeynmanZhou
Copy link
Member

I will investigate a redirection solution for this broken link.

@priteshbandi
Copy link
Contributor

IMO we should avoid adding link in CLI and instead maintain error message FAQ in the https://notaryproject.dev/ website. This way we can update/archive FAQ without much effort

@yizha1 yizha1 moved this from Todo to In Progress in Notary Project Planning Board Jan 2, 2024
@FeynmanZhou
Copy link
Member

FeynmanZhou commented Jan 2, 2024

@priteshbandi Thanks for your advice. From my observation, the common practice is to use versioned URL in the CLI/GUI. The root cause of this issue is the Notary Project website lacks of version control so we can't use a versioned permanent doc link in CLI.
We are working on supporting version control in the the Notary Project website notaryproject/notaryproject.dev#350.

Does this make sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants