Merge pull request #33 from regulatorystudies/update_documentation
Browse files
README.md
CHANGED
|
@@ -17,7 +17,7 @@ Dashboard app tracking rules falling within the Congressional Review Act (CRA) w
|
|
| 17 |
|
| 18 |
**[Direct link to deployed dashboard](https://regulatorystudies-cra-window-rules.hf.space/)**
|
| 19 |
|
| 20 |
-
**[Link to
|
| 21 |
|
| 22 |
Developed by the [GW Regulatory Studies Center](https://go.gwu.edu/regstudies).
|
| 23 |
|
|
@@ -31,3 +31,10 @@ This information may be valuable for different stakeholders in different ways:
|
|
| 31 |
2. Advocacy groups might want to know how to advocate for or against such policies;
|
| 32 |
3. Federal policymakers can have a better sense of what policies may or may not carry over given a change in administration;
|
| 33 |
4. Journalists may want to focus on what highly salient policies might be reversed depending on the results of the election. They also may want to know more broadly how many rules fall into the window and from which agencies.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
**[Direct link to deployed dashboard](https://regulatorystudies-cra-window-rules.hf.space/)**
|
| 19 |
|
| 20 |
+
**[Link to Hugging Face Space that hosts the dashboard app.](https://huggingface.co/spaces/regulatorystudies/cra-window-rules)**
|
| 21 |
|
| 22 |
Developed by the [GW Regulatory Studies Center](https://go.gwu.edu/regstudies).
|
| 23 |
|
|
|
|
| 31 |
2. Advocacy groups might want to know how to advocate for or against such policies;
|
| 32 |
3. Federal policymakers can have a better sense of what policies may or may not carry over given a change in administration;
|
| 33 |
4. Journalists may want to focus on what highly salient policies might be reversed depending on the results of the election. They also may want to know more broadly how many rules fall into the window and from which agencies.
|
| 34 |
+
|
| 35 |
+
## Deployment
|
| 36 |
+
The dashboard is currently deployed and hosted using [Hugging Face spaces](https://huggingface.co/spaces). Two Github workflows are set to support the deployment:
|
| 37 |
+
- **Sync to Hugging Face hub**: All changes pushed to the main branch of this Github repository will be automatically synced to the Hugging Face space and reflected in the dashboard.
|
| 38 |
+
- Github Action files: `.github/main.yml` and `.github/check.yml`
|
| 39 |
+
- **Restart Hugging Face space**: The Hugging Face space is restarted automatically at 7 AM Eastern Time Monday through Friday to ensure that the dashboard fetches the current-day data from the Federal Register (which is typically updated by 6 AM on a weekday, except federal holidays).
|
| 40 |
+
- Github Action files: `.github/actions.yml`
|