Skip to content

Commit 81f5442

Browse files
Tomasz-KluczkowskiTomasz-Kluczkowski
committed
Removed obj_id variable from chapter.
Used category instead. Set category, title, level variables in events to strings (as they are just text). Removed date variable from all events - now date is taken straight from the file. Added examples to README.md on how to create a chapter and event and some description of some variables matching the new setup.
1 parent 42a22ae commit 81f5442

13 files changed

+109
-94
lines changed

‎README.md‎

Lines changed: 77 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,50 @@ Send a pull request adding a new file `_chapters/<your-chapter-name>.md`, where
3232
separating words with underscore (e.g. `london_pyton_sprints`).
3333

3434
The content of the file has a header section with some fields (started and finished with
35-
---), and the main description of the chapter afterwards. This is the format:
36-
37-
```
38-
---
39-
obj_id: <unique-identifier-of-your-chapter--same-as-file-name>
40-
title: "Name of your chapter"
41-
meetup_link: <url-of-your-other-website-if-any>
42-
address: "Description of your location, usually City, Country"
43-
country_code: <2-digit-country-code-used-for-the-flag>
44-
lat: <float-number-with-latitude-for-the-marker-in-the-map>
45-
lng: <float-number-with-longitude-for-the-marker-in-the-map>
46-
chapter: <this-seems-duplicated-of-obj_id-need-to-take-a-look>
47-
sponsors:
48-
- <first-sponsor-id-to-be-listed-in-your-page>
49-
- <second-sponsor-id-to-be-listed-in-your-page>
50-
- <feel-free-to-add-as-many-as-you-want>
51-
---
52-
53-
Here you can add any information about your group. How it started, which are the goals,
54-
what people can expect from it.
55-
56-
This is a good time to remind you, that no sort of discrimination (gender, religion,
57-
age, sexual orientation...) is tolerated in the Python sprints (or in the Python
58-
community in general). And as an organizer you must not allow any sort of harassment
59-
in the events. Feel free to add in your chapter description to policies you have to
60-
make sure the events are as diverse and welcoming as possible.
61-
```
35+
---), and the main description of the chapter afterwards.
36+
We are using markdown files to store your data and they can contain either markdown tags for text formatting or pure html - it is up to you how to style your content.<br>
37+
This is the format:
38+
39+
---
40+
category: "the-city-where-your-chapter-is-located-in"
41+
title: "Name of your chapter"
42+
meetup_link: <url-of-your-other-website-if-any>
43+
address: "Description of your location, usually City, Country"
44+
country_code: <2-digit-country-code-used-for-the-flag>
45+
lat: <float-number-with-latitude-for-the-marker-in-the-map>
46+
lng: <float-number-with-longitude-for-the-marker-in-the-map>
47+
sponsors:
48+
- <first-sponsor-id-to-be-listed-in-your-page>
49+
- <second-sponsor-id-to-be-listed-in-your-page>
50+
- <feel-free-to-add-as-many-as-you-want>
51+
---
52+
53+
Here you can add any information about your group. How it started, which are the goals,
54+
what people can expect from it.
55+
56+
This is a good time to remind you, that no sort of discrimination (gender, religion,
57+
age, sexual orientation...) is tolerated in the Python sprints (or in the Python
58+
community in general). And as an organizer you must not allow any sort of harassment
59+
in the events. Feel free to add in your chapter description to policies you have to
60+
make sure the events are as diverse and welcoming as possible.
61+
62+
63+
Example chapter setup
64+
---------------------
65+
---
66+
category: "london"
67+
title: "London Python Sprints"
68+
meetup_link: https://www.meetup.com/Python-Sprints/
69+
address: London, United Kingdom
70+
country_code: gb
71+
lat: 51.512344
72+
lng: -0.090985
73+
sponsors:
74+
- harvey_nash
75+
- touch_surgery
76+
- bloomberg
77+
---
78+
The content of your chapters description goes below ---.
6279

6380
How to add an event
6481
-------------------
@@ -72,42 +89,52 @@ system, you may also want to add it.
7289

7390
To create an event, you need to add a new file to the `_posts` directory with the file
7491
name following the format `YYYY-MM-DD-slug-of-the-event.md`. Were `YYYY-MM-DD` is the
75-
date of the event, and the slug of the event is the title in a format URL friendly
92+
date of the event (this will be the date shown on site), and the slug of the event is the title in a format URL friendly
7693
(only lowercase ascii letters and numbers, separating words with hyphens). For example
7794
`2017-12-31-django-bugfixing.md` could be the name of a sprint "Django bugfixing"
7895
happening on December 31st of 2017.
7996

8097
The content of the file has a header section with some fields (started and finished with
8198
---), and the main description of the event afterwards. This is the format:
8299

