Skip to content

Commit dd382c9

Browse files
authored
reorganize and update instructions
1 parent 61569d1 commit dd382c9

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

README.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,38 @@ Migration of the OBF WP site to a static site generator (Hugo)
44

55
## Running hugo server locally
66

7-
1. [Install hugo](https://gohugo.io/installation/)
8-
2. Clone the GH repo:
7+
### Setting up a GitHub fork so you can make changes on your desktop
8+
1. To make changes to web pages on your desktop and commit them from the command line to GH, you will need a
9+
[GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
10+
2. Go to https://github.com/OBF/OBF.github.io and make a fork
11+
3. Then on your desktop (from the shell) do:
12+
```
13+
git clone https://github.com/YOUR_GITHUB_ID/OBF.github.io
914
```
10-
git clone https://github.com/OBF/OBF.github.io
15+
4. After you edit files on your desktop as desired, do:
16+
```
17+
git checkout -b BRANCH_NAME
18+
git add FILES
19+
git commit -m "my changes"
20+
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
1121
```
12-
3. Initialize hugo
22+
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+
26+
### Using hugo
27+
1. [Install hugo](https://gohugo.io/installation/)
28+
2. Initialize hugo
1329
```
14-
cd OBF.github.io
1530
git submodule init
1631
git submodule update
1732
```
18-
4. Run `hugo server` from the root folder of the project to get a
19-
local server that automatically rebuilds:
33+
4. Run `hugo server` from the root folder of the project to launch a local server that automatically rebuilds:
2034
```
2135
hugo server &
2236
```
2337
5. View the site in your web browser by going to [http://localhost:1313/](http://localhost:1313/)
2438
6. When you make changes, you should be able to reload http://localhost:1313/ to instantly see the changes!
25-
7. To push your changes back to the live site, remember to commit
26-
them. First you will need a
27-
[GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). Then do:
28-
```
29-
git checkout -b BRANCH_NAME
30-
git add FILES
31-
git commit -m "my changes"
32-
git push (or you might need to do git push --set-upstream origin BRANCH_NAME)
33-
```
34-
(Then go to https://github.com/OBF/OBF.github.io to make a PR)
35-
8. Once the PR is merged, your changes should be visible on [https://obf.github.io/](https://obf.github.io/)
3639

3740

3841
## Steps taken to port content from old WP site

0 commit comments

Comments
 (0)