Revised and moved README info.

README.md

@@ -9,60 +9,16 @@ This is the repo for managing [devopsdays.org](http://www.devopsdays.org).
 
 ## Contributing
 
-The technical details and guidelines for contributing to this repository are outlined in [CONTRIBUTING.md](https://github.com/devopsdays/devopsdays-web/blob/master/CONTRIBUTING.md). If you intend to contribute (and we sure hope you do!), please take a moment to review that document.
+The technical details and guidelines for contributing to this repository are outlined in [CONTRIBUTING.md](CONTRIBUTING.md). If you intend to contribute (and we sure hope you do!), please take a moment to review that document.
 
-## Creating a new event
+## Managing event content
 
-The easiest way to create a new event is with the [make_new_event.sh](https://github.com/devopsdays/devopsdays-web/blob/master/make_new_event.sh) script. Create a branch, run the script to make a skeleton site for your event, make any desired edits, and submit a PR as explained above.
-
-1. If your city name has special characters or diacritics, the script will remove them when it creates the event stub.
-1. Events need a data file in `data/events`, for example, `data/events/2015-chicago.yml`. It must be the same name as the directory you will create for your event. See the [template data file](https://github.com/devopsdays/devopsdays-web/blob/master/yyyy-city.yml) for an example.
-1. When the script copies the content directory from the sample site to `content/events/YYYY-city`, it removes `draft = true` from the frontmatter of the pages (so they will be built). Also, the `welcome.md` file needs to have a field added to its frontmatter for the alias, i.e., `aliases = ["/events/2015-chicago"]`.
-
-Once you have created a logo graphic, you will want to add it to the following directory (creating the directory if necessary) `/static/events/yyyy-city/logo.png`. The file MUST be called `logo.png`.
-
-### Special characters in city names
-
-If your city has either spaces, or accented characters, you will want to add the optional parameter `displayname` to your `yyyy-city.yml`. The `name` and `city` parameters need to be named with "URL-friendly" (i.e., ASCII, no spaces), but `displayname` can have whatever you want in it.
-
-For example, for Zürich, your event directory would be `2016-zurich`, and the data file would have the following elements:
-```
-name: "2015-zurich"
-year: 2015
-city: "Zurich"
-displayname: "Zürich"
-```
-
-## Adding sponsors
-
-Sponsors each need a file in the data directory, as such: `data/sponsors/chef.yml`. Please make sure to use the year for the sponsor (just so that the old events don't end up with newer sponsor logos, etc - but don't make one just for your city). If there is an existing sponsor and you can use it, you do not need to create the data file (or the image). If your information is different, please create a new file, such as `data/sponsors/chefchicago.yml`.  (Note: there is an experimental feature for an "override" of the sponsor data; more on this feature as it is developed)
-
-Put the images for your sponsors in the `/static/img/sponsors` directory. They need to be PNG files and named exactly after the name of the sponsor in your event file (and the corresponding sponsor data file), i.e., `/static/img/sponsors/chef.png`.
-
-### Sponsor logo guidelines
-
-There are a few simple guidelines regarding sponsor logo files and formatting:
-
-* The dimensions of the image file must be 200px square.
-* The background must be either white or transparent.
-* There must *not* be a border.
-
-All logos will be constrained, via markup, to 100px square; combined with the image file dimensions, this allows for high-density display (ex. Retina) compatibility.
-
-Note that a border will be drawn around the logo using CSS, so the logo shouldn't have one already.
-There is a small helper script "mk_sponsor_logo.sh" in the `/static/img/sponsors` directoy which will convert a logo centered into the right dimensions.
-
-## Speakers & Program
-
-The program is driven by the program.md file in your event (copied from the [sample program.md](https://raw.githubusercontent.com/devopsdays/devopsdays-web/master/content/events/sample-event/program.md). To generate a data-driven program, look at the Minneapolis 2016 [speakers data files](https://github.com/devopsdays/devopsdays-web/tree/master/data/speakers/2016/minneapolis) and [program directory](https://github.com/devopsdays/devopsdays-web/tree/master/content/events/2016-minneapolis/program).
-
-### Speaker Images
-The headshots for your speaker images should be exactly 500px wide (they display at 250px wide, but upload them at 500px wide in order to make them look good on retina displays). They must be in JPG format and named with the `.jpg` extension.
+Instructions and utilities are available for [managing sponsors, events, speakers, and more](utilities/README.md).
 
 ## Binary files
 
 Generally speaking, you should avoid storing any files other than logos or small images inside the repo itself (out of consideration for your fellow devopsdays organizers who have to pull down this repo). Please follow these guidelines:
 
 * Do not upload presentations, artifacts from your event, etc. Either link to the preso on Speakerdeck/Slideshare from the presenter, or even better, create a Speakerdeck account for your event and put the presos there.
 * Small, web images are fine (logos, etc). If you have high-resolution versions of your logo to share with others, please do not host them on the devopsdays-web repo.
-* It is acceptable to add in a single PDF for your sponsor prospectus if you desire (in `/static/events/YYYY-city`), but please keep this file under 3 MB. It is better to host it on Google Drive or something similar, and then link to it from your site.
+* It is acceptable to add in a single PDF for your sponsor prospectus if you desire (in `static/events/YYYY-city`), but please keep this file under 3 MB. It is better to host it on Google Drive or something similar, and then link to it from your site.

utilities/README.md

@@ -0,0 +1,58 @@
+# Utilities
+These scripts help devopsdays organizers manage their events.
+
+## Contributing
+
+The technical details and guidelines for contributing to this repository are outlined in [CONTRIBUTING.md](../CONTRIBUTING.md).
+
+New utilities and updates to existing utilities are welcome, as are suggestions for default content.
+
+## Events
+
+Use [make_new_event.sh](make_new_event.sh) to create a new event.
+
+1. If your city name contains spaces or special characters, the script will remove them for purposes of the event stub, which will be used in the URL and have a name like `yyyy-city`.
+1. The script will create a data file for your event in `data/events/yyyy-city.yml`. This is where you will configure many of your updates and customizations. In particular, you need to list your local organizer team here.
+1. The script will populate your event directory in `content/events/yyyy-city` with default content. You should edit it as desired.
+1. Once you have created a logo graphic, place it in `static/events/yyyy-city/logo.png`. (The file MUST be called `logo.png`.) The sample welcome page has a commented-out element to display a logo named in this way.
+
+## Sponsors
+
+Many sponsors are sponsors for multiple devopsdays. If a sponsor listing already exists with the correct information, you can just add them to your datafile.
+
+The sample datafile has some sponsor levels pre-populated; edit as desired. You will want to decide what's in your sponsor packages before accepting most types of sponsors (other than Community).
+
+### Creating a new sponsor
+
+1. Sponsors need a file in the data directory, as such: `data/sponsors/sponsorname.yml`.
+1. Put the images for your sponsors in the `static/img/sponsors` directory. They need to be PNG files and named exactly after the name of the sponsor in your event file (and the corresponding sponsor data file), i.e., `static/img/sponsors/sponsorname.png`.
+1. Add the new sponsor to your event's datafile with the appropriate level.
+
+See [make_sponsors.rb](make_sponsors.rb).
+
+### Updating a sponsor
+
+If you want to update a sponsor, keep in mind that we don't want to retroactively change history for past events. See this [previous discussion](https://github.com/devopsdays/devopsdays-web/pull/503) for guidance.
+
+### Sponsor logos
+
+Guidelines regarding sponsor logo files and formatting:
+
+* The dimensions of the image file must be 200px square.
+* The background must be either white or transparent.
+* There must *not* be a border (one will be added using CSS).
+
+All logos will be constrained, via markup, to 100px square; combined with the image file dimensions, this allows for high-density display (ex. Retina) compatibility.
+
+Use [resize_sponsor_logo.sh](resize_sponsor_logo.sh) to convert a logo centered into the right dimensions.
+
+## Speakers
+
+Use [add_speakers.sh](add_speakers.sh) to add speakers and talks to an existing event. Allow the "speakers" item in the navigation for a link.
+
+### Program
+
+The program is driven by the program.md file in your event (copied from the [sample program.md](examples/sample-event/program.md). To generate a data-driven program, use [add_speakers.sh](add_speakers.sh) and then link to the talks from your program.md file. Allow the "program" item in the navigation for a link.
+
+### Speaker Images
+The headshots for your speaker images should be exactly 500px wide. (They display at 250px wide, but add them at 500px wide in order to make them look good on retina displays.) They must be in JPG format and named with the `.jpg` extension.