Skip to content

Commit

Permalink
Merge remote-tracking branch 'prebid/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
HuddledMasses committed Mar 25, 2022
2 parents 24a491d + 6e09447 commit 1cce622
Show file tree
Hide file tree
Showing 511 changed files with 14,785 additions and 3,072 deletions.
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Thanks for improving the documentation 😃
Please give a short description and check the matching checkboxes to help us review this as quick as possible.

## 🏷 Type of documentation

- [ ] new bid adapter
- [ ] update bid adapter
- [ ] new feature
- [ ] text edit only (wording, typos)
- [ ] bugfix (code examples)
- [ ] new examples

## 📋 Checklist

- [ ] Related pull requests in prebid.js or server are linked
- [ ] For new adapters check [submitting your adapter docs](https://docs.prebid.org/dev-docs/bidder-adaptor.html#submitting-your-adapter)
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This repository contains the source files for the Prebid.js documentation site at [Prebid.org](https://prebid.org).

Please see the sections below for more information.
Please see the sections below for more information:

+ [Contributing](#contributing)
+ [License](#license)
Expand All @@ -14,7 +14,7 @@ Please see the sections below for more information.

## Contributing

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

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

Expand All @@ -33,7 +33,7 @@ All docs are under the license shown in the `LICENSE` file in this directory.

## Prerequisites

The site uses [Jekyll](https://jekyllrb.com/), which is written in the [Ruby](https://www.ruby-lang.org/en/) language.
The site is hosted on GitHub pages, and uses [Jekyll](https://jekyllrb.com/) to generate the HTML. Jekyll is written in the [Ruby](https://www.ruby-lang.org/en/) language.

1. follow the instructions at https://jekyllrb.com/docs/installation/ for your OS
1. gem install github-pages
Expand All @@ -54,19 +54,20 @@ Before submitting a pull request, you should run the site locally to make sure y
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`
- `export JEKYLL_ENV=production`
- `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
Configuration file: /Users/me/git/prebid.github.io/_config.yml
Source: /Users/me/git/prebid.github.io
Destination: /Users/me/git/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
Auto-regeneration: enabled for '/Users/me/git/prebid.github.io'
Configuration file: /Users/me/git/prebid.github.io/_config.yml
Server address: http://127.0.0.1:8080/
Server running... press ctrl-c to stop.
...
Expand Down
Loading

0 comments on commit 1cce622

Please sign in to comment.