scorecard icon indicating copy to clipboard operation
scorecard copied to clipboard

README/FAQ: Unclear references to "the webviewer"

Open Chealer opened this issue 1 year ago • 5 comments

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 avatar Apr 02 '24 02:04 Chealer

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

Chealer avatar Apr 02 '24 13:04 Chealer

This issue has been marked stale because it has been open for 60 days with no activity.

github-actions[bot] avatar Jul 11 '24 01:07 github-actions[bot]

Hello @Chealer, My team and I are interested in submitting a PR for this issue. Could you confirm if it's still open and available to work on? The team I am working on with is @kailealee @devon3583.

purpleskates123 avatar Jul 31 '25 19:07 purpleskates123

Hello @purpleskates123!

My team and I are interested in submitting a PR for this issue. Could you confirm if it's still open and available to work on?

I am far from a regular Scorecard contributor; in fact, I haven't had the time to look back at it since 2024. I do not know what you mean by "PR" and am not sure I understand your question, but if you are asking whether this is solved, I would say [only] partly. Assuming the webviewer is indeed https://scorecard.dev/viewer/, @Wavyeli32 has added a link to it via #4262, which helps tremendously.🙏 He has solved the "By the way" part at the same time.

That being said, the link's target does not contain a single sentence, and does not feature the term "webviewer", either in its contents or in the browser/tab title, so it remains unclear what the webviewer is.

By the way, I recommend changing "the following template link" to "the following URL template" in the README.

This report (including all messages and attachments I add to it) is offered under the terms of CC0 1.0.

Chealer avatar Aug 01 '25 17:08 Chealer

Hello @spencerschrock , Is this a good first issue for my team and I to work on ?

@kailealee @devon3583

purpleskates123 avatar Aug 01 '25 17:08 purpleskates123