Skip to content

Commit

Permalink
Merge remote-tracking branch 'root_branch/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
cmertv-sishigami committed Apr 3, 2024
2 parents 4d3a562 + c8ed5f6 commit 38cdb01
Show file tree
Hide file tree
Showing 1,556 changed files with 71,249 additions and 79,566 deletions.
3 changes: 0 additions & 3 deletions .bowerrc

This file was deleted.

11 changes: 8 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
<!--
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
Please make the PR writeable. This allows us to fix typos, grammar and linting errors ourselves, which makes
merging and reviewing a lot faster for everybody.
-->

## 🏷 Type of documentation

Check failure on line 9 in .github/pull_request_template.md

View workflow job for this annotation

GitHub Actions / run markdownlint

First line in a file should be a top-level heading

.github/pull_request_template.md:9 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## 🏷 Type of documentation"] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md041.md
<!-- Remove items that don't apply and/or select an item by changing [ ] to [x] -->
- [ ] new bid adapter
- [ ] update bid adapter
- [ ] new feature
Expand All @@ -11,6 +16,6 @@ Please give a short description and check the matching checkboxes to help us rev
- [ ] new examples

## 📋 Checklist

- [ ] Related pull requests in prebid.js or server are linked
<!-- Remove items that don't apply and/or select an item by changing [ ] to [x] -->
- [ ] Related pull requests in prebid.js or server are linked -> Paste link in this list or reference it on the PR itself
- [ ] For new adapters check [submitting your adapter docs](https://docs.prebid.org/dev-docs/bidder-adaptor.html#submitting-your-adapter)
31 changes: 31 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Continuous Integration

on:
pull_request:
branches:
- master
push:
branches:
- master

jobs:
# based on https://github.com/DavidAnson/markdownlint-cli2-action/blob/main/.github/workflows/changed.yml
# runs markdown lint only for changed files
markdownlint:
name: run markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v41
id: changed-files
with:
files: '**/*.md'
separator: ","
- uses: DavidAnson/markdownlint-cli2-action@v15
if: steps.changed-files.outputs.any_changed == 'true'
with:
globs: "${{ steps.changed-files.outputs.all_changed_files }},!_includes"
separator: ","
config: '.markdownlint.json'
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Gemfile.lock
/dist/bootstrap
/dist/jquery
/.idea
/.vscode
.DS_Store
/vendor
/.bundle
Expand All @@ -12,3 +13,7 @@ Gemfile.lock

# Files generated by `npm install`
node_modules/
!_sass/node_modules
/.vs/prebid.github.io/v17/.suo
/.vs/slnx.sqlite
/.vs
10 changes: 10 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"default": true,
"MD009": false,
"MD013": false,
"MD022": false,
"MD024": false,
"MD025": false,
"MD033": false,
"MD036": false
}
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.7.6
Binary file not shown.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
source 'https://rubygems.org'
gem 'github-pages', '>= 30'
gem 'github-pages', '>= 228'

gem "webrick", "~> 1.7"
64 changes: 38 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# docs.prebid.org source

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:

