@@ -31,14 +31,77 @@ Send a pull request adding a new file `_chapters/<your-chapter-name>.md`, where
3131` <your-chapter-name> ` is the name of your chapter in ascii lowercase, and
3232separating words with underscore (e.g. ` london_pyton_sprints ` ).
3333
34- The content of the file should list:
35- - object_id: same as the name of the file, as described before (without the extension)
36- - title: name of your chapter (using normal text)
37- - website_link: link to your website
38- - address: name of the city, country... or anything relevant so users understand where
39- you are based
40- - lnt and lng: latitude and longitude used to display a marker for your chapter in
41- a map
34+ 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+ ```
62+
63+ How to add an event
64+ -------------------
65+
66+ Before sending an event, you need to have your chapter set up. See the section * How to
67+ add your chapter* for more information on how to do it.
68+
69+ You can also add a sponsor, to give credit to the companies/institutions supporting your
70+ group with a venue, pizzas, beers... And if you are sprinting in a project not in the
71+ system, you may also want to add it.
72+
73+ To create an event, you need to add a new file to the ` _posts ` directory with the file
74+ 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
76+ (only lowercase ascii letters and numbers, separating words with hyphens). For example
77+ ` 2017-12-31-django-bugfixing.md ` could be the name of a sprint "Django bugfixing"
78+ happening on December 31st of 2017.
79+
80+ The content of the file has a header section with some fields (started and finished with
81+ ---), and the main description of the event afterwards. This is the format:
82+
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+
104+ You may want to copy one of the last events in ` _posts ` to be used as reference.
42105
43106How does Jekyll work?
44107---------------------
0 commit comments