Merge pull request #17 from secure-dashboards/feat/improve-automation

Author: UlisesGascon

README.md

@@ -1,6 +1,6 @@
 # OpenJS Security Program Standards
 
-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.
+This repo contains the source code and infra used to build and the deploy the website: https://openjs-security-program-standards.netlify.app/.
 
 ## Website
 
@@ -38,20 +38,22 @@ This command generates static content into the `build` directory and can be serv
 
 ## Manage Changes
 
+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.
+
 
 ### Update the compliance checks
 
 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)
 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.
 
-### Update the website
+### Manual update
 
-Once you have updated the items, you can update the website by running the following commands:
+Once you have updated the [data/checks.json](/data/checks.json) file, you can update the website by running the following commands:
 
 ```bash
 npm run populate-details
 npm run populate-implementations
 ```
 
-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.
+This will autopolulate the details and implementations sections of the website, respectively. So make sure to commit the changes.