Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
task(README): PR comment resolution
Browse files Browse the repository at this point in the history
  • Loading branch information
VWSCoronaDashboard30 committed May 10, 2024
1 parent 34fbd68 commit a8fb6b6
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 4 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# NL Coronavirus Dashboard
# Archived NL Coronavirus Dashboard

` As of 02-04-2024, the Coronadashboard has been brought offline, so some of the sections are not relevant anymore.`

The dashboard provides information on the outbreak and prevalence of COVID-19 in
The Netherlands. It combines measured and modelled data from various sources to
give a broad perspective on the subject.

## Contact

` As of 02-04-2024, the Coronadashboard has been brought offline. This section is not applicable anymore.`

~~If you want to contact the dashboard team, feel free to open an issue for
technical questions, bug reports, or security findings. If you have a generic question or remark about the
corona policy of the Dutch government, please consult the [frequently asked questions](https://coronadashboard.rijksoverheid.nl/veelgestelde-vragen) or [contact page](https://coronadashboard.rijksoverheid.nl/contact) on the dashboard.~~

## Development & Contribution process

` As of 02-04-2024, the Coronadashboard has been brought offline. This section is not applicable anymore.`

~~The core team works directly from this open-source repository. If you plan to
propose changes, we recommend opening an issue beforehand where we can discuss
your planned changes. This increases the chance that we might be able to use
Expand Down
4 changes: 3 additions & 1 deletion docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Shortcut scripts

~~The monorepo contains projects which the developer can access with shortcut scripts at the root of the project. Instead of writing the path in the CLI like `yarn workspace @corona-dashboard cms lokalize:import`, we can access the script by writing `yarn cms:lokalize-import` to bring your local JSON files up-to-date with the Sanity dataset. Another example is using `yarn build:app` instead of `yarn workspace @corona-dashboard/app build` to make a build during the release procedure. Lastly, running `yarn check-all` will make sure the code, data and tests work as expected, instead of running scripts individually.~~
` As of 02-04-2024, the Coronadashboard has been brought offline. Some parts of this section are not applicable anymore.`

~~The monorepo contains projects which the developer can access with shortcut scripts at the root of the project. Instead of writing the path in the CLI like `yarn workspace @corona-dashboard cms lokalize:import`, we can access the script by writing `yarn cms:lokalize-import` to bring your local JSON files up-to-date with the Sanity dataset.~~ An example is using `yarn build:app` instead of `yarn workspace @corona-dashboard/app build` to make a build during the release procedure. Lastly, running `yarn check-all` will make sure the code, data and tests work as expected, instead of running scripts individually.

Available shortcut scripts:

Expand Down
12 changes: 11 additions & 1 deletion docs/lokalize-texts.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,12 @@ fallback.~~
~~After syncing texts, the import script is called to update your local JSON file
and re-generate the SiteText type interface.~~

~~The Sanity Lokalize dataset will remain immutable with the archival of the application.~~
The Sanity Lokalize dataset will remain immutable with the archival of the application.

### **DEPRECATED** Delete/Move Mutations

` As of 02-04-2024, the Coronadashboard has been brought offline, so some sections of this chapter are no longer relevant.`

Because feature branches plus the development deployment all use the same Sanity
dataset, we can not simply remove a lokalize text document from the dataset
without potentially breaking other branches.
Expand All @@ -161,6 +163,8 @@ history and drafts.

### **DEPRECATED** Flow to Production

` As of 02-04-2024, the Coronadashboard has been brought offline, so this chapter is no longer relevant.`

Texts are first added to the development dataset. When the feature branch gets
merged, a GitHub action will inject any new texts into the production dataset
and flag them as being new.
Expand All @@ -170,6 +174,8 @@ prepare them for an upcoming release.

## **DEPRECATED** Sync After Feature

` As of 02-04-2024, the Coronadashboard has been brought offline, so this chapter is no longer relevant.`

The `sync-after-feature` command is triggered automatically by a GitHub Action
whenever a feature branch is merged to the develop branch. It contains the
following logic:
Expand All @@ -188,6 +194,8 @@ merged, those deletions will propagate to production after the release using the

## **DEPRECATED** Sync After Release

` As of 02-04-2024, the Coronadashboard has been brought offline, so this chapter is no longer relevant.`

The `sync-after-release` command should be triggered manually shortly after a
release has been deployed to production. It can not really hurt to forget to run
it, but it _can break the production build_ when it is triggered at the wrong
Expand Down Expand Up @@ -217,6 +225,8 @@ production set and block the deployment.

## **DEPRECATED** Sync Texts From Production

` As of 02-04-2024, the Coronadashboard has been brought offline, so this chapter is no longer relevant.`

Because in the development dataset we typically inject a lot of placeholder
texts, running the app locally doesn't always give a good impression of what it
would look like on production. For this reason we have a script that copies over
Expand Down
2 changes: 2 additions & 0 deletions docs/release-procedure.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# **DEPRECATED** Release Procedure

` As of 02-04-2024, the Coronadashboard has been brought offline, so this chapter is no longer relevant.`

## Sprint Release

1. Create a branch called `release/x.xx.0` based on `master`(\*).
Expand Down
4 changes: 3 additions & 1 deletion packages/app/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ARCHIVED NL Coronavirus Dashboard - App

` As of 02-04-2024, the Coronadashboard has been brought offline, so this file is no longer relevant.`

The main application that contains the front-end part of the dashboard. This
React application uses Next.js as its framework.

Expand All @@ -17,7 +19,7 @@ cp packages/app/.env.local.example packages/app/.env.local

Then from the repository root you can run:

1. `yarn download` - ~~Downloads latest data~~ The latest production protos have been added to the repository. The user is not required to download them.
1. ~~`yarn download` - Downloads latest data~~ The latest production protos have been added to the repository. The user is not required to download them.
2. `yarn bootstrap` - Downloads / builds all other requirements
3. `yarn dev` - Starts the development server

Expand Down

0 comments on commit a8fb6b6

Please sign in to comment.