Add FAQ and information about creating a banner image
[rails.git] / FAQ.md
1 ## How do I create a banner to promote my OpenStreetMap event?
2
3 We occasionally display banner images on the main page of [openstreetmap.org](https://www.openstreetmap.org/) to
4 promote a large OpenStreetMap focused conference or host a worldwide donation
5 drive.  This is a great way to reach a lot of people!
6
7 1. Please review [openstreetmap/operations#150](https://github.com/openstreetmap/operations/issues/150) to
8 know whether your event qualifies for a front-page banner.
9
10 2. Create the banner image.  It should be 350px wide and saved in a standard
11 web image format (.gif, .jpg, .png).  Also note that a close 'X' will be drawn
12 over the top right 60x60px corner of the banner, so please do not put anything
13 important in that space.
14
15 3. Prepare a pull request which includes the following:
16   * The banner should be saved under the
17   [`app/assets/images/banners/`](https://github.com/openstreetmap/openstreetmap-website/tree/master/app/assets/images/banners) folder, and should have a name that makes it clear what it is for (e.g. `donate-2017.jpg`)
18   * Edit [`config/banners.yml`](https://github.com/openstreetmap/openstreetmap-website/blob/master/config/banners.yml)
19   to contain an entry for the event banner.  It should contain the following:
20     * `id` - a unique identifier (e.g. `donate2017`)
21     * `alt` - alt name for the image (e.g. `OpenStreetMap Funding Drive 2017`)
22     * `link` - URL for your event page (e.g. `https://donate.openstreetmap.org/`)
23     * `img` - the filename for the banner image (e.g. `banners/donate-2017.jpg`)
24     * `enddate` - the final date that the banner will be shown (e.g. `2017-oct-31`)
25   * (optional) Feel free to cleanup the old images from the `app/assets/images/banners/`
26   folder and old entries in the `config/banners.yml` file.
27
28 See [PR #1296](https://github.com/openstreetmap/openstreetmap-website/pull/1296)
29 as an example.