Skip to content

Commit e085a40

Browse files
committed
updated README and env template
1 parent 6fd8a88 commit e085a40

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

.env-template

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
AIRTABLE_PEOPLE_BASE_ID=CHANGEME
2+
AIRTABLE_RESEARCH_BASE_ID=CHANGEME
3+
AIRTABLE_EVENTS_BASE_ID=CHANGEME
14
AIRTABLE_POSTS_BASE_ID=CHANGEME
25
AIRTABLE_MITH_BASE_ID=CHANGEME
3-
AIRTABLE_API_KEY=CHANGEME
6+
AIRTABLE_TOKEN=CHANGEME

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,28 @@
33
This is the Gatsby static site for https://mith.umd.edu. It builds pages based
44
on data stored in several Airtable bases.
55

6-
## Deploy
6+
## Staging Site
77

88
Pushing to GitHub will trigger an automated GitHub action that builds the
99
staging site at:
1010

1111
https://umd-mith.github.io/mith-static/
1212

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).
1415

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).
1921

2022
## Develop
2123

2224
To build the site you will need to install a few things:
2325

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
2628

2729
Then you will need to get this repository:
2830

@@ -39,10 +41,8 @@ You will need to configure your environment so that you can fetch data from the
3941

4042
Ask a MITH team member for the correct values to add to your .env file.
4143

44+
You will also need a personal token from Airtable. Once logged in, you can generate one at https://airtable.com/create/tokens.
45+
4246
Now you are ready to start the development server:
4347

4448
npm run develop
45-
46-
[Node]: https://nodejs.org
47-
[Git]: https://git-scm.com/
48-
[mith-ansible]: https://github.com/umd-mith/mith-ansible

0 commit comments

Comments
 (0)