marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Update GitHub Pages deployment docs 

Fixes #653
pull/674/head
James Panther 2023-10-23 09:23:31 +11:00
parent 31dffd65dc
commit 9982a3820c
No known key found for this signature in database
GPG Key ID: D36F789E45745D17
3 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
exampleSite/content/docs/hosting-deployment/github-pages-source.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 172 KiB

BIN
exampleSite/content/docs/hosting-deployment/github-workflow-permissions.jpg 100644
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 341 KiB

6
exampleSite/content/docs/hosting-deployment/index.md
View File

@ -75,7 +75,11 @@ jobs:
Push the config file to GitHub and the action should automatically run. It may fail the first time and you'll need to visit the **Settings > Pages** section of your GitHub repo to check the source is correct. It should be set to use the `gh-pages` branch. Push the config file to GitHub and the action should automatically run. It may fail the first time and you'll need to visit the **Settings > Pages** section of your GitHub repo to check the source is correct. It should be set to use the `gh-pages` branch.
{{< screenshot src="github-pages-source.jpg" alt="Screen capture of GitHub Pages source" >}} {{< screenshot src="github-pages-source.jpg" alt="Screen capture of GitHub Pages source settings" >}}
You should also visit the **Settings > Actions > General** section and check that the workflow permissions allow actions to make changes to your repo.
{{< screenshot src="github-workflow-permissions.jpg" alt="Screen capture of GitHub Workflow Permissions settings" >}}
Once the settings are configured, re-run the action and the site should build and deploy correctly. You can consult the actions log to check everything deployed successfully. Once the settings are configured, re-run the action and the site should build and deploy correctly. You can consult the actions log to check everything deployed successfully.