Skip to content

Commit 329f04e

Browse files
authored
Update Guide: add-event-to-website.md
updated example with new data schema removed gen-img step added dimensions of images
1 parent d28df07 commit 329f04e

File tree

1 file changed

+13
-30
lines changed

1 file changed

+13
-30
lines changed

src/content/docs/contributors/add-event-to-website.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,26 @@ Therefore to add an event you need to edit the code in the Data repository of We
1212
- /web code repository: [https://github.com/web3privacy/web](https://github.com/web3privacy/web)
1313
- /data code repository: [https://github.com/web3privacy/data](https://github.com/web3privacy/data)
1414

15-
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.
15+
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+
1617
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.
1718

18-
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)
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).**
1920

2021

2122
#### Quick-reference:
2223
[https://github.com/web3privacy/web](https://github.com/web3privacy/web)
2324

2425
[https://github.com/web3privacy/data](https://github.com/web3privacy/data)
2526

26-
[gen-img frontend](https://web3privacy.info/gen/event/)
27-
28-
[gen-img background source](https://github.com/web3privacy/web/tree/main/public/gen-img/events)
29-
3027
[Website Events page](https://web3privacy.info/events/)
3128

3229
[Events section in W3P Docs](https://docs.web3privacy.info/events/)
3330

3431
[naming convention for event 'id'](https://docs.web3privacy.info/events/#naming-conventions)
3532

3633
## Pre-requisites
37-
- Have a Github account to create a fork of this repository[https://github.com/web3privacy/data](https://github.com/web3privacy/data)
34+
- Have a Github account to create a fork of this repository: [https://github.com/web3privacy/data](https://github.com/web3privacy/data)
3835
- Have the relevant event information on hand (time, date, city, speakers, etc)
3936
- Have generated images for the event using the gen-img front-end (see Part 3 below)
4037
- 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`
@@ -51,14 +48,11 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
5148
date: "2024-11-11"
5249
city: Bangkok
5350
country: th
54-
# DevCon 2024 - November 12-15 2024
5551
place: "[TBA](https://congress.web3privacy.info)"
5652
place-address: TBA
5753
confirmed: true
5854
coincidence: "[DevCon](https://devcon.org)"
5955
lead: Mykola
60-
slots: 16
61-
visitors: 300
6256
links:
6357
rsvp: https://lu.ma/w3pn-meetup-devcon7
6458
web: https://congress.web3privacy.info/
@@ -92,7 +86,6 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
9286
```
9387
- [ ] the following are optional data fields, which you should add to make the website listing look better
9488
```
95-
- issue:
9689
- type:
9790
- confirmed:
9891
- days:
@@ -104,8 +97,6 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
10497
- coincidenceFull:
10598
- lead:
10699
- helpers:
107-
- slots:
108-
- visitors:
109100
- links:
110101
- speakers:
111102
- name-extension
@@ -115,31 +106,23 @@ Attention: to add a new event to the Web3privacy website **you do NOT need to ma
115106
- [ ] 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)
116107
- [ ] 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.
117108
- [ ] 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)
118-
- [ ] Here is where you will be uploading 5 images for the event you added using the gen-img script explained below in Part 3.
119-
120-
### Part 3: Generating images with gen-img script
121-
- [ ] Images for events are similar but require extra steps (see below) story which also begins with Data respoitory. Images for events need to be uploaded to /data/src/events/_images in 4 different image sizes. To aid for the creation of these images a javascript script was written with the Web repository which can be used from the frontend here: https://web3privacy.info/gen/event/
122-
- [ ] To be able to create easily the 4 formats of images, you must first upload a base image to the folder and then add it to the svelte function...
123-
https://github.com/web3privacy/web/tree/main/public/gen-img/events
124-
- [ ] Generate the 4 different format images for the event using the [gen-img frontend](https://web3privacy.info/gen/event/)
125-
- [ ] navigate to the gen-img page for the event by clicking on the image or use the drop-down menu
126-
- [ ] right-click to 'save image as' for the 5 formats needed: square, wide-square, wide, poster, poster-simple. (Please note: the speaker image is not necessary at this time, only useful to generate marketing collateral)
127-
- [ ] Upload those images to your fork within the _images folder noted in last step of Part 2
128-
- [ ] Double check the content and images are there, then you can create a Pull Request from your fork into the main /data repository.
129-
130-
### Part 4: Refreshing data and synching
109+
- [ ] Here is where you will be uploading 5 images for the event in the following formats:
110+
- [x] c24bkk-poster.png (dimensions: 3040 x 4300 pixels)
111+
- [x] c24bkk-poster-simple.png (dimensions: 3040 x 4296 pixels)
112+
- [x] c24bkk-square.png (dimensions: 1600 x 1600 pixels)
113+
- [x] c24bkk-wide.png (dimensions: 2844 x 1600 pixels)
114+
- [X] c24bkk-wide-square.png (dimensions: 2132 x 1600 pixels)
115+
116+
### Part 3: Refreshing data and synching
131117
- [ ] 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).
132118
- [ ] Request that the /data maintainer runs the [W3PN data refresh Action](https://github.com/web3privacy/data/actions/workflows/data-refresh.yml)
133119
- [ ] Request that the /data maintainer runs the [sync Action](https://github.com/web3privacy/data/actions/workflows/sync.yml)
134120
- [ ] Check the event listed in visible on data.web3privacy.info and that images and thumbs have been properly generated by scripts
135121
- [ ] Wait 6 hours for the automated scripts within the /web code base to activate and scrape the appropriate data from data.web3privacy.info
136122
- [ ] navigate to the events section of the website and verify all is correct: [https://web3privacy.info/events](https://web3privacy.info/events)
137123

138-
### Tips & Tooling
139-
- [ ] [https://web3privacy.info/gen/event](https://web3privacy.info/gen/event)
140-
- [ ] [https://github.com/web3privacy/web/tree/main/public/gen-img/events](https://github.com/web3privacy/web/tree/main/public/gen-img/events)
141-
142124
### Troubleshooting
125+
143126
- Ask in W3PN chats for support or help
144127

145128

0 commit comments

Comments
 (0)