web3privacy
/
docs
mirror of https://github.com/web3privacy/docs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improved deploying event website Guide markdown formatting

This commit is contained in:
niclaz 2024-08-10 13:22:02 +02:00 committed by GitHub
parent d5766c9b2c
commit 46388ff213
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/content/docs/contributors/deploy-event-website.md
View File

@ -4,30 +4,29 @@ title: How to deploy a W3PN events website
## Preamble ## Preamble
The purpose of this Guide is to help you deploy a unique website for a W3PN event that is larger than a meetup (example: Summit and Congress) via Github Pages The purpose of this Guide is to help you deploy a unique website for a W3PN event that is larger than a meetup via Github Pages (example websites: [Summit](https://summit.web3privacy.info/) or [Congress](https://congress.web3privacy.info/)).
The cost for us to deploy a new website is basically zero (aside from contributor time), and requires a little coordination but can be completed in few hours. The cost for us to deploy a new website is basically zero (aside from contributor time), and requires a little coordination but can be completed in few hours.
NOTE: If you have already deployed the website code via Github Pages for testing purposes, consider unpublishing the website via the Deployments tab before following through with the process outlined below. Sometimes conflicts can appear within Github Pages when there are too many concurrent deployments.
## Pre-requisites ## Pre-requisites
- production-ready website code forked from htttps://github.com/web3privacy/events_web - production-ready website code forked from [https://github.com/web3privacy/events_web](https://github.com/web3privacy/events_web)
- maintainer/owner role within the new project code repository - have maintainer/owner role within the new project code repository
- access to the domain management portal Porkbun to create DNS records (can be delegated) - access to the domain management portal Porkbun to create DNS records (can be delegated)
- some knowledge of domain management and DNS. - some knowledge of domain management and DNS
## Step-by-step Guide ## Step-by-step Guide
### Part 1: Github Pages ### Part 1: Github Pages
- [ ] Navigate to the project repository main page (example: github.com/web3privacy/c24bkk) - [ ] Navigate to the project repository main page (example: [https://github.com/web3privacy/c24bkk](https://github.com/web3privacy/c24bkk))
- [ ] Deploy the project to Github Pages by selecting 'Settings' in the top menu bar - [ ] 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' - [ ] 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 - [ ] 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) - [ ] 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 - [ ] 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) - [ ] After a few minutes Github Pages will deploy your code online, go to the Deployments section of your project (Example: [https://github.com/web3privacy/c24bkk/deployments/github-pages](https://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 - [ ] 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 ### Part 2: Porkbun
@ -44,7 +43,7 @@ NOTE: If you have already deployed the website code via Github Pages for testing
### Part 3: Testing ### Part 3: Testing
- [ ] Wait 2-5 minutes (really, this can take some time to update) - [ ] Wait 2-5 minutes (really, this can take some time to update)
- [ ] Use a different browser or clear your browser cache and cookies - [ ] Use a different browser or clear your browser cache and cookies
- [ ] navigate to your project Github Pages URL (example: web3privacy.github.io/c24bkk) - [ ] navigate to your project Github Pages URL (example: [https://web3privacy.github.io/c24bkk](https://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) - [ ] If all is working then the domain within your browser bar should change to the subdomain of repository (example: c24bkk.web3privacy.info)
@ -52,7 +51,8 @@ NOTE: If you have already deployed the website code via Github Pages for testing
- Your browser will probably show a warning of an 'insecure connection' to the website, this is because the TLS/SSL certificate will be updated automatically but can take 1-2 days for this to happen (no action necessary on your part, just a common 'error' people see) - Your browser will probably show a warning of an 'insecure connection' to the website, this is because the TLS/SSL certificate will be updated automatically but can take 1-2 days for this to happen (no action necessary on your part, just a common 'error' people see)
- If you wish to force a specific subdomain to the project that is not the repository name (example: c24bkk) then you will need to created a file within the main folder of the repository. name this file 'CNAME' all in capitals, and add only one line to the file (example: congress.web3privacy.info) - If you wish to force a specific subdomain to the project that is not the repository name (example: c24bkk) then you will need to created a file within the main folder of the repository. name this file 'CNAME' all in capitals, and add only one line to the file (example: congress.web3privacy.info)
- Ask in W3PN chats for support or help - If you have already deployed the website code via Github Pages for testing purposes, consider unpublishing the website via the Deployments tab before following through with the process outlined below. Sometimes conflicts can appear within Github Pages when there are too many concurrent deployments. If problems persist, consider starting from scratch again.
- Ask in W3PN chats for support or help
### External resources ### External resources