You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/contributors/add-event-to-website.md
+31-35Lines changed: 31 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,40 +4,33 @@ title: How to add an event to the web3privacy now website
4
4
5
5
## Preamble
6
6
7
-
The main project website is [web3privacy.info](https://web3privacy.info) and is auto-deployed via Github Pages leveraging the [Astro framework](https://astro.build/) but the data for the events listed, speaker profiles, W3P members/community partners, research and project is aggregated from our data repository and not the Astro code that runs the main website.
7
+
The main project website is [web3privacy.info](https://web3privacy.info) and is auto-deployed via Github Pages leveraging the [Astro framework](https://astro.build/) but the data for the W3PN events listed, the speaker profile pictures and their information is aggregated from our /data repository and not the Astro code that runs the main website. This means that we will need to find the correct files to edit within the /data codebase to make changes that will apply to all the places that content is displayed within the Astro website.
8
8
9
-
Therefore to add an event you need to edit the code in the Data repository of Web3privacy now, so that it auto-deploys a json output that is visible at [data.web3privacy.info](https://data.web3privacy.info) from which the Events are indexed, where data and images for speakers and the event are scrapped and presented on the main project website. Please take note that within the Data repository all 'speakers' are 'persons' and can be found within the 'people' folder of the code.
9
+
Therefore to add an event you need to edit the code in the /data repository, which will auto-deploys a json output that is visible at [data.web3privacy.info](https://data.web3privacy.info) from which the website indexes our Events and presented on the main project website. Please note that within the /data repository all 'speakers' are 'persons' and can be found within the 'people' folder of the code.
10
10
11
-
**Please advise:** It is essential to distinguish these two repositories and ensure you are not making edits to /web when you are adding a new event:
11
+
**Important:** It is essential to distinguish these two repositories and ensure you are not making edits to /web when you are adding a new event:
The website is using a web framework called Astro, this means that is does not have 'traditional' HTML/CSS/JS files and structure for a website, we will need to find the correct files to edit within the Data codebase and this change will apply to all the places that content is displayed.
16
-
17
-
For example, if you update a person's 'caption' because they changed thier job title, then editing this 'caption' within Data will be displayed the same way throughout the whole website where that person is a speaker or is listed. This is the power of Astro but as a result it requires a different approach to editing website contents.
18
-
19
-
Attention: to add a new event to the Web3privacy website **you do NOT need to make a PR in the [Web codebase](https://github.com/web3privacy/web)**, it all happens primarily **[within the Data codebase](https://github.com/web3privacy/data).**
[naming convention for event 'id'](https://docs.web3privacy.info/events/#naming-conventions)
25
+
[Docs: naming convention for event 'id'](https://docs.web3privacy.info/events/#naming-conventions)
32
26
33
27
## Pre-requisites
34
28
- Have a Github account to create a fork of this repository: [https://github.com/web3privacy/data](https://github.com/web3privacy/data)
35
29
- Have the relevant event information on hand (time, date, city, speakers, etc)
36
-
- Have generated images for the event using the gen-img front-end (see Part 3 below)
30
+
- Have generated 5 images for the event (see dimension below)
37
31
- Knowledge of our naming convention for event 'id' (how we name events) as [described here](https://docs.web3privacy.info/events/#naming-conventions) - for example: the 2024 congress in Bangkok has an id of `c24bkk`
38
32
39
33
40
-
41
34
## Step-by-step Guide
42
35
43
36
### Example code for the guide
@@ -71,20 +64,20 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
71
64
72
65
73
66
### Part 1: Setup
74
-
-[ ]Sign in to Github and go to the [Data repository](https://github.com/web3privacy/data)
75
-
-[ ] Make a fork of the Data repository, and proceed to make the edits within your fork of the code
76
-
-[ ] Collect the following information for the new event: date, location, lead person(s), registration link, some of the confirmed speakers
67
+
-[ ] Sign in to Github and go to the [/data repository](https://github.com/web3privacy/data)
68
+
-[ ] Make a fork of the /data repository, and proceed to make the edits within your fork of the code
69
+
-[ ] Collect the following information for the new event: date, location, lead person(s), registration link, a selection of 5-12 confirmed speakers
77
70
78
71
79
72
### Part 2: Data repository
80
-
-[ ] Navigate to the index.yaml file within the /data/src/events directory: [https://github.com/web3privacy/data/blob/main/src/events/index.yaml](https://github.com/web3privacy/data/blob/main/src/events/index.yaml)
73
+
-[ ] Navigate to the index.yaml file within the /data/src/events directory of your fork
81
74
-[ ] The events are ordered in this list by year (see the commented code for 2023, 2024, 2025 in the file) so find the relevant section and make additions in that part of the index.yaml
82
-
-[ ] The following are required data that is needed for the index.yaml entry:
75
+
-[ ] The following are **required data fields** that is needed for the index.yaml entry:
83
76
```
84
77
- id:
85
78
- date:
86
79
```
87
-
-[ ] the following are optional data fields, which you should add to make the website listing look better
80
+
-[ ] the following are **optional data fields** which you should add to make the website listing look better
88
81
```
89
82
- type:
90
83
- confirmed:
@@ -104,32 +97,35 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
104
97
```
105
98
106
99
-[ ] For the full schema and what each of these data fields are requesting see [data/schema/index.yaml between lines 27 - 103](https://github.com/web3privacy/data/blob/main/schema/index.yaml)
107
-
-[ ] A good practice would be to find an event of the same `type`, copying it's entry in the index.yaml and then replacing the relevant information. For example to list the next Web3Privacy Congress, go to last year's edition and copy that as a template for your entry.
108
-
-[ ] Once you added the event to the index.yaml, navigate to the relevant folder (sub-divided by year) within the _images folder of /events: [https://github.com/web3privacy/data/tree/main/src/events/_images](https://github.com/web3privacy/data/tree/main/src/events/_images)
100
+
-[ ] A good practice would be to find an event of the same `type`, duplicating entry in the index.yaml and then replacing the relevant information from that. For example to list the next edition of the W3PN Congress, go to last year's edition and copy that as a template for your entry.
101
+
102
+
### Part 3: Adding the event images
103
+
-[ ] Once you added the event and made the commit to the index.yaml file, navigate to the /src/_images/ folder
104
+
-[ ] The /_images folder is where the website will look for the various images used to show the event
105
+
-[ ] Navigate to the correct year of the event (as you see the /_images folder is sub-divided by year)
109
106
-[ ] Here is where you will be uploading 5 images for the event in the following formats:
110
107
-[x] c24bkk-poster.png (dimensions: 3040 x 4300 pixels)
111
108
-[x] c24bkk-poster-simple.png (dimensions: 3040 x 4296 pixels)
112
109
-[x] c24bkk-square.png (dimensions: 1600 x 1600 pixels)
113
110
-[x] c24bkk-wide.png (dimensions: 2844 x 1600 pixels)
114
111
-[X] c24bkk-wide-square.png (dimensions: 2132 x 1600 pixels)
115
-
116
-
### Part 3: Refreshing data and synching
117
-
-[ ] Once the Pull Request is merged, verify there are no issues within the Github Pages deployment. To do this visit the Actions page and see if any recent Actions have failed (red circle indicates this).
112
+
-[ ] In the above list `c24bkk` is used, please make sure you use the same name as that of the `id` of the new event
113
+
-[ ] The images should be .png or .jpg format and respect the various dimensions noted above
114
+
-[ ] Once you uploaded all the images make the commit to the code.
115
+
-[ ] You can now open a Pull Request by clicking on the 'Contribute' button within the main page of your forked repository (hint: `https://github.com/username/data` where 'username' is your Github account username.
116
+
-[ ] Once your Pull Request has been submitted, please notify the core team so as to be aware of your request.
117
+
118
+
### Part 4: Refreshing data and synching
119
+
-[ ] Once the Pull Request is merged by the team, the following need to be completed by W3PN maintainers:
118
120
-[ ] Request that the /data maintainer runs the [W3PN data refresh Action](https://github.com/web3privacy/data/actions/workflows/data-refresh.yml)
119
-
-[ ] Request that the /data maintainer runs the [sync Action](https://github.com/web3privacy/data/actions/workflows/sync.yml)
120
-
-[ ] Check the event listed in visible on data.web3privacy.info and that images and thumbs have been properly generated by scripts
121
-
-[ ]Wait 6 hours for the automated scripts within the /web code base to activate and scrape the appropriate data from data.web3privacy.info
122
-
-[ ] navigate to the events section of the website and verify all is correct: [https://web3privacy.info/events](https://web3privacy.info/events)
121
+
-[ ] Request that the /web maintainer runs the [sync Action](https://github.com/web3privacy/web/actions/workflows/sync.yml)
122
+
-[ ] Check that the event you added is listed in visible on data.web3privacy.info and that images and thumbs have been properly generated by scripts can be viewed by clickin on the links
123
+
-[ ]If no maintainer responds do not worry, the above actions are set to happen every 12 hours via an automated scripts (cron setting in sync.yml and data-refresh.yml)
124
+
-[ ]Once the above is done, navigate to the events section of the website and verify that all is correct: [https://web3privacy.info/events](https://web3privacy.info/events)
0 commit comments