Skip to content

Commit 14db605

Browse files
committed
Fix Typos
1 parent b35226d commit 14db605

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/dashboard/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Displays the compliance status of repositories against the GitHub Usage Policy.
1515
- **Filter Repositories:** Allows users to filter repositories based on a range of parameters.
1616
- **Rule Presets:** Provides predefined sets of rules for quick compliance checks.
1717
- **Display Rule Details:** Shows detailed information about each rule - promoting better understanding of compliance.
18-
- **Organisation Overview:** Offers a high-level view of the organization's compliance status, including which rule is broken the most.
18+
- **Organisation Overview:** Offers a high-level view of the organisation's compliance status, including which rule is broken the most.
1919
- **Repository Details:** Provides detailed information about individual repositories, including their compliance status and the rules they violate.
2020
- **Point of Contact:** Displays the point of contact for each repository, facilitating communication regarding compliance issues.
2121

@@ -26,7 +26,7 @@ Displays the compliance status of repositories against the GitHub Usage Policy.
2626
Provides metrics on Secret Scanning alerts.
2727

2828
- **Filter Alerts:** Allows users to filter alerts based on a range of parameters.
29-
- **Organisation Overview:** Offers a high-level view of the organization's secret scanning alerts, including the oldest open alert.
29+
- **Organisation Overview:** Offers a high-level view of the organisation's secret scanning alerts, including the oldest open alert.
3030
- **Respository Proportion:** Displays the proportion of repositories with secret scanning alerts - allowing users to highlight the organisation's worst repositories.
3131
- **Alert Details:** Shows information about individual alerts, promoting users to take action on them.
3232

@@ -37,7 +37,7 @@ Provides metrics on Secret Scanning alerts.
3737
Displays metrics on Dependabot alerts.
3838

3939
- **Filter Alerts:** Allows users to filter alerts based on a range of parameters.
40-
- **Organisation Overview:** Offers a high-level view of the organization's Dependabot alerts, including the oldest open alert and worst severity.
40+
- **Organisation Overview:** Offers a high-level view of the organisation's Dependabot alerts, including the oldest open alert and worst severity.
4141
- **Severity Proportion:** Displays the proportion of alerts by severity, allowing users to focus on the most critical issues.
4242
- **Repository Overview:** Provides a high-level view of the repositories with Dependabot alerts, including the number of alerts and their severity.
4343
- **Repository Severity Proportion:** Displays the proportion of alerts by severity for each repository, allowing users to identify the most critical issues.

docs/dashboard/repository_information.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Dependabot and Secret Scanning alerts are collected from their respective GitHub
77
- **Secret Scanning**: [`GET /orgs/{org}/secret-scanning/alerts`](https://docs.github.com/en/rest/secret-scanning/secret-scanning?apiVersion=2022-11-28#list-secret-scanning-alerts-for-an-organization)
88
- **Dependabot**: [`GET /orgs/{org}/dependabot/alerts`](https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-organization)
99

10-
These endpoints list all alerts for the organization. The endpoint contains the name of the repository they belong to, but, unfortunately, does not contain the repository's visibility (public/private/internal) or if the repository is archived or not.
10+
These endpoints list all alerts for the organisation. The endpoint contains the name of the repository they belong to, but, unfortunately, does not contain the repository's visibility (public/private/internal) or if the repository is archived or not.
1111

1212
This information is important to allow users to filter alerts appropriately, for example, any public Secret Scanning alerts are much more of a risk than private ones. We want users to be able to highlight these sorts of issues.
1313

docs/dashboard/rulemap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In order to add more information about the rules applied to repositories, `rulem
66

77
## Where do the rules come from?
88

9-
All rules on the dashboard are derived from ONS' GitHub Usage Policy. This is available on Sharepoint at [GitHub Usage Policy](https://officenationalstatistics.sharepoint.com/sites/ONS_DDaT_Communities/Software%20Engineering%20Policies/Forms/AllItems.aspx?id=%2Fsites%2FONS%5FDDaT%5FCommunities%2FSoftware%20Engineering%20Policies%2FSoftware%20Engineering%20Policies%2FApproved%2FPDF%2FGitHub%20Usage%20Policy%2Epdf&parent=%2Fsites%2FONS%5FDDaT%5FCommunities%2FSoftware%20Engineering%20Policies%2FSoftware%20Engineering%20Policies%2FApproved%2FPDF) (requires ONS network access).
9+
All rules on the dashboard are derived from ONS' GitHub Usage Policy.
1010

1111
##  Format
1212

@@ -97,7 +97,7 @@ Then in `rulemap.json`, you would add:
9797
}
9898
```
9999

100-
A new check should now appear in the Dashboard under the appropriate preset.
100+
A new check should now appear in the dashboard under the appropriate preset.
101101

102102
## Changing Rule Presets
103103

0 commit comments

Comments
 (0)