web3privacy/docs
1
0
Fork 0
mirror of https://github.com/web3privacy/docs synced 2024-10-15 18:46:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #17 from niclaz/patch-3

Browse source 
Updated website guide - checkbox list for steps
This commit is contained in:
Mykola Siusko 2024-08-07 10:32:42 +02:00 committed by GitHub
commit 46dd400c9a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 25 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
src/content/docs/contributors/deploy-event-website.md
View file

@ -21,31 +21,31 @@ NOTE: If you have already deployed the website code via Github Pages for testing
## Step-by-step Guide
### Part 1: Github Pages
1 - Navigate to the project repository main page (example: github.com/web3privacy/c24bkk)
1 - Deploy the project to Github Pages by selecting 'Settings' in the top menu bar
1 - Page loads, see the left hand menu bar, under the section 'Code and Automation' select 'Pages'
1 - In the main window, under the 'Source' section, ensure 'Deploy from Branch' option is selected in the dropdown menu
1 - Underneith it in the 'Branch' section, use the dropdown and select 'main' (next to it the '/root' option will autoselect itself)
1 - In this section 'Branch', click on the 'Save' button, the webpage will reload
1 - After a few minutes Github Pages will deploy your code online, go to the Deployments section of your project (Example: github.com/web3privacy/c24bkk/deployments/github-pages)
1 - Here you can see the current deployments, their URL, a button to visit the site, and also where the option to Unpublish it is available
- [ ] Navigate to the project repository main page (example: github.com/web3privacy/c24bkk)
- [ ] Deploy the project to Github Pages by selecting 'Settings' in the top menu bar
- [ ] Page loads, see the left hand menu bar, under the section 'Code and Automation' select 'Pages'
- [ ] In the main window, under the 'Source' section, ensure 'Deploy from Branch' option is selected in the dropdown menu
- [ ] Underneith it in the 'Branch' section, use the dropdown and select 'main' (next to it the '/root' option will autoselect itself)
- [ ] In this section 'Branch', click on the 'Save' button, the webpage will reload
- [ ] After a few minutes Github Pages will deploy your code online, go to the Deployments section of your project (Example: github.com/web3privacy/c24bkk/deployments/github-pages)
- [ ] Here you can see the current deployments, their URL, a button to visit the site, and also where the option to Unpublish it is available
### Part 2: Porkbun
2 - Login to porkbun
2 - hover your mouse over 'web3privacy.info' within the domains list in home dashboard
2 - two options should appear under the name, select the 'DNS' one
2 - A pop-up appears requesting you create a new DNS record (below it is a list of the current DNS records)
2 - Under Type, select 'CNAME - Canonical name record'
2 - Under Host, type the subdomain you want it to point to (example: for c24bkk.web3privacy.info enter 'c24bkk' in this field)
2 - Under Answer, type 'web3privacy.github.io'
2 - You can leave everything else within this pop-up as it and scroll down, select the big blue 'Add' button
2 - scroll to top of the pop-up, a small banner should tell you the record was added (or if an error occured)
- [ ] Login to porkbun
- [ ] hover your mouse over 'web3privacy.info' within the domains list in home dashboard
- [ ] two options should appear under the name, select the 'DNS' one
- [ ] A pop-up appears requesting you create a new DNS record (below it is a list of the current DNS records)
- [ ] Under Type, select 'CNAME - Canonical name record'
- [ ] Under Host, type the subdomain you want it to point to (example: for c24bkk.web3privacy.info enter 'c24bkk' in this field)
- [ ] Under Answer, type 'web3privacy.github.io'
- [ ] You can leave everything else within this pop-up as it and scroll down, select the big blue 'Add' button
- [ ] scroll to top of the pop-up, a small banner should tell you the record was added (or if an error occured)
### Part 3: Testing
3 - Wait 2-5 minutes (really, this can take some time to update)
3 - Use a different browser or clear your browser cache and cookies
3 - navigate to your project Github Pages URL (example: web3privacy.github.io/c24bkk)
3 - If all is working then the domain within your browser bar should change to the subdomain of repository (example: c24bkk.web3privacy.info)
- [ ] Wait 2-5 minutes (really, this can take some time to update)
- [ ] Use a different browser or clear your browser cache and cookies
- [ ] navigate to your project Github Pages URL (example: web3privacy.github.io/c24bkk)
- [ ] If all is working then the domain within your browser bar should change to the subdomain of repository (example: c24bkk.web3privacy.info)
### Troubleshooting
@ -58,9 +58,13 @@ NOTE: If you have already deployed the website code via Github Pages for testing
### External resources
[Porkbun Knowledge Base](https://kb.porkbun.com)
[Github Pages Documentation](https://docs.github.com/en/pages)
[Github Pages Docs search](https://docs.github.com/en/search?query=custom+domain)
[Github Pages Docs troubleshooting custom domains article](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/troubleshooting-custom-domains-and-github-pages)
[Stackoverflow post](https://stackoverflow.com/questions/9082499/custom-domain-for-github-project-pages)