From 189e1490815282135bf6895aaab21eb24e3e370c Mon Sep 17 00:00:00 2001 From: vi Date: Tue, 1 Sep 2015 10:28:47 +1000 Subject: [PATCH 01/27] Modified readme for todo and changed name of plugin for dfp --- README.md | 69 +++++++----------------------------- config/locales/client.en.yml | 2 +- plugin.rb | 4 +-- 3 files changed, 15 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 25ebc49..0338974 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,8 @@ Ad plugin for Discourse forum. * 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 - +* Supported Ad Platforms: Google Adsense and Doubleclick for Publishers + ### Docker installation 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**: @@ -53,17 +32,14 @@ git pull ## Usage -* 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. +* Go to Admin > Settings > DFP Plugin / Adsense Plugin + +# DFP -*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. -Usually google sizes to input are (width*height) 300*250 or 728*90 (best) respectively. Input your dfp ad code. +Usually google sizes tDOcso input are (width*height) 300*250 or 728*90 (best) respectively. Input your dfp ad code. The namings in settings are with reference to the plugin outlets created by Discourse. @@ -78,10 +54,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 -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)). @@ -105,16 +77,8 @@ This is how the ads should display is all is working fine.... (ads also change s * Finally, if you wish to disable the ad, tick ad disabling box -# Ad Providers Supported +# Ad Sizes -* Google DFP - -# Potential Ad Sizes - -Restricted container: -Max H: 300 or lower of ad, W: 1000 left align. - -Topic list top, Topic top, Above Suggested - 728*90 - 336*280 - 300*250 @@ -126,21 +90,12 @@ Topic list top, Topic top, Above Suggested - 200*200 - 250*250 -Post Bottom -Max H: 90 or lower of ad, W: 1000 left align. - -- 728*90 -- 960*90 -- 468*60 -- 234*60 +* Mobile Ads will automatically default to 320*50. ## License -GPL v2 +{{fill in here}} -TO-DO: - -* Fix up the image loading issue in Readme. -* Publisher ID support -* Trust levels -* More ad providers! +TODO: +Non docker installation +Expand on the usage - dfp and adsense \ No newline at end of file diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml index e437608..2d6f20f 100755 --- a/config/locales/client.en.yml +++ b/config/locales/client.en.yml @@ -3,5 +3,5 @@ en: admin: site_settings: categories: - ad_plugin: 'Ad Plugin' + ad_plugin: 'DFP Plugin' adsense_plugin: 'Adsense Plugin' \ No newline at end of file diff --git a/plugin.rb b/plugin.rb index 165d963..a587e5a 100755 --- a/plugin.rb +++ b/plugin.rb @@ -1,7 +1,7 @@ # name: discourse-adplugin -# about: Ad Plugin for Discourse (dfp) +# about: Ad Plugin for Discourse # version: 0.1 -# authors: Vi and Sarah (Team Melbourne) +# authors: Vi and Sarah (@ladydanger and @cyberkoi) register_css < Date: Thu, 3 Sep 2015 10:18:59 +1000 Subject: [PATCH 02/27] 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 03/27] 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 04/27] 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 05/27] 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 06/27] 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 07/27] 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 08/27] 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 09/27] 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 10/27] 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 11/27] 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 12/27] 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 13/27] 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 From 3f56934278bff9247fad5b061bfc2a49fbc266d8 Mon Sep 17 00:00:00 2001 From: vi Date: Fri, 4 Sep 2015 09:24:10 +1000 Subject: [PATCH 14/27] Added minor changes --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 15095fa..3ddd6a5 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ This is the official Discourse advertising plugin. It allows advertisements to 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. +* You have deployed your live forum using Docker. If you're using Digital Ocean, it's likely that your forum is deployed on Docker. -For installation for non-docker or local development (those with programming experience), see Other Installation. +For non-docker or local development installation (those with programming experience), see **Other Installation**. ### Step 1 - Install the Official Discourse Advertising Plugin @@ -50,7 +50,9 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti * 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. +* Choose your advertisement platform by clicking on: +⋅⋅* Adsense Plugin - if using Adsense as your advertisement platform +⋅⋅* DFP Plugin - if using the DoubleClick for Publishers advertisement platform. #### Step 2(b)(i) - Input Your Details (Adsense) From a0ab6a607b992f72dacd39c904e7558b945ff119 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Fri, 4 Sep 2015 11:26:37 +1000 Subject: [PATCH 15/27] Corrected sizes corrected sizes on table --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 15095fa..39cde92 100644 --- a/README.md +++ b/README.md @@ -143,11 +143,11 @@ This plugin supports the following ad sizes for the following locations. 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 | -960 x 90 | 234 x 60 | -468 x 60 | | -234 x 60 | | +336 x 280 | 336 x 280 | +300 x 250 | 300 x 250 | +970 x 90 | 970 x 90 | +468 x 60 | 468 x 60 | +234 x 60 | 234 x 60 | 125 x 125 | | 180 x 150 | | 200 x 200 | | From 4a4c9728138630d6812a634d09d2ae8c903cc20e Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 10:14:20 +1000 Subject: [PATCH 16/27] added images to the readme and features --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 39cde92..91f836d 100644 --- a/README.md +++ b/README.md @@ -53,12 +53,37 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti * 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) +#### Step 2(b) - Input Your Details + +Depending on which ad platform you are using, to input your ad details you need to: + +* Get the Advertisement Tag from your Ad Provider +* Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform. + +**Adsense Ad Tag Into SiteSettings** +![](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) + +**DoubleClick for Publishers' Ad Tag Into SiteSettings** + +![](https://www.dropbox.com/sc/0inoc1iduux0gsf/AADi8tfKX9S6Tx9S8RndcUE8a?dl=1) + + +In Ad Plugin Features: + +* Available Locations for Ad Display +* Ad Sizes Supported +* Other.... (TBC) + +Locations to be in a table... + +Post Bottom ![](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) +Topic Above Post ![](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1) +Topic Above Suggested ![](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1) +Topic List Top ![](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) + -* 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. From d80c557d474cb7d56299d2932d8946133330b5ad Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 10:22:07 +1000 Subject: [PATCH 17/27] Edited input details + added items to features --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 91f836d..cb7f1ae 100644 --- a/README.md +++ b/README.md @@ -57,13 +57,18 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti Depending on which ad platform you are using, to input your ad details you need to: -* Get the Advertisement Tag from your Ad Provider -* Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform. +1. Add in your publisher ID - your publisher ID can be obtained from your ad provider and can also be found in your ad tag (see picture below). +2. Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the **Plugin Features** heading. +3. Get the Advertisement Tag from your Ad Provider - see the images below to see what a tag looks like. +4. Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform. +5. Choose Your Ad Size - this is the same size that you've put into your ad provider to create your ad. Go to the **Plugin Features** heading to see a list of supported Ad sizes. + + +##### Adsense Ad Tag Into SiteSettings -**Adsense Ad Tag Into SiteSettings** ![](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) -**DoubleClick for Publishers' Ad Tag Into SiteSettings** +##### DoubleClick for Publishers' Ad Tag Into SiteSettings ![](https://www.dropbox.com/sc/0inoc1iduux0gsf/AADi8tfKX9S6Tx9S8RndcUE8a?dl=1) @@ -72,6 +77,7 @@ In Ad Plugin Features: * Available Locations for Ad Display * Ad Sizes Supported +* Trust Levels * Other.... (TBC) Locations to be in a table... @@ -84,10 +90,6 @@ Topic List Top ![](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2 - -* Insert Image + Explain the code in the provided tag from ad provider. - - // TO BE FIXED START Add GIFS, Images ✘ this is a cross From bd551b0a155b61a35e7a7311e2429c30f848680d Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 10:39:46 +1000 Subject: [PATCH 18/27] Added location table and edited input details --- README.md | 96 +++++++++++++++++++++---------------------------------- 1 file changed, 37 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index cb7f1ae..ae4cf4d 100644 --- a/README.md +++ b/README.md @@ -55,77 +55,25 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti #### Step 2(b) - Input Your Details -Depending on which ad platform you are using, to input your ad details you need to: - -1. Add in your publisher ID - your publisher ID can be obtained from your ad provider and can also be found in your ad tag (see picture below). +1. Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see picture below). 2. Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the **Plugin Features** heading. -3. Get the Advertisement Tag from your Ad Provider - see the images below to see what a tag looks like. +3. Get the Advertisement Tag from your Ad Platform - see the images below to see what a tag looks like. 4. Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform. 5. Choose Your Ad Size - this is the same size that you've put into your ad provider to create your ad. Go to the **Plugin Features** heading to see a list of supported Ad sizes. +6. To disable your ad (and not have it display), click on the disable button. - -##### Adsense Ad Tag Into SiteSettings +##### Adsense Advertisement Tag to Discourse's Site Settings ![](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) -##### DoubleClick for Publishers' Ad Tag Into SiteSettings +##### DoubleClick for Publishers' Advertisement Tag to Discourse's Site Settings ![](https://www.dropbox.com/sc/0inoc1iduux0gsf/AADi8tfKX9S6Tx9S8RndcUE8a?dl=1) -In Ad Plugin Features: - -* Available Locations for Ad Display -* Ad Sizes Supported -* Trust Levels -* Other.... (TBC) - -Locations to be in a table... - -Post Bottom ![](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) -Topic Above Post ![](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1) -Topic Above Suggested ![](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1) -Topic List Top ![](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) - - - - -// TO BE FIXED START -Add GIFS, Images -✘ this is a cross -✓ this is a tick -After installation users likely want to: -- Choose platform - DONE -- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. -- Display ad. - - -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. - -Usually google sizes tDOcso input are (width*height) 300*250 or 728*90 (best) respectively. Input your dfp ad code. - -The namings in settings are with reference to the plugin outlets created by Discourse. - -`dfp_topic_list_top_code`: ad will appear at the header of Discourse homepage - -`dfp_topic_above_post_stream_code`: ad will appear at the header of all Discourse forum topics - -`dfp_topic_above_suggested_code`: ad will appear at the footer above suggested topics of all Discourse forum topics - -`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 - - -* Finally, if you wish to disable the ad, tick ad disabling box - ### Step 3 - See Your Ad -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 - +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. ## Other Installation @@ -162,8 +110,38 @@ 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. +### Plugin Features -## Advertisement Sizes Supported + +// TO BE FIXED START +Add GIFS, Images +✘ this is a cross +✓ this is a tick +After installation users likely want to: +- Choose platform - DONE +- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. +- Display ad. + + +* Available Locations for Ad Display +* Ad Sizes Supported +* Trust Levels +* Other.... (TBC) + + + + +### Available Locations for Ad Display + +Location Name | Description | Image of Location +--- | --- | --- +Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) +Topic Above Post Stream | Ad will appear in the header of all Discourse forum topics | [Topic above post stream](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1) +Topic Above Suggested | Ad will appear in the footer above suggested topics of all Discourse forum topics | [Topic above suggested](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1) +Post Bottom & Nth Post | Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in ```ad_platform_nth_post_code```. | [Post bottom](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) + + +### Advertisement Sizes Supported This plugin supports the following ad sizes for the following locations. From 0c8873d37d4001117417ae10c40996cdd9e73cfa Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 10:44:28 +1000 Subject: [PATCH 19/27] cleaned up features --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ae4cf4d..8df5d94 100644 --- a/README.md +++ b/README.md @@ -110,25 +110,11 @@ 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. -### Plugin Features - - -// TO BE FIXED START -Add GIFS, Images -✘ this is a cross -✓ this is a tick -After installation users likely want to: -- Choose platform - DONE -- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. -- Display ad. - +## Plugin Features * Available Locations for Ad Display * Ad Sizes Supported * Trust Levels -* Other.... (TBC) - - ### Available Locations for Ad Display @@ -159,6 +145,18 @@ All locations except post bottom | Post bottom location | Mobile 250 x 250 | | + +TBC: +Add GIFS, Images +✘ this is a cross +✓ this is a tick +After installation users likely want to: +- Choose platform - DONE +- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. +- Display ad. + + + ## Questions or Want to Contribute? Open an Issue on this repository to start a chat. From c83b1c833693d6f0ddabe007cbfb5d5e590bc65c Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 10:44:47 +1000 Subject: [PATCH 20/27] cleaned up features From c68a5a4f1ba9fe36a91c237d9bff3a02d2c66cc8 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 11:51:39 +1000 Subject: [PATCH 21/27] added licence and modified content --- README.md | 111 +++++++++++++++++++++++++++--------------------------- 1 file changed, 55 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 8df5d94..a18d23c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. +**Authors**: [cyber_koi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) +**Contributors**: See Credits section below +**Copyright**: 2015 **License**: MIT License **Supported Discourse Version**: 1.4

**Supported Ad Platforms**: @@ -9,6 +12,7 @@ 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 This quick start shows you how to install this plugin and use it. Recommended if you have: @@ -47,7 +51,6 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti #### 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. @@ -58,7 +61,7 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti 1. Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see picture below). 2. Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the **Plugin Features** heading. 3. Get the Advertisement Tag from your Ad Platform - see the images below to see what a tag looks like. -4. Add parts of your ad code to Discourse's site settings as per the color coding in the images below. Only use the image for your ad platform. +4. Add parts of your ad code to Discourse's site settings for the locations you wish your ad to appear. Refer to image for your ad platform to where parts of your ad tag should go. For more detail about where the ad will appear 5. Choose Your Ad Size - this is the same size that you've put into your ad provider to create your ad. Go to the **Plugin Features** heading to see a list of supported Ad sizes. 6. To disable your ad (and not have it display), click on the disable button. @@ -76,6 +79,54 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti 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. +## Plugin Features + +In this section, we go into more detail on: +* Available Locations for Ad Display +* Ad Sizes Supported +* Trust Levels + +### Available Locations for Ad Display + +Location Name | Description | Image of Location +--- | --- | --- +Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) +Topic Above Post Stream | Ad will appear in the header of all Discourse forum topics | [Topic above post stream](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1) +Topic Above Suggested | Ad will appear in the footer above suggested topics of all Discourse forum topics | [Topic above suggested](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1) +Post Bottom & Nth Post | Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in ```ad_platform_nth_post_code```. | [Post bottom](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) + + +### Advertisement Sizes Supported + +This plugin supports the following ad sizes for the following locations. + +All locations except post bottom | Post bottom location | Mobile +--- | --- | --- +728 x 90 | 728 x 90 | 320 x 50 +336 x 280 | 336 x 280 | +300 x 250 | 300 x 250 | +970 x 90 | 970 x 90 | +468 x 60 | 468 x 60 | +234 x 60 | 234 x 60 | +125 x 125 | | +180 x 150 | | +200 x 200 | | +250 x 250 | | + + +### Trust Levels + +You can use the ```ad_platform_through_trust_level``` dropdown to disable ads for users above a certain trust levels. As a guide, choosing: + +* 0 shows ads to users that are not logged in. +* 1 shows ads to users that are not logged in, and to new and basic users. +* 2 shows ads to regular users as well, but not to leaders and elders. +* 3 shows ads to everyone but elders. +* 4 shows ads to everyone including elders. + +To find more about trust levels in Discourse, refer to [Discourse's posts on trust levels](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/7) + + ## Other Installation There are two sets of installation instructions: @@ -110,53 +161,6 @@ 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. -## Plugin Features - -* Available Locations for Ad Display -* Ad Sizes Supported -* Trust Levels - - -### Available Locations for Ad Display - -Location Name | Description | Image of Location ---- | --- | --- -Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) -Topic Above Post Stream | Ad will appear in the header of all Discourse forum topics | [Topic above post stream](https://www.dropbox.com/sc/1ze0dikrmkfj0wg/AADMGWGVsECEOwZdnmSLGkhZa?dl=1) -Topic Above Suggested | Ad will appear in the footer above suggested topics of all Discourse forum topics | [Topic above suggested](https://www.dropbox.com/sc/y3p2iqwggb5he0e/AAAbrTqZCAYgIhIYE4necmfXa?dl=1) -Post Bottom & Nth Post | Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in ```ad_platform_nth_post_code```. | [Post bottom](https://www.dropbox.com/sc/pguxq17zo2rovyd/AAD--LTH_IIgVhgczoaY1Ljva?dl=1) - - -### Advertisement Sizes Supported - -This plugin supports the following ad sizes for the following locations. - -All locations except post bottom | Post bottom location | Mobile ---- | --- | --- -728 x 90 | 728 x 90 | 320 x 50 -336 x 280 | 336 x 280 | -300 x 250 | 300 x 250 | -970 x 90 | 970 x 90 | -468 x 60 | 468 x 60 | -234 x 60 | 234 x 60 | -125 x 125 | | -180 x 150 | | -200 x 200 | | -250 x 250 | | - - - -TBC: -Add GIFS, Images -✘ this is a cross -✓ this is a tick -After installation users likely want to: -- Choose platform - DONE -- Input ad codes + do a few other things. - DFP in detail with custom targeting - write guide on this. -- Display ad. - - - ## Questions or Want to Contribute? Open an Issue on this repository to start a chat. @@ -166,11 +170,6 @@ Issues and Pull Requests are greatly appreciated. Bear in mind that when submit ## 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. +Discourse.org - Thanks to our mentor [eviltrout](https://github.com/eviltrout) and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE +Rails Girls - Thanks [sareg0](https://github.com/...) and the Rails Girls Team. Our Coaches - @LIST_OUT_THEIR_GITHUB_HANDLE - - -## License - -TBC: GPL v2 or MIT From ab9aca7c992678741ba3c2d696563f0797a80021 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 11:53:35 +1000 Subject: [PATCH 22/27] Add line formatting --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a18d23c..910748d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. -**Authors**: [cyber_koi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) -**Contributors**: See Credits section below -**Copyright**: 2015 **License**: MIT License +**Authors**: [cyberkoi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) (insert_web_page) :heart:

+**Contributors**: See Credits section below

+**Copyright**: 2015 **License**: MIT License

**Supported Discourse Version**: 1.4

**Supported Ad Platforms**: From 51b9aa4992227e2a4f25957efaabf139c6a21e9e Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 12:09:08 +1000 Subject: [PATCH 23/27] Added details to plugin and fixed next line --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 910748d..636d04f 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,15 @@ This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum. -**Authors**: [cyberkoi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) (insert_web_page) :heart:

-**Contributors**: See Credits section below

-**Copyright**: 2015 **License**: MIT License

-**Supported Discourse Version**: 1.4

-**Supported Ad Platforms**: - +**Authors**: [cyberkoi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) (insert_web_page) :heart: +**Contributors**: See credits section below +**License**: MIT License +**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) - ## Quick Start in 3 Steps This quick start shows you how to install this plugin and use it. Recommended if you have: From a1cc02a8e51bc61975bcb23c1ecf84416ab66a19 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 12:18:13 +1000 Subject: [PATCH 24/27] finalised structure of readme and credits remaining --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 636d04f..2724399 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ 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 non-docker or local development installation (those with programming experience), see **Other Installation**. ### Step 1 - Install the Official Discourse Advertising Plugin @@ -56,7 +56,7 @@ There are 2 easy steps for configuring your Discourse settings to enable adverti #### Step 2(b) - Input Your Details -1. Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see picture below). +1. Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see pictures below). 2. Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the **Plugin Features** heading. 3. Get the Advertisement Tag from your Ad Platform - see the images below to see what a tag looks like. 4. Add parts of your ad code to Discourse's site settings for the locations you wish your ad to appear. Refer to image for your ad platform to where parts of your ad tag should go. For more detail about where the ad will appear @@ -86,6 +86,8 @@ In this section, we go into more detail on: ### Available Locations for Ad Display +The following are available locations along with a description and an image showing their location within Discourse to display ads for all platforms. + Location Name | Description | Image of Location --- | --- | --- Topic List Top | Ad will appear at the header of Discourse homepage | [Topic list top](https://www.dropbox.com/sc/cpm9i6jj5dtivjc/AACmgp6qxI-8kMp3F2VVWsvba?dl=1) @@ -168,6 +170,6 @@ Issues and Pull Requests are greatly appreciated. Bear in mind that when submit ## Credits -Discourse.org - Thanks to our mentor [eviltrout](https://github.com/eviltrout) and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE -Rails Girls - Thanks [sareg0](https://github.com/...) and the Rails Girls Team. +Discourse.org - Thanks to our mentor [@viltrout](https://github.com/eviltrout) and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE +Rails Girls - Thanks [@sareg0](https://github.com/...) and the Rails Girls Team. Our Coaches - @LIST_OUT_THEIR_GITHUB_HANDLE From a960d01976f941271c67ba1ee46637373ff9aac8 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 13:04:46 +1000 Subject: [PATCH 25/27] added links to coaches --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2724399..619077e 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,14 @@ Issues and Pull Requests are greatly appreciated. Bear in mind that when submit ## Credits -Discourse.org - Thanks to our mentor [@viltrout](https://github.com/eviltrout) and the Discourse team - @LIST_OUT_THEIR_GITHUB_HANDLE -Rails Girls - Thanks [@sareg0](https://github.com/...) and the Rails Girls Team. -Our Coaches - @LIST_OUT_THEIR_GITHUB_HANDLE +**Discourse.org**: Thanks to our mentor [@eviltrout](https://github.com/eviltrout) and the wonderful [Discourse team!](http://www.discourse.org/) + +**Our Coaches**: Very special thank you to our coaches and honorary coach - [@georg](https://github.com/georg), [@betaass](https://github.com/betaass), [@adelsmee](https://github.com/adelsmee), [@davich](https://github.com/davich), [@link664](https://github.com/link664), [@tomjadams](https://github.com/tomjadams), [@compactcode](https://github.com/compactcode), [@joffotron](https://github.com/joffotron), [@jocranford](https://github.com/jocranford), [@saramic](https://github.com/saramic), [@madpilot](https://github.com/madpilot), [@catkins](https://github.com/catkins) + +**Rails Girls**: Thanks [@sareg0](https://github.com/sareg0) and the Rails Girls Team for the opportunity to participate in Rails Girls Summer of Code 2015. + + + + + + From d2ab2d99ffcfcfb916dd1e6a206d1e019d219ae8 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 13:13:06 +1000 Subject: [PATCH 26/27] Further refinement to the plugin wording --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 619077e..fb7b3a0 100644 --- a/README.md +++ b/README.md @@ -165,8 +165,6 @@ For example: ln -s ~/discourse-plugin-test . 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 2891a3e355c6018ad3b19e3c1b2e727782fd2c48 Mon Sep 17 00:00:00 2001 From: ladydanger Date: Mon, 7 Sep 2015 13:18:08 +1000 Subject: [PATCH 27/27] polished up the authorship --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb7b3a0..1ddc8ba 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. -**Authors**: [cyberkoi](https://github.com/cyberkoi) (insert_web_page) and [ladydanger](https://github.com/ladydanger) (insert_web_page) :heart: +**Authors**: [cyberkoi](https://github.com/cyberkoi) & [ladydanger](https://github.com/ladydanger) **Contributors**: See credits section below **License**: MIT License **Supported Discourse Version**: 1.4