diff --git a/README.md b/README.md index 4339819544..de281a427c 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,32 @@ It spins up a Docker-Container made from [SkoHub-Vocabs](https://github.com/hbz/ If you want to reuse this repo and have your vocabulary automatically pushed und published via GitHub-Pages, follow these steps: -1. Fork this repo. Uncheck the box to only fork the main branch. +1. Fork this repo. **Uncheck the box to only fork the main branch**. 1. Go to "Actions" tab and if not already activated, activate GitHub Actions. -1. Go to "Settings", navigate to the "GitHub Pages" setting and select `gh-pages` as the branch your site is being built from. If it is not available yet, you might have to push something to your repo, so the GitHub-Action gets triggered or you can trigger it manually with going to "Actions" in the menubar, then select the workflow "Build /public and deploy..." and click "Run workflow". This way you can trigger the workflow automatically. -1. Go back to the main page of your repo and click the little gear icon in the top right of the "About" section. -1. Check the box at "Use your GitHub Pages website". +1. Go to "Settings", navigate to the "Pages" setting and select `gh-pages` as the branch your site is being built from. +1. Go back to the main page of your repo and click the little gear icon in the top right of the "About" section. Check the box at "Use your GitHub Pages website". 1. After that your vocabulary will be automatically published every time a push to this repo is made (sometimes it takes a little to see the changes, remember to do some hard refreshing). 1. Any issues? Please open up a issue [here](https://github.com/skohub-io/skohub-docker-vocabs/issues) -## FAQ +## Troubleshooting -- During the build I get an error saying `The requested URL returned error: 403` - - You maybe need to update permissions like described here: https://github.com/peaceiris/actions-gh-pages/issues/744 - - Go to `Settings` > `Actions` > `General` > `Workflow permissions` and toggle the Read and write permissions +### There is no `gh-pages` branch to select for GitHub Pages + +You probably only forked the main branch. +You have two options: + +- Delete the repo and fork it again, but make sure to uncheck the box to only fork the main branch +- Make sure the GitHub Action is activated ➡️ Go to "Actions" tab and activate it. After that modify a vocabulary and push the changes. This should trigger the build and create a `gh-pages` branch. + +### I push changes, but they seem to have no effect. My vocabulary stays the same + +Maybe your GitHub Action is not activated yet. +Go to the "Actions" tab and activate GitHub Actions for your repository. + +### During the build I get an error saying `The requested URL returned error: 403` + +You maybe need to update permissions like described here: https://github.com/peaceiris/actions-gh-pages/issues/744 +Go to `Settings` > `Actions` > `General` > `Workflow permissions` and toggle the Read and write permissions. ## CHANGELOG