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

README/FAQ: Unclear references to "the webviewer" #3986

Open
Chealer opened this issue Apr 2, 2024 · 1 comment
Open

README/FAQ: Unclear references to "the webviewer" #3986

Chealer opened this issue Apr 2, 2024 · 1 comment
Labels
kind/docs Improvements or additions to documentation

Comments

@Chealer
Copy link

Chealer commented Apr 2, 2024

The README file's View a Project's Score section contains 2 references to "the webviewer", starting with the following:

To see scores for projects regularly scanned by Scorecard, navigate to the webviewer, replacing the placeholder text with the platform, user/org, and repository name: https://securityscorecards.dev/viewer/?uri=<github_or_gitlab>.com/<user_name_or_org>/<repository_name>.

It would clarify to define what that "webviewer" is or give some clue. Referring to the FAQ's Can I preview my project's score? question/answer would help a little, but that section also refers to the webviewer without first defining it.

As there is apparently no definition for now, having "the webviewer" link to https://securityscorecards.dev/viewer/ could be a start.

By the way The strange URL/link above also shows in the README. Either the link should encompass the whole "URL", stop before the query string, or it should be removed.
@Chealer Chealer added the kind/enhancement New feature or request label Apr 2, 2024
@Chealer
Copy link
Author

Chealer commented Apr 2, 2024

This text was added following 5c93fe6. If I understand correctly, this refers to the "Scorecard result viewer" introduced in ticket #2979.

@spencerschrock spencerschrock added kind/docs Improvements or additions to documentation and removed kind/enhancement New feature or request labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants