From a3e6fdc8acafe063fa3a2fcb1b8fae7db83c8cae Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 10:18:59 +1000 Subject: [PATCH 01/12] Modified installation instructions --- README.md | 64 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 38 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 25ebc49..77a3ea3 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,20 @@ -# Discourse-Adplugin +# Official Discourse Advertising Plugin + +This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. -Ad plugin for Discourse forum. ## Installation +There are three sets of installation instructions: + +1. **Docker Installation** - If you have a live Discourse forum and minimal programming experience. **Recommended**. +2. Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory. +3. Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory. + * Supported Discourse version: v1.4 -### Special Installation Instructions for RGSoC Coaches -* You would have already gotten the discourse to load locally. If not, do that first. You can find instructions [here](https://github.com/team-melbourne-rgsoc2015/discoursetest-avn). -* Then clone this repo in a new local folder. -* In the terminal, go into your discourse folder and then into plugins. Example ```cd ~/code/discourse/plugins``` -* Create a symlink in this folder and do that by doing: - -``` -ln -s ~/whereever_your_cloned_ad_plugin_path_is . - -For example: ln -s ~/discourse-plugin-test . - -``` -Now you are done. See 'Usage' heading for sample ad codes that you can input. - - -### Non-docker installation - -* Run `bundle exec rake plugin:install repo=http://github.com/team-melbourne-rgsoc2015/discourse-adplugin` in your discourse directory -* In development mode, run `bundle exec rake assets:clean` -* In production, recompile your assets: `bundle exec rake assets:precompile` -* Restart Discourse - -### Docker installation +### 1. Docker Installation (For Live Discourse Forums) As seen in a [how-to on meta.discourse.org](https://meta.discourse.org/t/advanced-troubleshooting-with-docker/15927#Example:%20Install%20a%20plugin), simply **add the plugin's repo url to your container's app.yml file**: @@ -50,6 +35,33 @@ git pull ./launcher rebuild app ``` +### 2. Non-docker installation + +* Run `bundle exec rake plugin:install repo=http://github.com/team-melbourne-rgsoc2015/discourse-adplugin` in your discourse directory +* In development mode, run `bundle exec rake assets:clean` +* In production, recompile your assets: `bundle exec rake assets:precompile` +* Restart Discourse + + +### 3. Local Development Installation + +* Clone the [Discourse Adplugin Repo](http://github.com/team-melbourne-rgsoc2015/discourse-adplugin) in a new local folder. +* Separately clone [Discourse Forum](https://github.com/discourse/discourse) in another local folder. +* In your terminal, go into Discourse folder navigate into the plugins folder. Example ```cd ~/code/discourse/plugins``` +* Create a symlink in this folder by typing the following into your terminal +: +``` +ln -s ~/whereever_your_cloned_ad_plugin_path_is . + +For example: ln -s ~/discourse-plugin-test . + +``` +* You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run ```rails s``` in your locally held Discourse Forum files. + + + + + ## Usage @@ -136,7 +148,7 @@ Max H: 90 or lower of ad, W: 1000 left align. ## License -GPL v2 +GPL v2 or MIT? TO-DO: From 5274f65b62250fbe7c4d56c0fb37fe3ece1ee70f Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 10:31:32 +1000 Subject: [PATCH 02/12] Restructured usage for plan and fixed up formatting in installation --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 77a3ea3..2b25c75 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,22 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. +**Supported Discourse Version**: 1.4 +**Supported Ad Platforms**: [Google Adsense](http://www.google.com.au/adsense/start/why-adsense.html), [Google Double Click for Publishers](https://www.google.com/dfp) + ## Installation There are three sets of installation instructions: -1. **Docker Installation** - If you have a live Discourse forum and minimal programming experience. **Recommended**. +1. **Docker Installation - Recommended ** - If you have a live Discourse forum and minimal programming experience. 2. Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory. 3. Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory. * Supported Discourse version: v1.4 -### 1. Docker Installation (For Live Discourse Forums) +### 1. Docker Installation - Recommended As seen in a [how-to on meta.discourse.org](https://meta.discourse.org/t/advanced-troubleshooting-with-docker/15927#Example:%20Install%20a%20plugin), simply **add the plugin's repo url to your container's app.yml file**: @@ -27,7 +30,7 @@ hooks: - mkdir -p plugins - git clone https://github.com/team-melbourne-rgsoc2015/discourse-adplugin.git ``` -* Rebuild the container +Rebuild the container ``` cd /var/docker @@ -52,19 +55,22 @@ git pull : ``` ln -s ~/whereever_your_cloned_ad_plugin_path_is . - For example: ln -s ~/discourse-plugin-test . - ``` * You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run ```rails s``` in your locally held Discourse Forum files. - - - ## Usage + +Note TODO: +After installation users likely want to: +- Choose platform. +- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. +- Display ad. + + * Go to Admin > Settings > Ad Plugin * Add DFP link into code boxes, input width and height based on Google Ad Ad units. Here are some sample ad codes that you can put in the input into the settings. But remember: ⋅⋅* Each slot requires a different sample ad code. That means, you cannot put the same ad sample ad codes multiple times in different slots. They won't appear. @@ -90,6 +96,7 @@ The namings in settings are with reference to the plugin outlets created by Disc `dfp_nth_post_code` and ensure your total number of posts in topic >=N. For example, if you input N = 4, the forum should have at least 4 replies/posts) + ### Sample DFP Ad Codes: 1. /142953540/PostandCourier/Postandcourier.com/News/Leaderboard_Bottom 2. /6355419/Travel/Europe/France/Paris @@ -150,9 +157,3 @@ Max H: 90 or lower of ad, W: 1000 left align. GPL v2 or MIT? -TO-DO: - -* Fix up the image loading issue in Readme. -* Publisher ID support -* Trust levels -* More ad providers! From 0f2341115d25a44b17778e888dcbb13af62549cf Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 10:37:25 +1000 Subject: [PATCH 03/12] Paragraphing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b25c75..6d6f643 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. -**Supported Discourse Version**: 1.4 +**Supported Discourse Version**: 1.4

