Repository for the NSCoderNight website.
CSS HTML Ruby
Switch branches/tags
Nothing to show
Clone or download
Latest commit c889731 Jul 22, 2018

README.md

NSCoderNight

Welcome to the GitHub repository for the NSCoderNight website.

Branches

The master branch is for the files that are fed in to the Middleman static site generator framework by our Travis CI continuous build system. If you clone this repository or create your own branch, do it off of here.

The gh-pages branch is for the results of the static generation, and contains only the files for the actual website. This branch should be left alone.

Adding or Editing a Chapter

If you want to add a new chapter, or edit an existing chapter, please clone this repository (if you're not a contributor) or create a branch (if you are) and submit a pull request.

Chapter Files

Chapter files are located in the top-level [chapters](chapters) folder on the master branch.

Each chapter has its own file, whose name is a lowercase version of the chapter name, with dashes instead of spaces. For example: "san-francisco.yaml" for the San Francisco branch. Dashes also convert to dashes, so Raleigh-Durham corresponds to "raleigh-durham.yaml".

Chapter File Format

Here is a sample chapter file, called my-city.yaml.
---
name: My City
organizers:
  - name: Valerie Davies
    twitter: v_davies
  - name: Elon Deforest
    website: http://www.eforest.com
twitter: MyCity
website: http://nscodernightmycity.com
meetings:
  - name: West End
    start_time: '19:00'
    location: |
        <a href="http://www.yelp.com/biz/west-end-cafe">West End Cafe</a>
        125 Westerly Road
  - name: East End
	day: Every Tuesday
    start_time: 7:00 p.m.
    end_time: 10:00 p.m.
    location: |
        <a href="http://www.yelp.com/biz/east-end-cafe">East End Cafe</a>
        521 Easterly Road
province: MN
country: USA

Each chapter file must start with three dashes follow by a return.

The name field is required and, as described above, must correspond to the filename.

The organizers field describes the one or more organizers of your chapter. If there is no organizer, leave out the organizers field entirely.

Each organizer should have a name field and may have twitter, website, email, and phone fields. The Twitter, website, and email fields are turned into links. Email is not currently obfuscated in any way. Put each of these fields on their own line after the organizers line, indented 4 spaces. For the first field of an organizer, the third space should instead be a dash.

You can have as many organizers as you want, and they will be listed in the order they appear in this file.

The twitter and website fields are for the chapter as a whole, and are optional. If you have more than one URL for the chapter, you can instead use the websites field, like so:

websites:
	- http://website1.com
	- http://website2.org
	- http://website3.io

The meetings field describes the one or more meetings of your chapter, is, just like the organizers field describes multiple organizers. The format is the same.

The meeting name name field is optional. Don't use if your chapter has only one meeting; instead, use it to distinguish between multiple meetings.

The meeting day field is optional, but if it is missing, the text "Every Tuesday" will be used.

The meeting start_time and end_time fields are optional. If both are missing, "7:00 p.m." and "10:00 p.m." are used, respectively, for your meeting time.

If start_time is present but end_time is missing, then only the beginning time of your meeting will be displayed.

Also note, due to a peculiarity of our build system, if you use a time without a trailing "a.m." or "p.m.", such 19:00, you will need to put that text in single quotes or it will not be displayed incorrectly.

The meeting location field is the only multi-line value. The first line of such a multi-line value must be just a pipe character (|). Subsequent lines must be indented four more spaces.

Also by custom, the first line is the name of the establishment used for the meeting, and is a link to the location, either the establishment's website, or a Google maps link to the address. Subsequent lines are the rest of the address. You can leave off city and state if it's the same as the chapter.

The province and country fields are the geographical information for the chapter. Country is required and is used for the chapter categories in the chapter list. Therefore, please be consistent and use the same country name as other existing chapters, such as "USA". Province should only be included for the United States or other countries where there are many chapters. For the United States, it should be the two-letter state code.

Please look at the existing chapter files for reference. Feel free to email us or open a GitHub issue if you have any questions.