Skip to content

Commit aedac56

Browse files
committed
add more git instructions
1 parent af6bbae commit aedac56

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 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
@@ -20,8 +22,18 @@ git commit -m "my changes"
2022
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
2123
```
2224

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

2638
### Using hugo
2739
0. Hugo documentation: https://gohugo.io/getting-started/quick-start/
@@ -44,3 +56,4 @@ hugo server &
4456
1. Create XML export of existing WP site with all pages & posts
4557
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`
4658
3. update the `hugo.yaml` to use the correct base page (as currently not deployed on open-bio.org)
59+

0 commit comments

Comments
 (0)