This repository contains the source files for the Prebid.js documentation site at Prebid.org.

Please see the sections below for more information.

• Contributing
• License
• Prerequisites
• Running Jekyll Locally
• The Downloads Page
• Thanks

Contributing

Thanks in advance for your contribution! Contributors are listed in the Thanks section below.

For smaller changes, such as fixing a typo or adding a new section to an existing page, submit a pull request.

For larger changes such as reorganizing the site and moving/removing content, you may want to open an issue so we can discuss the work beforehand. This is a good idea because:

• We want to value your time, so you don't do unnecessary work
• We want to value our users' time; we don't want to break links and bookmarks for users

License

All docs are under the license shown in the LICENSE file in this directory.

Prerequisites

The site uses Jekyll, which is written in the Ruby language.

To follow the instructions in the next section, you will need to install the Bundler Ruby gem.

Try the following command:

$ gem install bundler

If you are on a Mac and the above command fails with a permissions error (e.g., "ERROR: While executing gem ... You don't have write permissions for the /Library/Ruby/Gems/... directory."), try the following steps:

1. Build your own ruby binary using Homebrew: brew install ruby. The Homebrew-built Ruby should include its own version of the gem command which avoids modifying system libraries.
2. Try gem install bundler again. If it still fails, try sudo gem install bundler. After that, you should be able to avoid any further use of sudo by running bundler with the arguments shown in the next section.

Running Jekyll Locally

Before submitting a pull request, you should run the site locally to make sure your edits actually work.

To get started editing the site and seeing your changes, clone this repo and enter the following commands in your terminal:

• cd /path/to/prebid.github.io

• bundle install --path vendor/bundle

• bundle exec jekyll serve

You should see output that looks something like this:

Configuration file: /Users/rloveland/Dropbox/Code/prebid.github.io/_config.yml  
            Source: /Users/rloveland/Dropbox/Code/prebid.github.io  
       Destination: /Users/rloveland/Dropbox/Code/prebid.github.io/_site  
 Incremental build: disabled. Enable with --incremental  
      Generating...   
                    done in 13.596 seconds.  
 Auto-regeneration: enabled for '/Users/rloveland/Dropbox/Code/prebid.github.io'  
Configuration file: /Users/rloveland/Dropbox/Code/prebid.github.io/_config.yml  
    Server address: http://127.0.0.1:8080/  
  Server running... press ctrl-c to stop.  
...  
...  

Open the Server address URL in your browser, and you should see a locally running copy of the site.

The Downloads Page

Please don't submit PRs to the Prebid.org downloads page. That page gets updated in tandem with the Prebid.js release process.

The Downloads page is generated from the Markdown bidder adapter docs, so the process for updating is:

1. Your adapter code is merged into Prebid.js
2. Your bidder docs PR is submitted over here to the docs site
3. Your adapter code is included with a release
4. Once your adapter code is actually released, we merge the adapter docs PR, and the Downloads page is automagically updated with a checkbox to include your adapter.

This means an adaptor is not available to download from Prebid.org as soon as the code gets merged into Prebid.js - it will be available after the next release (usually in a couple of weeks).

Thanks

Many thanks to the following people who have submitted content to Prebid.org. We really appreciate the help!