Drop AOL and Wordpress login links
[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 the Operations Working Group's [Banner Policy](https://operations.osmfoundation.org/policies/banner/) to know whether your event qualifies for a front-page banner.
8 2. Create the banner image.  The image needs to:
9    * be exactly 350px wide and at most 350px tall,
10    * be in PNG format,
11    * have nothing important in the top-right 60x60px corner of the banner which has a close 'X' button overlayed, and
12    * have sufficient visual contrast with the colours #cccccc and #999999 so the 'X' can be seen.
13 3. Prepare a pull request which includes the following:
14    * The banner should be saved under the [`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`)
15    * Edit [`config/banners.yml`](https://github.com/openstreetmap/openstreetmap-website/blob/master/config/banners.yml) to contain an entry for the event banner.  It should contain the following:
16      * `id` - a unique identifier (e.g. `donate2017`)
17      * `alt` - alt name for the image (e.g. `OpenStreetMap Funding Drive 2017`)
18      * `link` - URL for your event page (e.g. `https://donate.openstreetmap.org/`)
19      * `img` - the filename for the banner image (e.g. `banners/donate-2017.jpg`)
20      * `enddate` - the final date that the banner will be shown (e.g. `2017-oct-31`)
21    * (optional) Feel free to cleanup the old images from the `app/assets/images/banners/` folder and old entries in the `config/banners.yml` file.
22 4. The pull request must indicate when the banner should start being shown, which must be at least 7 days after the pull request was created.
23
24 See [PR #1296](https://github.com/openstreetmap/openstreetmap-website/pull/1296)
25 as an example.