From 7e228a60f6a412e4777c40f8652e89a30bf7a1f3 Mon Sep 17 00:00:00 2001 From: Matthew Collins Date: Sun, 19 Aug 2018 13:25:24 -0400 Subject: [PATCH] Add contributing guide for events #12 --- CONTRIBUTING | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..20a4a47 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,23 @@ +# Contributing + +## Events + +Events are things that people can attend. They will have a time and location and +a planned schedule. A workshop, meet-up, rez-baz are events. Things like +elections and calls for proposals are not events and should be under news only. + +To add a new event: + +1. Create a new file in the `/_events` directory. Use the date as the first part +of the file name and the rest should be the lower-cased "slug" if it is a +Carpentries workshop or some other meaningfull abbreviation if it is something +else. +1. The file should contain YAML front matter. See an existing file for the +variables to set. +1. The remainder of the file can be empty if the `website` variable is set to an +outside site or it can be a description of the event if there is no outside +site. +1. If the `website` points to the event page on this site, it should be of the +form `/events//` +1. The start data controlls order on the page. The end date controls "upcoming" +or not.