Skip to content

Commit 9440e87

Browse files
committed
README: lead with CONTRIBUTING.md link; drop stale DNS cutover notes
1 parent 3c32ebc commit 9440e87

1 file changed

Lines changed: 6 additions & 24 deletions

File tree

README.md

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,21 @@
22

33
Static Jekyll site for [daslab.stanford.edu](https://daslab.stanford.edu).
44

5-
## Local development
5+
## For lab members: editing content
6+
7+
**See [CONTRIBUTING.md](CONTRIBUTING.md)** for step-by-step instructions on adding people, news, and publications — no command line needed.
8+
9+
## Local development (developers)
610

711
```bash
812
bundle install
913
bundle exec jekyll serve
1014
# open http://localhost:4000/
1115
```
1216

13-
## Editing content
14-
15-
Lab members can update content directly through the GitHub web UI — no command line needed:
16-
17-
- **People:** edit a file in `_people/`
18-
- **Alumni:** edit a file in `_alumni/`
19-
- **News:** add a file to `_news/` (filename: `YYYY-MM-DD-short-title.md`)
20-
- **Publications:** edit a file in `_publications/`
21-
22-
Each entry is a small markdown file with a frontmatter block at the top — copy an existing entry as a template. Save the change and the site rebuilds in ~30 seconds.
23-
2417
## Hosting
2518

26-
Deployed via GitHub Pages, built by the workflow at `.github/workflows/pages.yml`. Currently live at:
27-
28-
**https://daslab.github.io/**
29-
30-
### DNS cutover to daslab.stanford.edu (when ready)
31-
32-
Two steps, in order:
33-
34-
1. **Update DNS at Stanford.** Have Stanford IT change the CNAME (or A/AAAA records) for `daslab.stanford.edu` to point at GitHub Pages. The four GitHub Pages IPs for apex domains are: `185.199.108.153`, `185.199.109.153`, `185.199.110.153`, `185.199.111.153`. For a CNAME, point at `daslab.github.io`.
35-
2. **Add a `CNAME` file to this repo** containing exactly `daslab.stanford.edu` and push. GitHub will detect it and provision a Let's Encrypt cert automatically (give it a few minutes after DNS propagates).
36-
37-
Until DNS resolves to GitHub Pages, leave the `CNAME` file out — committing it early will make GitHub Pages redirect the staging URL to `daslab.stanford.edu`, which still points at AWS, breaking the preview.
19+
Deployed via GitHub Pages at **https://daslab.stanford.edu**, built by the workflow at `.github/workflows/pages.yml`. Every push to `main` triggers a rebuild (~30 seconds).
3820

3921
## Re-running the content scraper
4022

0 commit comments

Comments
 (0)