Discource-C
/
discourse-adplugin
mirror of https://github.com/discourse/discourse-adplugin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Restructured usage for plan and fixed up formatting in installation

This commit is contained in:
Ladydanger 2015-09-03 10:31:32 +10:00
parent a3e6fdc8ac
commit 5274f65b62
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -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. 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 ## Installation
There are three sets of installation instructions: 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. 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. 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 * 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**: 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 - mkdir -p plugins
- git clone https://github.com/team-melbourne-rgsoc2015/discourse-adplugin.git - git clone https://github.com/team-melbourne-rgsoc2015/discourse-adplugin.git
``` ```
* Rebuild the container Rebuild the container
``` ```
cd /var/docker cd /var/docker
@ -52,19 +55,22 @@ git pull
: :
``` ```
ln -s ~/whereever_your_cloned_ad_plugin_path_is . ln -s ~/whereever_your_cloned_ad_plugin_path_is .
For example: ln -s ~/discourse-plugin-test . 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. * 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 ## 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 * 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: * 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. ⋅⋅* 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) `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: ### Sample DFP Ad Codes:
1. /142953540/PostandCourier/Postandcourier.com/News/Leaderboard_Bottom 1. /142953540/PostandCourier/Postandcourier.com/News/Leaderboard_Bottom
2. /6355419/Travel/Europe/France/Paris 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? GPL v2 or MIT?
TO-DO:
* Fix up the image loading issue in Readme.
* Publisher ID support
* Trust levels
* More ad providers!