mirror of
https://github.com/web3privacy/docs
synced 2024-10-15 18:46:26 +02:00
Merge pull request #15 from niclaz/main
Broken Link Fixing + Contributor Guide
This commit is contained in:
Mykola Siusko
GitHub
commit
3056e5d7bf
8 changed files with 77 additions and 15 deletions
66
src/content/docs/contributors/deploy-event-website.md
Normal file
66
src/content/docs/contributors/deploy-event-website.md
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: How to deploy a W3PN events website
|
||||
---
|
||||
|
||||
## 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 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
|
||||
- production-ready website code forked from htttps://github.com/web3privacy/events_web
|
||||
- maintainer/owner role within the new project code repository
|
||||
- access to the domain management portal Porkbun to create DNS records (can be delegated)
|
||||
- some knowledge of domain management and DNS.
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
### 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)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- 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)
|
||||
- Ask in W3PN chats for support or help
|
||||
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ Historical track record of *Web3Privacy Now*.
|
|||
* **Research**: _Scoring model for techies update_: [GitHub](https://github.com/web3privacy/explorer/blob/main/Web3privacynowplatform/scoringmodel/Scoringmodel_techies.md)
|
||||
* **Research**: Explorer platform beta update [web](https://explorer.web3privacy.info)
|
||||
* **Development**: W3PN website launch [web](https://web3privacy.info)
|
||||
* **Research**: _Ethereum Privacy Ecosystem_ [GitHub](https://github.com/web3privacy/docs/blob/main/docs/research/ethereum-privacy-ecosystem.md)
|
||||
* **Research**: _Ethereum Privacy Ecosystem_ [GitHub](https://github.com/web3privacy/docs/blob/main/src/content/docs/research/ethereum-privacy-ecosystem.md)
|
||||
* **Article**: #2023privacyproof finalists announced [Mirror](https://mirror.xyz/0x0f1F3DAf416B74DB3DE55Eb4D7513a80F4841073/wyFhJ9_ayxA6BXTW0WE1h4ZackVTjrZTeC28Y6-J4mc)
|
||||
* **Article**: _Doxxer of the year #2023privacyproof_ [Mirror](https://mirror.xyz/0x0f1F3DAf416B74DB3DE55Eb4D7513a80F4841073/Yx-Hc2kw2sDVixLkKQ5F1ZDN33eKGYYkK4fjVdPouIE)
|
||||
* **Article**: _Exciting innovation in privacy #2023privacyproof_ [Mirror](https://mirror.xyz/0x0f1F3DAf416B74DB3DE55Eb4D7513a80F4841073/pbTUSd5RerKKwmeqWmzl5VDmtuykkalqFUBTy0EQUNA)
|
||||
|
|
@ -36,7 +36,7 @@ Historical track record of *Web3Privacy Now*.
|
|||
- [Web3 Privacy DB (+500 projects)](https://web3privacy.info/)
|
||||
- [Report: Web3 Privacy Market Overview, Jan 2023](https://github.com/web3privacy/web3privacy/blob/main/Market%20overview/Web3privacy%20landscape%20(jan%202023).jpg)
|
||||
- [Web3 Privacy Landscape](https://github.com/web3privacy/web3privacy/blob/main/Market%20overview/Web3privacy%20landscape%20(jan%202023).jpg)
|
||||
- [Pagency Framework](https://github.com/web3privacy/web3privacy/tree/main/Pagency)
|
||||
- [Pagency Framework](https://github.com/web3privacy/docs/blob/main/src/content/docs/research/pagency.md)
|
||||
- [Privacy use-cases](https://github.com/web3privacy/web3privacy/blob/main/Use-cases.md)
|
||||
- [Web3 Privacy Jobs ](https://docs.google.com/spreadsheets/d/1dN6bIWyOh01Dl-y1iZh-1TASZxKUefD098BUALcnUb8/edit#gid=0)
|
||||
- [ZK Privacy Landscape](https://github.com/web3privacy/web3privacy/tree/main/ZKprivacylandscape)
|
||||
|
|
@ -127,8 +127,7 @@ Historical track record of *Web3Privacy Now*.
|
|||
|
||||
* **Article**: _Privacy-Web3 market-fit: search of privacy sustainability_: [Medium](https://medium.com/@Svyazniy/privacy-web3-market-fit-search-of-privacy-sustainability-330c9c98f9df)
|
||||
* **Article**: _Web3 privacy layers overview from embedded to total anonymity_: [Medium](https://medium.com/@Svyazniy/web3-privacy-layers-overview-from-embedded-to-total-anonymity-4ddf8e7c3b4d)
|
||||
* **Research**: _What if... they won't have my data matrix_: [GitHub](https://github.com/web3privacy/web3privacy/tree/main/theywonthave)
|
||||
* **Research**: _Pagency framework - tool to facilitate impactful privacy-enhancing ideas for developers_: [GitHub](https://github.com/web3privacy/web3privacy/tree/main/Pagency), [PDF](https://github.com/web3privacy/web3privacy/blob/main/Pagency/Pagency%20-%20privacy%20use-case%20facilitation%20framework.pdf), [Template](https://github.com/web3privacy/web3privacy/blob/main/Pagency/Privacy%20framework%20template.pptx)
|
||||
* **Research**: _Pagency framework - tool to facilitate impactful privacy-enhancing ideas for developers_: [GitHub](https://github.com/web3privacy/web3privacy/tree/main/Pagency)
|
||||
* **Research**: _Privacy x web3 use-cases_: [GitHub](https://github.com/web3privacy/web3privacy/blob/main/Use-cases.md)
|
||||
* **Research**: _200 projects in our Privacy services in Web3 database_, [GitHub](https://github.com/web3privacy/web3privacy)
|
||||
|
||||
|
|
@ -137,4 +136,4 @@ Historical track record of *Web3Privacy Now*.
|
|||
* **Research**: _Privacy services in Web3 database creation_, [GitHub](https://github.com/web3privacy/web3privacy)
|
||||
* **Talk**: _#FreeAlex Web3 activism handbook, Mykola_: [YouTube](https://www.youtube.com/watch?v=oCvVKltmQgo)
|
||||
* **Article**: _Urge for the PEDApps -Privacy Enhanced Decentralised Applications_ [Medium](https://medium.com/@Svyazniy/urge-for-the-pedapps-privacy-enhanced-decentralised-applications-7efa980cdbb)
|
||||
* **November 11-13, 2022** - The emergence of Web3Privacy Now research as a hackathon project at [ETHBrno 2022](https://docs.ethbrno.cz/events/2022).
|
||||
* **November 11-13, 2022** - The emergence of Web3Privacy Now research as a hackathon project at [ETHBrno 2022](https://docs.ethbrno.cz).
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ A summary of what we have already accomplished can be found on the [History](/hi
|
|||
</CardGrid>
|
||||
<CardGrid>
|
||||
<LinkCard title="Contributors guide" href="/contributors" />
|
||||
<LinkCard title="Membership" href="/membership" />
|
||||
<LinkCard title="Partnerships" href="/partnerships" />
|
||||
</CardGrid>
|
||||
<CardGrid>
|
||||
<LinkCard title="Donate" href="/donate" />
|
||||
|
|
@ -97,7 +97,7 @@ The initiative is managed by a [Core Team](/core-team) of four people who take c
|
|||
</CardGrid>
|
||||
<CardGrid>
|
||||
<LinkCard title="Association" href="/association" />
|
||||
<LinkCard title="Contributors Guild" href="/guild" />
|
||||
<LinkCard title="Contributors " href="/contributors" />
|
||||
</CardGrid>
|
||||
|
||||
## We are very open 💛
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ Weekly newsletter with round-up of the most important news happening around priv
|
|||
|
||||
We use [Paragraph](https://paragraph.xyz/) as a platform for newsletter subscription and distribution:
|
||||
|
||||
* [paragraph.xyz/@web3privacy](https://paragraph.xyz/@web3privacy)
|
||||
* [paragraph.xyz/@web3privacy](https://paragraph.xyz/@privacynews)
|
||||
|
||||
## How to contribute?
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ They support our mission by contributing to all our activities, whether it's a r
|
|||
|
||||
# COMMUNITY PARTNERS
|
||||
|
||||
[Open Observatory of Network Interference](https://ooni.org/) | [LunarDAO](https://lunardao.net/) | [CryptoCanal](https://lu.ma/cryptocanal) | [MolochDAO](https://molochdao.com/) | [Urbe](https://linktr.ee/urbe.eth) | [PrivacyGuardians](http://privacyguardians.io/) | [MoneroKon](https://monerokon.org/) | [Gwei](https://gwei.cz/) | [ETHRome](www.ethrome.org) | [ETHBarcelona](https://www.ethbarcelona.com/) | [ETHBrno](https://ethbrno.cz/) | [Hopr](https://hoprnet.org/) | [UkraineDAO](https://ukrainedao.love/)
|
||||
[Open Observatory of Network Interference](https://ooni.org/) | [LunarDAO](https://lunardao.net/) | [CryptoCanal](https://lu.ma/cryptocanal) | [MolochDAO](https://molochdao.com/) | [Urbe](https://linktr.ee/urbe.eth) | [PrivacyGuardians](http://privacyguardians.io/) | [MoneroKon](https://monerokon.org/) | [Gwei](https://gwei.cz/) | [ETHRome](https://www.ethrome.org) | [ETHBarcelona](https://www.ethbarcelona.com/) | [ETHBrno](https://ethbrno.cz/) | [Hopr](https://hoprnet.org/) | [UkraineDAO](https://ukrainedao.love/)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,6 @@ _Find your next job in web3-privacy_
|
|||
## Phase 3: make front-end prototype
|
||||
Create user-friendly prototype that will simplify & maintain privacy jobs market on a regular basis.
|
||||
|
||||
- [early demo](https://675d9cb1.jobs-6pm.pages.dev)
|
||||
- [web](https://jobs.web3privacy.info)
|
||||
- [github](https://github.com/web3privacy/jobs-app)
|
||||
- [add vacancy onchain](https://jobs.web3privacy.info/add)
|
||||
|
|
|
|||
|
|
@ -15,12 +15,12 @@ W3PN research branch fills the gap within the market knowledge + makes data free
|
|||
| ------------- | ------------- | ------------- |
|
||||
| Privacy marke DB | _Privacy services x web3 initial market DB aggregation: segmentation, key links (web, git, docs), ecosystem, product liveliness etc. 600 projects in the DB._ | [link](https://github.com/web3privacy/web3privacy) |
|
||||
| Privacy market outlook (annual report) | _150-pages report on the state of privacy x web3 from funding to key projects._ | [2022](https://github.com/web3privacy/web3privacy/tree/main/Market%20overview) |
|
||||
| ZK in privacy | _General DB aggregation focused on ZK for privacy._ | [DB](https://github.com/web3privacy/web3privacy/tree/main/ZKprivacylandscape) |
|
||||
| ZK in privacy | _General DB aggregation focused on ZK for privacy._ | Migrating |
|
||||
| Privacy use-cases within the Ukrainian-Russian war | _Research how privacy tools can protect human rights, vulnerable audiences within the war, migration & cross-border relations._ Supported by Zcash Foundation. | [link](https://forum.zcashcommunity.com/t/privacy-services-from-zcash-to-status-usage-within-the-ukrainian-russian-war-research/43940?u=aquietinvestor) |
|
||||
| Privacy jobs market | _Hiring snapshot across the market: total vacancies, grades, technical x non-technical positions, hiring scope within specific companies & domains._ | [link](https://docs.google.com/spreadsheets/d/1dN6bIWyOh01Dl-y1iZh-1TASZxKUefD098BUALcnUb8/edit?usp=sharing) |
|
||||
| Privacy grants market | _Allocation of the ongoing grant programs across the market._ | [link](https://docs.google.com/spreadsheets/d/1dN6bIWyOh01Dl-y1iZh-1TASZxKUefD098BUALcnUb8/edit?usp=sharing) |
|
||||
| Diversity in privacy market | _State of diversity within the privacy market: general cultural practices, actual issues, metrics._ | [link](https://medium.com/@Svyazniy/diversity-in-the-web3-privacy-market-outlook-1a7ccefc872) |
|
||||
| Privacy use-cases | _Basic DB of the privacy-centric use-cases._ | [DB](https://github.com/Msiusko/web3privacy/blob/main/Use-cases.md) |
|
||||
| Privacy use-cases | _Basic DB of the privacy-centric use-cases._ | Migrating |
|
||||
| Privacy use-cases ideation framework for devs | _Pagency framework for facilitation privacy use-cases (privacy services modelling)_ | [link](https://github.com/web3privacy/pagency) |
|
||||
|
||||
## _Ongoing researches_
|
||||
|
|
|
|||
|
|
@ -12,6 +12,4 @@ Unified database of the privacy-enhancing ZK solutions.
|
|||
|
||||
_Find your next job in web3-privacy_
|
||||
|
||||
### Phase 1: initial DB aggregaton 23'
|
||||
|
||||
[DB](https://github.com/Msiusko/web3privacy/tree/main/ZKprivacylandscape)
|
||||
### Phase 0: initial DB aggregaton in 2023
|
||||
|
|
|
|||
Loading…
Reference in a new issue