Merge remote-tracking branch 'prebid/master'

.github/pull_request_template.md

@@ -1,6 +1,9 @@
 <!--
 Thanks for improving the documentation 😃
 Please give a short description and check the matching checkboxes to help us review this as quick as possible.
+
+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

.github/workflows/ci.yml

@@ -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@v37
+        id: changed-files
+        with:
+          files: '**/*.md'
+          separator: ","
+      - uses: DavidAnson/markdownlint-cli2-action@v13
+        if: steps.changed-files.outputs.any_changed == 'true'
+        with:
+          globs: ${{ steps.changed-files.outputs.all_changed_files }}
+          separator: ","
+          config: '.markdownlint.json'

.gitignore

@@ -3,6 +3,7 @@ Gemfile.lock
 /dist/bootstrap
 /dist/jquery
 /.idea
+/.vscode
 .DS_Store
 /vendor
 /.bundle
@@ -12,6 +13,7 @@ Gemfile.lock
 
 # Files generated by `npm install`
 node_modules/
+!_sass/node_modules
 /.vs/prebid.github.io/v17/.suo
 /.vs/slnx.sqlite
 /.vs

.markdownlint.json

@@ -0,0 +1,9 @@
+{
+    "default": true,
+    "MD013": false,
+    "MD022": false,
+    "MD024": false,
+    "MD025": false,
+    "MD033": false,
+    "MD036": false
+}

Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
-gem 'github-pages', '>= 30'
+gem 'github-pages', '>= 228'
 
 gem "webrick", "~> 1.7"

README.md

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

_config.yml

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