README/FAQ: Unclear references to "the webviewer"
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with the README.md “View a Project's Score” section and the linked docs/faq.md “Can I preview my project's score?” section. Review the references to “the webviewer” and the displayed URL, then update the wording or links so the viewer is defined and the URL is presented clearly in both places.
Written by the indexing model from the issue text.
Description
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.- Dominant language
- Go
- Stars
- 5.7k
- Forks
- 723
- Avg merge
- 19h 30m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ossf/scorecard
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
kind/enhancement needs triage Stale
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100