About
+This is a Jekyll site that shows a live calendar of Research Software +Engineering related events.
+ +It is inspired and builds on:
+ +-
+
- Code Refinery’s +git-calendar-template +
- Jekyll minima theme +
diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..d98598d --- /dev/null +++ b/404.html @@ -0,0 +1,20 @@ + + +
Page not found :(
+The requested page could not be found.
+This is a Jekyll site that shows a live calendar of Research Software +Engineering related events.
+ +It is inspired and builds on:
+ +The calendar site is designed to show events only in one timezone (currently +Europe/London). +The ICalendar files built as part of the site deployment do support multiple +timezones but when contributing an event it’s important to ensure you contribute +your events with times adjusted for Europe/London.
+ +There are 2 main ways to contribute an event to the calendar:
+ + + +You can use the Add event GitHub Issue +template +to submit an issue that includes a yaml block with details of your event. +This will trigger a GitHub action workflow that automatically submits a pull request +with your event details to the project. Allowing you to contribute an event +without touching any code!
+ +When submitting using the GitHub issue you should ensure:
+ +If any field you enter contains a colon, you should wrap the field in +quotation marks to avoid the YAML parser interpreting the colon as a new key +i.e.
+ +❌ event_url: https://www.example.com
✅ event_url: "https://www.example.com"
If you enter a field over multiple lines like the description field make sure +the indentation level is the same across all lines +i.e.
+❌ description: |
+ My fantastic event
+ is going to be
+ amazing!
+
+✅ description: |
+ My fantastic event
+ is going to be
+ amazing!
+
To add an event to the calendar you can suggest a pull +request +to the repository that updates the main data file to add a new +event to the events section with the following YAML format:
+ +- summary: title of your event
+ description: |
+ A description of your event
+ over multiple
+ lines.
+ These should all be indented and have the same
+ indentation level as the first line.
+ Any URLs should be wrapped in brackets i.e. <www.example.com>
+ location: A location (virtual or in real life)
+ begin: YYYY-mm-DD HH:MM:SS
+ # duration should contain a unit of time: minute, day, hour
+ # and an numeric value
+ duration: { minutes: 45 }
+ event_url: A URL not wrapped in brackets linking to your event page
+
We’ll do our best to get to your pull request and merge it so your event is +shown on the website and in the calendar feed.
+ ++ Use the links below to subscribe to this calendar using .ics files. +
+ ++ Use the links below to subscribe to this calendar using .ics files. +
+ +You can subscribe to these calendars in your calendar program. This +will periodically import the events by polling the URL, so that you +get updates (usually with a few hours of delay). Most programs +implement this as creating a new calendar which can be toggled on or +off. Right click on the link above, “Copy link”, and then…
+ +Credit: These instructions are reused from Code Refinery’s + git-calendar-template
+ +