content-hub guide is confusing in examples

Bug #1426535 reported by Leo Iannacone
22
This bug affects 5 people
Affects Status Importance Assigned to Milestone
Client Developer Experience
New
Undecided
Unassigned
content-hub (Ubuntu)
Confirmed
Undecided
Unassigned

Bug Description

I was reading this guide:
https://developer.ubuntu.com/en/apps/platform/guides/content-hub-guide

while the first part is really well written, the second one is a bit confusing and mess up in examples.

I'm referring to the second part as starting from "App registration as source or destination".

There we find this snip for the manifest.json:
```
hooks": {
        "APPONE": {
            "apparmor": "APPONE.json",
            "content-hub": "APPONE.json",
            "desktop": "APPNAME.desktop"
        }
```

so we assume that a APPONE has:
 * an apparmor file called APPONE.json
 * a content-hub file called APPONE.json
 * a desktop file called APPNAME.desktop

so we are saying that apparmor and content-hub files are the same, and APPONE != APPNAME. Is it right?

No, I don't thing so... The right snip of code should be something like:
```
hooks": {
        "APPNAME": {
            "apparmor": "APPNAME.apparmor",
            "content-hub": "APPNAME.content.json",
            "desktop": "APPNAME.desktop"
        }
```

And the issue propagates below.. in fact at some point we read:
```
Let’s look at one of these, APPONE.json:
{
    "source": [
        "pictures"
    ]
}
```

so, that's APPONE.json (not specified if for apparmor or for content-hub, I assume it's the content-hub's one, but it's not specified)...

And (again) some some lines after that:
```
Looking at APPONE.json, we may see something like this:

{
    "policy_groups": [
        "networking",
        "content_exchange"
    ],
    "policy_version": 1
}
```

Here I assume that the snip refers to the apparmor configuration, but again.. this is not clear!.

If a developer reads this guide for the first time (I tried to understand and to study how Content-Hub works) can be confused by those filenames.

Please consider a review for the second part as soon as possible.

ProblemType: Bug
DistroRelease: Ubuntu 15.04
Package: content-hub 0.0+15.04.20150123-0ubuntu1
ProcVersionSignature: Ubuntu 3.18.0-14.15-generic 3.18.7
Uname: Linux 3.18.0-14-generic x86_64
ApportVersion: 2.16.1-0ubuntu2
Architecture: amd64
CurrentDesktop: GNOME
Date: Fri Feb 27 19:53:02 2015
InstallationDate: Installed on 2014-09-18 (161 days ago)
InstallationMedia: Ubuntu-GNOME 14.10 "Utopic Unicorn" - Alpha amd64 (20140917)
SourcePackage: content-hub
SystemImageInfo:
 current build number: 0
 device name:
 channel: daily
 last update: Unknown
UpgradeStatus: Upgraded to vivid on 2015-01-23 (35 days ago)

Revision history for this message
Leo Iannacone (l3on) wrote :
Revision history for this message
Launchpad Janitor (janitor) wrote :

Status changed to 'Confirmed' because the bug affects multiple users.

Changed in content-hub (Ubuntu):
status: New → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.