**Supported Ad Platforms**: [Google Adsense](http://www.google.com.au/adsense/start/why-adsense.html), [Google Double Click for Publishers](https://www.google.com/dfp) From 9ca46b81288f0f68bfce0edf79df4d01ebe5bf18 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 10:42:45 +1000 Subject: [PATCH 04/12] Further modification --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 6d6f643..59fad16 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,10 @@ This is the official Discourse advertising plugin. It allows advertisements to There are three sets of installation instructions: -1. **Docker Installation - Recommended ** - If you have a live Discourse forum and minimal programming experience. +1. **Docker Installation - Recommended** - If you have a live Discourse forum and minimal programming experience. 2. Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory. 3. Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory. -* Supported Discourse version: v1.4 - ### 1. Docker Installation - Recommended From 57d12604c59bea385ab4e267ebe4c45de715415b Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:17:15 +1000 Subject: [PATCH 05/12] Changed structure for quick start installation --- README.md | 118 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 59fad16..370ead7 100644 --- a/README.md +++ b/README.md @@ -3,21 +3,25 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. **Supported Discourse Version**: 1.4

-**Supported Ad Platforms**: [Google Adsense](http://www.google.com.au/adsense/start/why-adsense.html), [Google Double Click for Publishers](https://www.google.com/dfp) +**Supported Ad Platforms**: + +* [Google Adsense](http://www.google.com.au/adsense/start/why-adsense.html) +* [Google Double Click for Publishers](https://www.google.com/dfp) -## Installation +## Quick Start in 3 Steps (Recommended Installation & Usage) -There are three sets of installation instructions: +Recommended if you have: -1. **Docker Installation - Recommended** - If you have a live Discourse forum and minimal programming experience. -2. Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory. -3. Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory. +* A live discourse forum +* You have deployed that forum using Docker. Most people using Digital Ocean will have deployed Discourse using Docker. + +For installation for non-docker or local development (those with programming experience, see Other Installation) + +### Step 1 - Install the Official Discourse Advertising Plugin -### 1. Docker Installation - Recommended - -As seen in a [how-to on meta.discourse.org](https://meta.discourse.org/t/advanced-troubleshooting-with-docker/15927#Example:%20Install%20a%20plugin), simply **add the plugin's repo url to your container's app.yml file**: +As seen in a [how-to on meta.discourse.org](https://meta.discourse.org/t/advanced-troubleshooting-with-docker/15927#Example:%20Install%20a%20plugin), simply **add the plugin's repository url to your container's app.yml file**: ```yml hooks: @@ -36,33 +40,12 @@ git pull ./launcher rebuild app ``` -### 2. Non-docker installation +### Step 2 - Configure Your Settings to Display Your Advertisments -* Run `bundle exec rake plugin:install repo=http://github.com/team-melbourne-rgsoc2015/discourse-adplugin` in your discourse directory -* In development mode, run `bundle exec rake assets:clean` -* In production, recompile your assets: `bundle exec rake assets:precompile` -* Restart Discourse - - -### 3. Local Development Installation - -* Clone the [Discourse Adplugin Repo](http://github.com/team-melbourne-rgsoc2015/discourse-adplugin) in a new local folder. -* Separately clone [Discourse Forum](https://github.com/discourse/discourse) in another local folder. -* In your terminal, go into Discourse folder navigate into the plugins folder. Example ```cd ~/code/discourse/plugins``` -* Create a symlink in this folder by typing the following into your terminal -: -``` -ln -s ~/whereever_your_cloned_ad_plugin_path_is . -For example: ln -s ~/discourse-plugin-test . -``` -* You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run ```rails s``` in your locally held Discourse Forum files. - - - -## Usage - - -Note TODO: +TBC +Add GIFS, Images +✘ this is a cross +✓ this is a tick After installation users likely want to: - Choose platform. - Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. @@ -93,8 +76,6 @@ The namings in settings are with reference to the plugin outlets created by Disc `dfp_nth_post_code` and ensure your total number of posts in topic >=N. For example, if you input N = 4, the forum should have at least 4 replies/posts) - - ### Sample DFP Ad Codes: 1. /142953540/PostandCourier/Postandcourier.com/News/Leaderboard_Bottom 2. /6355419/Travel/Europe/France/Paris @@ -118,18 +99,52 @@ This is how the ads should display is all is working fine.... (ads also change s **Location: Above Suggested Topic** ![](https://www.dropbox.com/sc/cnkialxmcfust55/ad-display-3-above-suggested.png?dl=1) - - * Finally, if you wish to disable the ad, tick ad disabling box -# Ad Providers Supported +### Step 3 - See Your Ad -* Google DFP +TBC -# Potential Ad Sizes -Restricted container: -Max H: 300 or lower of ad, W: 1000 left align. + +## Other Installation - Non-Docker Installation and Local Development + +There are two sets of installation instructions: + +1. Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory. +2. Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory. + +If you already have a live Discourse forum up, please go to the Quick Start heading above. + + +### 1. Non-docker installation + + +* Run `bundle exec rake plugin:install repo=http://github.com/team-melbourne-rgsoc2015/discourse-adplugin` in your discourse directory +* In development mode, run `bundle exec rake assets:clean` +* In production, recompile your assets: `bundle exec rake assets:precompile` +* Restart Discourse + + +### 2. Local Development Installation + + +* Clone the [Discourse Adplugin Repo](http://github.com/team-melbourne-rgsoc2015/discourse-adplugin) in a new local folder. +* Separately clone [Discourse Forum](https://github.com/discourse/discourse) in another local folder. +* In your terminal, go into Discourse folder navigate into the plugins folder. Example ```cd ~/code/discourse/plugins``` +* Create a symlink in this folder by typing the following into your terminal +: +``` +ln -s ~/whereever_your_cloned_ad_plugin_path_is . +For example: ln -s ~/discourse-plugin-test . +``` +* You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run ```rails s``` in your locally held Discourse Forum files. + + + +## Advertisement Sizes Supported + +This plugin supports the following ad sizes: Topic list top, Topic top, Above Suggested - 728*90 @@ -151,7 +166,20 @@ Max H: 90 or lower of ad, W: 1000 left align. - 468*60 - 234*60 + +## Questions/Feedback/Contributing? + +Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitteing feature requests, if it's not somehting that most people will use, it probably won't get merged. + + +## Credits + +Discourse.org - Thanks to our mentor @eviltrout and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE +Rails Girls - Thanks @sareg0 and the Rails Girls Team. +Our Coaches - @LIST_OUT_THEIR_GITHUB_HANDLE + + ## License -GPL v2 or MIT? +TBC: GPL v2 or MIT From 49d6c52b014c86763b1ea473e279e87ece12ea71 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:37:46 +1000 Subject: [PATCH 06/12] Fixed up typos and added sample table --- README.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 370ead7..a72820f 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ This is the official Discourse advertising plugin. It allows advertisements to * [Google Double Click for Publishers](https://www.google.com/dfp) -## Quick Start in 3 Steps (Recommended Installation & Usage) +## Quick Start in 3 Steps -Recommended if you have: +This quick start shows you how to install this plugin and use it. Recommended if you have: * A live discourse forum * You have deployed that forum using Docker. Most people using Digital Ocean will have deployed Discourse using Docker. @@ -107,7 +107,7 @@ TBC -## Other Installation - Non-Docker Installation and Local Development +## Other Installation There are two sets of installation instructions: @@ -144,19 +144,16 @@ For example: ln -s ~/discourse-plugin-test . ## Advertisement Sizes Supported -This plugin supports the following ad sizes: +This plugin supports the following ad sizes for the following locations: -Topic list top, Topic top, Above Suggested -- 728*90 -- 336*280 -- 300*250 -- 960*90 -- 468*60 -- 234*60 -- 125*125 -- 180*150 -- 200*200 -- 250*250 +Advertisement locations: topic list top, topic above post stream and topic above suggested. + +--|--|-- + +728*90|336*280|300*250 +960*90|468*60|234*60 +125*125|180*150|200*200 +250*250|--|-- Post Bottom Max H: 90 or lower of ad, W: 1000 left align. @@ -169,7 +166,7 @@ Max H: 90 or lower of ad, W: 1000 left align. ## Questions/Feedback/Contributing? -Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitteing feature requests, if it's not somehting that most people will use, it probably won't get merged. +Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitting feature requests, if it's not something that most people will use, it probably won't get merged. ## Credits From 5d3ce940232802504ab11f778485d6d06cf890c3 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:39:41 +1000 Subject: [PATCH 07/12] Table of sizes --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a72820f..dfcf9f0 100644 --- a/README.md +++ b/README.md @@ -148,12 +148,14 @@ This plugin supports the following ad sizes for the following locations: Advertisement locations: topic list top, topic above post stream and topic above suggested. ---|--|-- -728*90|336*280|300*250 -960*90|468*60|234*60 -125*125|180*150|200*200 -250*250|--|-- + +--|--|-- +728*90 | 336*280 | 300*250 +960*90 | 468*60 | 234*60 +125*125 | 180*150 | 200*200 +250*250 | | +--|--|-- Post Bottom Max H: 90 or lower of ad, W: 1000 left align. From 58d48345620fad6a66a9f10b65b7716aa2a7489e Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:44:41 +1000 Subject: [PATCH 08/12] Table of location and sizes --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index dfcf9f0..432fe5b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ This quick start shows you how to install this plugin and use it. Recommended i * A live discourse forum * You have deployed that forum using Docker. Most people using Digital Ocean will have deployed Discourse using Docker. -For installation for non-docker or local development (those with programming experience, see Other Installation) +For installation for non-docker or local development (those with programming experience), see Other Installation. + ### Step 1 - Install the Official Discourse Advertising Plugin @@ -149,22 +150,20 @@ This plugin supports the following ad sizes for the following locations: Advertisement locations: topic list top, topic above post stream and topic above suggested. - +All locations except post bottom | Post bottom location | Mobile --|--|-- -728*90 | 336*280 | 300*250 -960*90 | 468*60 | 234*60 -125*125 | 180*150 | 200*200 -250*250 | | +728 x 90 | 728 x 90 | 320 x 50 +336 x 280 | 960 x 90 | +300 x 250 | 468 x 60 | +960 x 90 | 234 x 60 | +468 x 60 | | +234 x 60 | | +125 x 125 | | +180 x 150 | | +200 x 200 | | +250 x 250 | | --|--|-- -Post Bottom -Max H: 90 or lower of ad, W: 1000 left align. - -- 728*90 -- 960*90 -- 468*60 -- 234*60 - ## Questions/Feedback/Contributing? From fcee1ba621efe2e1352b945441a55bb76feab2c4 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:45:35 +1000 Subject: [PATCH 09/12] Check if tables are rendering --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 432fe5b..e9246a2 100644 --- a/README.md +++ b/README.md @@ -165,6 +165,15 @@ All locations except post bottom | Post bottom location | Mobile --|--|-- +Do tables work? + +Markdown | Less | Pretty +--- | --- | --- +*Still* | `renders` | **nicely** +1 | 2 | 3 + + + ## Questions/Feedback/Contributing? Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitting feature requests, if it's not something that most people will use, it probably won't get merged. From 8abed03dac6fe65e2c4d2d0408de88d1d1e9eb27 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:46:48 +1000 Subject: [PATCH 10/12] Fixed up tables --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index e9246a2..f8f474a 100644 --- a/README.md +++ b/README.md @@ -151,7 +151,7 @@ Advertisement locations: topic list top, topic above post stream and topic above All locations except post bottom | Post bottom location | Mobile ---|--|-- +--- | --- | --- 728 x 90 | 728 x 90 | 320 x 50 336 x 280 | 960 x 90 | 300 x 250 | 468 x 60 | @@ -162,7 +162,6 @@ All locations except post bottom | Post bottom location | Mobile 180 x 150 | | 200 x 200 | | 250 x 250 | | ---|--|-- Do tables work? From dbdd60dbf112f24a95dfda755d72f3c5b5dcbe1c Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 16:47:54 +1000 Subject: [PATCH 11/12] Table of sizes done --- README.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/README.md b/README.md index f8f474a..ec11cca 100644 --- a/README.md +++ b/README.md @@ -145,10 +145,7 @@ For example: ln -s ~/discourse-plugin-test . ## Advertisement Sizes Supported -This plugin supports the following ad sizes for the following locations: - -Advertisement locations: topic list top, topic above post stream and topic above suggested. - +This plugin supports the following ad sizes for the following locations. All locations except post bottom | Post bottom location | Mobile --- | --- | --- @@ -164,15 +161,6 @@ All locations except post bottom | Post bottom location | Mobile 250 x 250 | | -Do tables work? - -Markdown | Less | Pretty ---- | --- | --- -*Still* | `renders` | **nicely** -1 | 2 | 3 - - - ## Questions/Feedback/Contributing? Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitting feature requests, if it's not something that most people will use, it probably won't get merged. From 457274287c7c0206d1798423c771a17eeebf7336 Mon Sep 17 00:00:00 2001 From: Ladydanger Date: Thu, 3 Sep 2015 22:19:53 +1000 Subject: [PATCH 12/12] Added outline for usage in quick start --- README.md | 64 ++++++++++++++++++++++++++----------------------------- 1 file changed, 30 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index ec11cca..f05fc46 100644 --- a/README.md +++ b/README.md @@ -43,23 +43,36 @@ git pull ### Step 2 - Configure Your Settings to Display Your Advertisments -TBC +There are 2 easy steps for configuring your Discourse settings to enable advertisements to display in your Discourse forum. + +#### Step 2(a) - Choose Your Advertisement Platform + + +* Navigate to the Admin section in your Discourse forum. +* Click on Settings and a left vertical navigation bar should appear. +* Choose your advertisement platform by clicking on "Adsense Plugin" if using Adsense as your advertisement platform and/or click "DFP Plugin" if using the DoubleClick for Publishers advertisement platform. + + +#### Step 2(b)(i) - Input Your Details (Adsense) + +* Insert Image + Explain the code in the provided tag from ad provider. + + +#### Step 2(b)(ii) - Input Your Details (DoubleClick for Publishers) + +* Insert Image + Explain the code in the provided tag from ad provider. + + +// TO BE FIXED START Add GIFS, Images ✘ this is a cross ✓ this is a tick After installation users likely want to: -- Choose platform. +- Choose platform - DONE - Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. - Display ad. -* Go to Admin > Settings > Ad Plugin -* Add DFP link into code boxes, input width and height based on Google Ad Ad units. Here are some sample ad codes that you can put in the input into the settings. But remember: -⋅⋅* Each slot requires a different sample ad code. That means, you cannot put the same ad sample ad codes multiple times in different slots. They won't appear. -⋅⋅* Don't click on the ad. -⋅⋅* On the last stroke of midnight, the magic will wear off. Make sure you leave the ball before then. - -*Please test both plugins individually* - don't symlink both together, instead test them in isolation. Input 3 parts - ad code (topmost box), width, height. And be sure to untick the disable box. Then, refresh the page for the inputs to take effect, and go to the ad location. @@ -76,35 +89,16 @@ The namings in settings are with reference to the plugin outlets created by Disc `dfp_post_bottom_code`: ad will appear on the Nth post (be sure to input N in the bottom-most box called `dfp_nth_post_code` and ensure your total number of posts in topic >=N. For example, if you input N = 4, the forum should have at least 4 replies/posts) +// TO BE FIXED END -### Sample DFP Ad Codes: -1. /142953540/PostandCourier/Postandcourier.com/News/Leaderboard_Bottom -2. /6355419/Travel/Europe/France/Paris -3. /1047893/kv_home_bigbox1 - -This is how it looks like when you put it in site settings. -(Images here aren't showing atm - but you can go to [this link to see the ad codes and what the ads look like when they're loaded](https://meta.discourse.org/t/rails-girls-soc-banter/26875/53)). - -![](https://www.dropbox.com/sc/cyouv2pis3o4gx4/ad-codes-p1.png?dl=1) - -![](https://www.dropbox.com/sc/5z7sl2hdmtzv1ho/ad-codes-p2.png?dl=1) - -This is how the ads should display is all is working fine.... (ads also change so don't worry if your ads look different). - -**Location: Topic list top** -![](https://www.dropbox.com/sc/cbu0otlt2zl5kdw/ad-display-1-discovery-list.png?dl=1) - -**Location: Topic top** -![](https://www.dropbox.com/sc/cdx0duqkco7rs8s/ad-display-2-topic-top.png?dl=1) - -**Location: Above Suggested Topic** -![](https://www.dropbox.com/sc/cnkialxmcfust55/ad-display-3-above-suggested.png?dl=1) * Finally, if you wish to disable the ad, tick ad disabling box ### Step 3 - See Your Ad -TBC +Once you've configured your settings and your advertising platform has ads that are ready to serve, navigate to the page where you've inputted for the location and you should see ads. For example, a Discourse forum serving ads looks like this: + +INSERT_IMAGE_HERE @@ -161,9 +155,11 @@ All locations except post bottom | Post bottom location | Mobile 250 x 250 | | -## Questions/Feedback/Contributing? +## Questions or Want to Contribute? -Open an Issue on this repository to start a chat. Issues and Pull Requests are greatly appreciated. Bear in mind that when submitting feature requests, if it's not something that most people will use, it probably won't get merged. +Open an Issue on this repository to start a chat. + +Issues and Pull Requests are greatly appreciated. Bear in mind that when submitting feature requests, if it's not something that most people will use, it probably won't get merged. ## Credits