Merge lp:~chipaca/ubuntu-push/docs-include-examples into lp:ubuntu-push/automatic

[John Lenton]

Include code examples in docs (instead of repeating).

Make docs include the examples instead of repeating them. DRYer, and betterer.

[Roberto Alsina (ralsina)]

review: Approve

=== modified file 'docs/_common.txt'
--- docs/_common.txt	2014-11-13 14:36:56 +0000
+++ docs/_common.txt	2014-11-25 13:12:39 +0000
@@ -7,47 +7,22 @@
 The helper receives two arguments ``infile`` and ``outfile``. The message is delivered via ``infile`` and the transformed
 version is placed in ``outfile``.
 
-This is the simplest possible useful helper, which simply passes the message through unchanged::
-
-    #!/usr/bin/python3
-
-    import sys
-    f1, f2 = sys.argv[1:3]
-    open(f2, "w").write(open(f1).read())
-
-Helpers need to be added to the click package manifest::
-
-    {
-        "name": "com.ubuntu.developer.ralsina.hello",
-        "description": "description of hello",
-        "framework": "ubuntu-sdk-14.10-qml-dev2",
-        "architecture": "all",
-        "title": "hello",
-        "hooks": {
-            "hello": {
-                "apparmor": "hello.json",
-                "desktop": "hello.desktop"
-            },
-            "helloHelper": {
-                "apparmor": "helloHelper-apparmor.json",
-                "push-helper": "helloHelper.json"
-            }
-        },
-        "version": "0.2",
-        "maintainer": "Roberto Alsina <[e-mail]>"
-    }
+This is the simplest possible useful helper, which simply passes the message through unchanged:
+
+.. include:: example-client/helloHelper
+   :literal:
+
+Helpers need to be added to the click package manifest:
+
+.. include:: example-client/manifest.json
+   :literal:
 
 Here, we created a helloHelper entry in hooks that has an apparmor profile and an additional JSON file for the push-helper hook.
 
-helloHelper-apparmor.json must contain **only** the push-notification-client policy group and the ubuntu-push-helper template::
+helloHelper-apparmor.json must contain **only** the push-notification-client policy group and the ubuntu-push-helper template:
 
-    {
-        "template": "ubuntu-push-helper",
-        "policy_groups": [
-            "push-notification-client"
-        ],
-        "policy_version": 1.2
-    }
+.. include:: example-client/helloHelper-apparmor.json
+   :literal:
 
 And helloHelper.json must have at least a exec key with the path to the helper executable relative to the json, and optionally
 an app_id key containing the short id of one of the apps in the package (in the format packagename_appname without a version).
@@ -139,15 +114,10 @@
 Security
 ~~~~~~~~
 
-To use the push API, applications need to request permission in their security profile, using something like this::
+To use the push API, applications need to request permission in their security profile, using something like this:
 
-    {
-        "policy_groups": [
-            "networking",
-            "push-notification-client"
-        ],
-        "policy_version": 1.2
-    }
+.. include:: example-client/hello.json
+   :literal:
 
 
 Ubuntu Push Server API