83-
```
84-
---
85-
category: <id-of-your-chapter>
86-
title: "Short summary of your event"
87-
level: "Target audience of the event (e.g. Beginners, All levels, Advanced,...)"
88-
date: "YYYY-MM-DD"
89-
time: "hh:mm"
90-
rsvp_link: <url-of-your-meetup-eventbrite-etc-page>
91-
project: <id-of-the-project-you-will-work-on>
92-
sponsor: <id-of-the-sponsor-for-the-event>
93-
---
94-
95-
This space is the main description of the event, where you can provide further details.
96-
97-
Note that you don't need to add information about the project, as the description of the
98-
project, the logo, and the environment set up instructions should be rendered automatically
99-
after specifying the id of the project.
100-
101-
Also, by specifying the id of the sponsor, a box with its information will appear.
102-
```
103-
100+
---
101+
category: "<same-as-category-of-your-chapter>"
102+
title: "Short summary of your event"
103+
level: "Target audience of the event (e.g. Beginners, All levels, Advanced,...)"
104+
time: "hh:mm"
105+
rsvp_link: <url-of-your-meetup-eventbrite-etc-page>
106+
project: <id-of-the-project-you-will-work-on>
107+
sponsor: <id-of-the-sponsor-for-the-event>
108+
---
109+
110+
This space is the main description of the event, where you can provide further details.
111+
112+
Note that you don't need to add information about the project, as the description of the
113+
project, the logo, and the environment set up instructions should be rendered automatically
114+
after specifying the id of the project.
115+
116+
Also, by specifying the id of the sponsor, a box with its information will appear.
117+
118+
Example event setup
119+
---------------------
120+
---
121+
category: "london"
122+
title: "Pandas internals"
123+
level: "All levels"
124+
time: "18:30"
125+
rsvp_link: https://www.meetup.com/Python-Sprints/events/249350212/
126+
project: pandas
127+
sponsor: harvey_nash
128+
---
129+
The content of your event's description goes below ---.
130+
104131
You may want to copy one of the last events in `_posts` to be used as reference.
105132

106133
How does Jekyll work?
107134
---------------------
108135

109136
- Posts (files in `_posts/*.md`) are the event pages in markdown
110-
- Projects (`_project/*.md`) are the open source projects we contribut to
137+
- Projects (`_project/*.md`) are the open source projects we contribute to
111138
- Sponsors (`_sponsors/*.md`) are the companies providing the venue and pizzas
112139
- Layouts (files in `_layouts/*.html`) are equivalent to Django templates,
113140
and used to render the posts (events)

‎_chapters/london_python_sprints.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
obj_id: london_python_sprints
2+
category: "london"
33
title: "London Python Sprints"
44
meetup_link: https://www.meetup.com/Python-Sprints/
55
address: London, United Kingdom
66
country_code: gb
77
lat: 51.512344
88
lng: -0.090985
9-
category: "london"
109
sponsors:
1110
- harvey_nash
1211
- touch_surgery

‎_posts/2017-10-04-Bokeh-As-A-Backend-For-Pandas.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: Bokeh as a backend for Pandas
4-
level: All
5-
date: 2017-10-04
2+
category: "london"
3+
title: "Bokeh as a backend for Pandas"
4+
level: "All"
65
time: "18:30"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/243422372/
87
event_link:

‎_posts/2017-10-24-PyMC3.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: PyMC3 - beginner friendly issues
4-
level: Beginner
5-
date: 2017-10-24
2+
category: "london"
3+
title: "PyMC3 - beginner friendly issues"
4+
level: "Beginner"
65
time: "18:30"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/244062594/
87
event_link:

‎_posts/2017-11-01-www.python.org-Part1.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: python.org (Part 1)
4-
level: All
5-
date: 2017-11-01
2+
category: "london"
3+
title: "python.org (Part 1)"
4+
level: "All"
65
time: "18:30"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/244388482/
87
event_link:

‎_posts/2017-12-06-python-dateutil.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: python-dateutil issues
4-
level: All
5-
date: 2017-12-06
2+
category: "london"
3+
title: "python-dateutil issues"
4+
level: "All"
65
time: "18:00"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/245317647/
87
event_link:

‎_posts/2018-03-10-Pandas-Documentation-Sprint.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: Pandas documentation sprint (worldwide)
4-
level: All
5-
date: 2018-03-10
2+
category: "london"
3+
title: "Pandas documentation sprint (worldwide)"
4+
level: "All"
65
time: "10:00"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/247097848/
87
event_link: https://python-sprints.github.io/pandas/

‎_posts/2018-03-20-Pandas-Beginners-Friendly.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: Pandas, Beginners Friendly
4-
level: Beginner
5-
date: 2018-03-20
2+
category: "london"
3+
title: "Pandas, Beginners Friendly"
4+
level: "Beginner"
65
time: "18:30"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/248711552/
87
event_link:

‎_posts/2018-03-22-pandasSprint continued (ALL LEVELS).md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: Pandas Sprint continued (ALL LEVELS)
4-
level: All
5-
date: 2018-03-22
2+
category: "london"
3+
title: "Pandas Sprint continued (ALL LEVELS)"
4+
level: "All"
65
time: "18:30"
76
meetup_link: https://www.meetup.com/Python-Sprints/events/248712103/
87
event_link:

‎_posts/2018-04-10-tornado.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
2-
category: london
3-
title: Tornado bugfixing
4-
level: All levels
5-
date: 2018-04-10
2+
category: "london"
3+
title: "Tornado bugfixing"
4+
level: "All levels"
65
time: "18:30"
76
rsvp_link: https://www.meetup.com/Python-Sprints/events/249304835/
87
project: tornado

0 commit comments

Comments
 (0)