Skip to content
This repository was archived by the owner on Jan 20, 2025. It is now read-only.

Commit 8187ece

Browse files
committed
docs: update documentation with the new workflows
1 parent b938944 commit 8187ece

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenJS Security Program Standards
22

3-
This Standard is designed to serve as an achievable minimum security baseline for OpenJS Foundation Project maintainers. More plainly said, this is intended to be used as an easily digested and actioned security checklist.
3+
This repo contains the source code and infra used to build and the deploy the website: https://openjs-security-program-standards.netlify.app/.
44

55
## Website
66

@@ -38,20 +38,22 @@ This command generates static content into the `build` directory and can be serv
3838

3939
## Manage Changes
4040

41+
Most of the content of this website is autogenerated with Github Actions, this include the content from [docs/implementations](/docs/implementations) and [docs/details](/docs/details) files.
42+
4143

4244
### Update the compliance checks
4345

4446
1. Go to [Actions: Sync and update Compliance Checks](https://github.com/secure-dashboards/openjs-security-program-standards/actions/workflows/sync_checks.yml) and run the action manually from the `main` branch. [how-to](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow)
4547
2. This will generate a PR with the title `[AUTO] Sync with dashboard database` and it will assign it to you ([direct access](https://github.com/secure-dashboards/openjs-security-program-standards/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen++%5BAUTO%5D+Sync+with+dashboard+database+)). Please review the content and merge it when you feel ready.
4648

47-
### Update the website
49+
### Manual update
4850

49-
Once you have updated the items, you can update the website by running the following commands:
51+
Once you have updated the [data/checks.json](/data/checks.json) file, you can update the website by running the following commands:
5052

5153
```bash
5254
npm run populate-details
5355
npm run populate-implementations
5456
```
5557

56-
This will autopolulate the details and implementations sections of the website, respectively. Note that this will modify the folders `docs/details` and `docs/implementations` so make sure to commit the changes.
58+
This will autopolulate the details and implementations sections of the website, respectively. So make sure to commit the changes.
5759

docs/details/githubOrgMFA.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ slug: /details/githubOrgMFA
1616

1717
Multi Factor Authentication (MFA) Enforced Across the Github Organization
1818

19+
## Dashboard Inclusion
20+
21+
We use the field `two_factor_requirement_enabled` from the GitHub Organization API to check if the project has enforced this policy. [More information](https://github.com/secure-dashboards/openjs-foundation-dashboard/issues/43)
22+
1923
## Details
2024
- Implementation Status: completed
2125
- Implementation Details: It is computed ([details](https://github.com/secure-dashboards/openjs-foundation-dashboard/issues/43)).

0 commit comments

Comments
 (0)