Skip to content

Commit bced1b6

Browse files
authored
Add meetup contribution instructions to README (#610)
1 parent 8ab35df commit bced1b6

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ but it's probably not a Ruby conference.
2929

3030
The list of events is driven by the conferences file in the `_data` directory - if you have an update for those things, just change the YAML and send a PR.
3131

32+
**Conferences**
33+
3234
The file to be changed is `_data/conferences.yml`. It is NOT order-dependent.
3335
Put your conference in the YAML file at the end.
3436
The page will sort the conferences by `start_date`.
@@ -58,6 +60,26 @@ Extra keys for the past events:
5860

5961
* `video_link`: A url to the videos for the event.
6062

63+
**Meetups**
64+
65+
The file to be changed is `_data/meetups.yml`. It is NOT order-dependent.
66+
Put your meetup in the YAML file at the end.
67+
The page will sort the conferences by `date`.
68+
69+
Here is a list of the keys that can be used:
70+
71+
* `name`: The official name of the event
72+
* `location`: When the event is in the US, this would be "City, State", for any
73+
other country, use "City, Country".
74+
* `date`: The date of the event - ISO8601 formatted (yyyy-mm-dd).
75+
* `start_time`: The start time of the event - formatted as (hh:mm:ss ZZZ)
76+
* hh - between 0 and 23
77+
* mm - between 0 and 59
78+
* ss - between 0 and 59
79+
* ZZZ - timezone (e.g. CDT or EST)
80+
* `end_time`: The end time of the event - ISO8601 formatted as (hh:mm:ss ZZZ) using same values as `start_time`
81+
* `url`: The url for the event.
82+
6183
## Getting started
6284

6385
We build the site with [Jekyll](https://jekyllrb.com/).

0 commit comments

Comments
 (0)