Skip to content

Commit 585f8bd

Browse files
authored
Merge pull request #10 from nlharris/2025-02-09
2025 02 09
2 parents af6bbae + ca2821a commit 585f8bd

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Migration of the OBF WP site to a static site generator (Hugo)
55
## Running hugo server locally
66

77
### Setting up a GitHub fork so you can make changes on your desktop
8+
(Instructions for those who are not git gurus)
9+
810
1. To make changes to web pages on your desktop and commit them from the command line to GH, you will need a
911
[GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
1012
2. Go to https://github.com/OBF/OBF.github.io and make a fork
@@ -14,14 +16,25 @@ git clone https://github.com/YOUR_GITHUB_ID/OBF.github.io
1416
```
1517
4. After you edit files on your desktop as desired, do:
1618
```
19+
cd OBF.github.io
1720
git checkout -b BRANCH_NAME
1821
git add FILES
1922
git commit -m "my changes"
2023
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
2124
```
2225

23-
4. Then go to https://github.com/YOUR_GITHUB_ID/OBF.github.io to make a PR
24-
5. Once the PR is merged, your changes should be visible on [https://obf.github.io/](https://obf.github.io/)
26+
5. Then go to https://github.com/YOUR_GITHUB_ID/OBF.github.io to make a PR
27+
6. Once the PR is merged, your changes should be visible on
28+
[https://obf.github.io/](https://obf.github.io/)
29+
30+
8. Next time you want to make more changes, first update your local
31+
copy to pull in any changes others may have committed:
32+
```
33+
git checkout main
34+
git pull
35+
```
36+
Then do the steps in #4 (with a new branch name) to commit your changes.
37+
2538

2639
### Using hugo
2740
0. Hugo documentation: https://gohugo.io/getting-started/quick-start/
@@ -44,3 +57,4 @@ hugo server &
4457
1. Create XML export of existing WP site with all pages & posts
4558
2. Run the conversion script [wp2hugo](https://github.com/ashishb/wp2hugo) in the following way `/wp2hugo -source obf.WordPress.2025-01-30.xml -output obf-test-hugo -download-media -continue-on-media-download-error`
4659
3. update the `hugo.yaml` to use the correct base page (as currently not deployed on open-bio.org)
60+

0 commit comments

Comments
 (0)