Adding and modifying events

Till Maas edited this page Nov 15, 2017 · 27 revisions
Clone this wiki locally

How to Add Events Important to Your Community to the Open Source Community Calendar

Simply browse to the event on GitHub and click the "edit" button to edit the file. (For quick reference: Events for 2018 are located in the 2018 directory.)

If there's no file for your conference yet, you can click on the "+" page icon to create a new file. Please reference another file, look at the simple example below, or consult the extensive documentation on formatting.

The filename should be formatted like this: FooConference Bar.yml (spaces and dashes are allowed, StudlyCaps are encouraged, but underscores are slightly frowned upon). The filename is important for everyone editing the repository, but the conference name will be extracted from the data inside the file.

If you don't have commit access, GitHub will fork the repo where you can edit the file in your own local copy. After saving the file, send a pull request (detailed info). There's a button to do this at the top of the page of your own personal "fork."

Please try to use proper formatting. (But don't worry if it's not 100% correct — if there are errors, we'll fix them.)

Quick Copy-and-Paste-and-Edit Template

In case you're creating a new event and want to use a quick copy-and-paste-and-edit template, you can start with this:

start: 2013-11-31
end: 2013-11-31
description: |
  This is a Markdown block of text with conference info.

  Additional details about the conference are available
  [on the conference website](https://EXAMPLE.ORG/).


- title: FIRST TALK
  speaker: SOME NAME
  start: 2013-11-31 11:00 PDT
  end: 2013-11-31 11:30 PDT
  description: |
    EDIT and ADD your own description here, using Markdown.
    Lists are supported, too:

    * Foo
    * Bar

- title: SECOND TALK
  speaker: SOMEBODY ELSE
  start: 2013-11-31 12:00 PDT
  end: 2013-11-31 12:30 PDT
  description: |
    EDIT and ADD your own description here, using Markdown.
  • Text should not be in uppercase, unless needed. Text is only uppercase in the examples to make the it stand out a bit more.
  • Try to keep the conference names short. Do not put the year in the conference name. Years are specified by folder and dates.
  • If your event is virtually grouped instead of a conference (good for sessions on different dates, different locations, meetings on IRC, or videocasts), please format your events as a series (example of a series).

For additional formatting information, including how to format series and other information, please read the formatting document.

Also Acceptable

You may also file a new issue (also available: new issue pre-filled with the above template) in the issue tracker.

Please use the proper formatting still. Thanks!

If this looks intimidating, you may also contact anyone with access to the repository directly (via email to the OSAS list, for example). We'll be happy to help!