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.

Sign up for GitHub

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

📖 Add gitlab links to viewer example #3494

Merged
merged 3 commits into from
Sep 19, 2023
+10 −5
Merged

📖 Add gitlab links to viewer example #3494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69da704
Update README.md
olivekl Sep 19, 2023
64b74aa
Update faq.md
olivekl Sep 19, 2023
811f403
Merge branch 'main' into olivekl-add-gitlab-links
spencerschrock Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,12 @@ metrics. Prominent projects that use Scorecard include:

### View a Project's Score

To see scores for the one million GitHub projects regually scanned by Scorecard, navigate to the Webviewer, replacing the placeholder text with the user/org and repository name:
https://securityscorecards.dev/viewer/?uri=github.com/<user_name_or_org>/<repository_name>.
To see scores for projects regually 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>.

For example: [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard).
For example:
- [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard)
- [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient)

To view scores for projects not included in the webviewer, use the [Scorecard CLI](#scorecard-command-line-interface).

Expand Down
7 changes: 5 additions & 2 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,11 @@ This page answers frequently asked questions about Scorecard, including its purp

Yes.

Over a million projects are automatically tracked by the Scorecard project. View these scores with the Scorecard Webviewer, replacing the placeholder text with the user/org and repository name:
https://securityscorecards.dev/viewer/?uri=github.com/<user_name_or_org>/<repository_name>.
Over a million projects are automatically tracked by the Scorecard project. Use the webviewer to see these scores, 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>.

For example:
- [https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard](https://securityscorecards.dev/viewer/?uri=github.com/ossf/scorecard)
- [https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient](https://securityscorecards.dev/viewer/?uri=gitlab.com/fdroid/fdroidclient)

You can also use the CLI to generate scores for any public repository by following these steps:

Expand Down
Loading