Skip to content

Commit 4fbd9a8

Browse files
Anil KommareddiCopilot
andcommitted
Add README with deployment instructions and outstanding TODOs
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a8b892c commit 4fbd9a8

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# opensourcerisk.org — GitHub Pages
2+
3+
Static site migration of [opensourcerisk.org](https://www.opensourcerisk.org/) from WordPress to GitHub Pages.
4+
5+
## How it works
6+
7+
- The site is a static HTML export generated via the [Simply Static](https://wordpress.org/plugins/simply-static/) WordPress plugin.
8+
- On every push to `main`, GitHub Actions deploys the site to GitHub Pages (see `.github/workflows/deploy.yml`).
9+
- The custom domain `www.opensourcerisk.org` is configured via the `CNAME` file.
10+
11+
## DNS cutover (when ready to go live)
12+
13+
Point `www.opensourcerisk.org` to GitHub Pages by updating your DNS records:
14+
15+
| Type | Name | Value |
16+
|-------|------|------------------------|
17+
| A | @ | 185.199.108.153 |
18+
| A | @ | 185.199.109.153 |
19+
| A | @ | 185.199.110.153 |
20+
| A | @ | 185.199.111.153 |
21+
| CNAME | www | opensourcerisk.github.io |
22+
23+
Once DNS has propagated and the site is confirmed live, decommission the old WordPress server.
24+
25+
---
26+
27+
## TODO
28+
29+
### Push to GitHub
30+
1. Create a new repo under [github.com/OpenSourceRisk](https://github.com/OpenSourceRisk)
31+
2. In the repo settings, enable **Pages → Source: GitHub Actions**
32+
3. Run:
33+
```bash
34+
git remote add origin https://github.com/OpenSourceRisk/<repo-name>.git
35+
git push -u origin main
36+
```
37+
38+
### DNS cutover and old server shutdown
39+
- Update DNS A records (see table above) to point `www.opensourcerisk.org` to GitHub Pages
40+
- Verify the site is live, then decommission the old WordPress server
41+
42+
### Migrate large videos to external hosting
43+
- `wp-content/uploads/2020/09/ORE_XML_Introduction_August2020.mp4` is 59MB (GitHub recommends files under 50MB)
44+
- Upload to YouTube or Vimeo and replace the `<video>` / `<source>` tag in the relevant HTML pages with an embed
45+
46+
### Migrate forum (bbpress) to a hosted alternative
47+
- Forum reply forms do not work on static hosting — the archived topics are readable but users cannot post
48+
- Options:
49+
- [GitHub Discussions](https://docs.github.com/en/discussions) — free, integrates with the repo
50+
- [Discourse](https://www.discourse.org/) — self-hosted or hosted forum
51+
- Leave as read-only archive and add a notice pointing to the new forum
52+
53+
### Migrate contact/feedback form
54+
- The Contact Form 7 form on `/feedback/` did not render in the static export (shows as a raw shortcode)
55+
- Replace with a static-compatible form service:
56+
- [Formspree](https://formspree.io/) — easy drop-in replacement
57+
- [Netlify Forms](https://www.netlify.com/products/forms/) — if migrating to Netlify
58+
- [EmailJS](https://www.emailjs.com/) — client-side email sending

0 commit comments

Comments
 (0)