+ [Contributing](#contributing)
+ [License](#license)
+ [Prerequisites](#prerequisites)
+ [Running Jekyll Locally](#running-jekyll-locally)
+ [Building Assets](#building-assets)
+ [The Downloads Page](#the-downloads-page)
+ [Thanks](#thanks)
* [Contributing](#contributing)
* [License](#license)
* [Prerequisites](#prerequisites)
* [Running Jekyll Locally](#running-jekyll-locally)
* [Building Assets](#building-assets)
* [The Downloads Page](#the-downloads-page)
* [Thanks](#thanks)

<a name="contributing" />
<a name="contributing"></a>

## Contributing

Expand All @@ -20,32 +22,39 @@ For smaller changes, such as fixing a typo or adding a new section to an existin

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
* 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

<a name="license" />
<a name="license"></a>

## License

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

<a name="prerequisites" />
<a name="prerequisites"></a>

## Prerequisites

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. follow the instructions at [jekyllrb.com/docs/installation/](https://jekyllrb.com/docs/installation/) for your OS
1. gem install github-pages
1. start Jekyll as described below

For CSS, the site uses Laravel Mix to build CSS from Sass (scss-flavored) source files. Under the hood Laravel Mix uses Webpack.
For CSS, the site uses Jekyll board tools to compile SCSS down to CSS.

1. Install `boostrap` via `npm install` to make the build work
1. [Jekyll assets management](https://jekyllrb.com/docs/assets/)
1. [Jekyll SASS plugin](https://jekyllrb.com/docs/configuration/sass/)

The markdown files are linted via [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). VSCode supports the [.markdownlintignore](.markdownlintignore) file.
You may need to configure the disabled rules specified in [.markdownlint.json](.markdownlint.json) directly in your project settings. You can invoke linting in CLI via

1. follow the instructions at https://nodejs.dev to install Node.js for your OS
1. `npm ci` to install packages for building assets
1. build assets as described below
```bash
markdownlint --config .markdownlint.json --ignore-path .markdownlintignore "**/*.md"
```

<a name="running-jekyll-locally" />
<a name="running-jekyll-locally"></a>

## Running Jekyll Locally

Expand All @@ -54,13 +63,12 @@ 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:

```bash
$ JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
```


You should see output that looks something like this:

```
```bash
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
Expand All @@ -77,13 +85,13 @@ Configuration file: /Users/me/git/prebid.github.io/_config.yml

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

<a name="building-assets"/>
<a name="building-assets"></a>

## Building Assets

- `npm run dev` to build unminified CSS for development
- `npm run prod` to build minified CSS for production
- `npm run watch` to use [Browsersync](https://browsersync.io) to rebuild CSS on demand and reload the browser
* `npm run dev` to build unminified CSS for development
* `npm run prod` to build minified CSS for production
* `npm run watch` to use [Browsersync](https://browsersync.io) to rebuild CSS on demand and reload the browser

## The Downloads Page

Expand All @@ -98,7 +106,11 @@ The Downloads page is generated from [the Markdown bidder adapter docs](https://

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).

<a name="thanks" />
<a name="thanks"></a>

## Liquid Templating

* [jekyll - check for non empty](https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/jekyll/liquid/conditionals/non-empty.html)

## Thanks

Expand Down
44 changes: 0 additions & 44 deletions _assets/sass/components/_search.scss

This file was deleted.

43 changes: 0 additions & 43 deletions _assets/sass/main.scss

This file was deleted.

13 changes: 0 additions & 13 deletions _assets/sass/pages/_404.scss

This file was deleted.

17 changes: 0 additions & 17 deletions _assets/sass/vendor/_bootstrap.scss

This file was deleted.

2 changes: 0 additions & 2 deletions _assets/sass/vendor/_bourbon.scss

This file was deleted.

2 changes: 0 additions & 2 deletions _assets/sass/vendor/_include-media.scss

This file was deleted.

5 changes: 4 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# name of the software
name: Prebid
# GitHub Metadata: site.name is set in _config.yml, but many plugins and themes expect site.title to be used instead
title: Prebid
# current version of the software
version: 1.0.0
# licence of the software
Expand Down Expand Up @@ -85,7 +87,8 @@ collections:

port: 8080

exclude: ['README.md', 'LICENSE', 'bower.json', 'Gemfile.lock', 'Gemfile', 'vendor', 'node_modules', '_assets', 'mix-manifest.json', 'webpack.mix.js', 'find-ungrouped-bidders.sh' ]
exclude: ['README.md', 'LICENSE', 'Gemfile.lock', 'Gemfile', 'vendor', 'find-ungrouped-bidders.sh' ]
include: ['node_modules']

keep_files:
- assets/css/main-bundle.css
Expand Down
2 changes: 1 addition & 1 deletion _data/dropdown_v2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@
sectionId: 3
sectionName: Download
title: Prebid Mobile
link: /prebid-mobile/download.html
link: /prebid-mobile/prebid-mobile-download.html
needsDivider: 0
isHeader: 0
isSubSectionStart: 1
Expand Down
10 changes: 5 additions & 5 deletions _data/partners.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,6 @@
imgURL: /assets/images/partners/tech/beachfront_logo.png
type: technology

- company: Conversant
link: https://www.conversantmedia.com/
imgURL: /assets/images/partners/tech/conversant_logo.png
type: technology

- company: Criteo
link: https://www.criteo.com/for-publishers/products/criteo-direct-bidder/
imgURL: /assets/images/partners/tech/criteo.png
Expand All @@ -58,6 +53,11 @@
imgURL: /assets/images/partners/tech/datablocks_logo.png
type: technology

- company: Epsilon
link: https://www.epsilon.com/
imgURL: /assets/images/partners/tech/epsilon_logo.png
type: technology

- company: LiveRamp
link: https://liveramp.com/
imgURL: /assets/images/partners/tech/LiveRamp-Logo.png
Expand Down
Loading

0 comments on commit 38cdb01

Please sign in to comment.