You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -3,26 +3,28 @@
3
3
This is the Gatsby static site for https://mith.umd.edu. It builds pages based
4
4
on data stored in several Airtable bases.
5
5
6
-
## Deploy
6
+
## Staging Site
7
7
8
8
Pushing to GitHub will trigger an automated GitHub action that builds the
9
9
staging site at:
10
10
11
11
https://umd-mith.github.io/mith-static/
12
12
13
-
## Release
13
+
The staging site can also be updated manually (for example to show the latest changes on Airtable)
14
+
by triggering the Action [Publish Staging Site on GitHub Pages](https://github.com/umd-mith/mith-static/actions/workflows/staging.yml).
14
15
15
-
There is also an scheduled cron job which will deploy tagged releases that have
16
-
been added to the Releases Airtable table. This job is contained here in the
17
-
`npm run release` command, and is setup using the Ansible playbook in
18
-
[mith-ansible].
16
+
## Publish
17
+
18
+
To publish the website at https://mith.umd.edu, trigger the Action [Build and Publish Site](https://github.com/umd-mith/mith-static/actions/workflows/publish.yml).
19
+
20
+
You may also build the site locally and `rsync` the built site if you have the right permissions; there is an Ansible playbook to help you set up access at [mith-ansible](https://github.com/umd-mith/mith-ansible).
19
21
20
22
## Develop
21
23
22
24
To build the site you will need to install a few things:
23
25
24
-
*[Node]: a JavaScript programming environment
25
-
*[Git]: version control software
26
+
*[Node](https://nodejs.org): a JavaScript programming environment
27
+
*[Git](https://git-scm.com/): version control software
26
28
27
29
Then you will need to get this repository:
28
30
@@ -39,10 +41,8 @@ You will need to configure your environment so that you can fetch data from the
39
41
40
42
Ask a MITH team member for the correct values to add to your .env file.
41
43
44
+
You will also need a personal token from Airtable. Once logged in, you can generate one at https://airtable.com/create/tokens.
45
+
42
46
Now you are ready to start the development server:
0 commit comments