Skip to content

Commit 23962ac

Browse files
committed
Add strudel production readme
1 parent a46e339 commit 23962ac

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# STRUDEL Website: Production
2+
3+
This repo houses the production build of the strudel website. The build files are copied over from the [strudel-web](https://github.com/strudel-science/strudel-web) repo into the `public` directory of this repo.
4+
5+
:exclamation: DO NOT edit the code in the `public` directory of this repo.
6+
7+
## Deploying
8+
9+
### 1. Go to the strudel-web repo page on GitHub
10+
11+
The code for the production website is handled by the [strudel-web](https://github.com/strudel-science/strudel-web) repo. From there you will run a GitHub action to copy the website build files into this repo.
12+
13+
### 2. Run the production deployment workflow
14+
15+
If the staging website looks good ([strudel.science/strudel-web](https://strudel.science/strudel-web/)), go to the [actions page for the Copy Build to Production Repo workflow](https://github.com/strudel-science/strudel-web/actions/workflows/prod.yml). Click the "Run workflow" dropdown, ensure that the `main` branch is selected, then click the "Run workflow" button. This will create build files for the website and copy them to the [strudel-science.github.io](https://github.com/strudel-science/strudel-science.github.io) repo. This will automatically trigger a new deployment to the production website at https://strudel.science.
16+
17+
### 3. Confirm your changes on the production website
18+
19+
Go to the the production website at https://strudel.science and confirm that everything looks as expected.
20+
21+
You're done!

0 commit comments

Comments
 (0)