Merge lp:~stephen-stewart/snappy/docs-tidy-up-package-metadata into lp:~snappy-dev/snappy/snappy-moved-to-github

[Stephen Stewart]

django markdown requires 4 spaces to start a child list, and without correct list indentation the docs aren't easy to follow

[John Lenton (chipaca)]

Trusting you on this one.

You know what would be nice? a markdown linter that didn't require me to 'npm install' stuff.

review: Approve

[Michael Vogt (mvo)]

Hey Stephen! Thanks a bunch for this branch. One question - did you generate the html docs locally yourself for easier reading? Or are the md files actually used somewhere to auto-generate docs?

=== modified file 'docs/meta.md'
--- docs/meta.md	2015-05-12 14:54:33 +0000
+++ docs/meta.md	2015-05-13 20:42:06 +0000
@@ -29,10 +29,10 @@
    `explicit-license-agreement` is `Y`, prompts the user to accept the
    license again.
  * `type`: (optional) the type of the snap, can be:
-   * `app` - the default if empty
-   * `oem` - a special snap that OEMs can use to customize snappy for
+     * `app` - the default if empty
+     * `oem` - a special snap that OEMs can use to customize snappy for
              their hardware
-   * `framework` - a specialized snap that extends the system that other
+     * `framework` - a specialized snap that extends the system that other
                    snaps may use
 
  * `architectures`: (optional) a yaml list of supported architectures
@@ -40,46 +40,46 @@
  * `frameworks`: a list of the frameworks the snap needs as dependencies
 
  * `services`: the servies (daemons) that the snap provides
-   * `name`: (required) name of the service (only `[a-zA-Z0-9+.-]`)
-   * `description`: (required) description of the service
-   * `start`: (required) the command to start the service
-   * `stop`: (optional) the command to stop the service
-   * `stop-timeout`: (optional) the time in seconds to wait for the
-                     service to stop
-   * `poststop`: a command that runs after the service has stopped
-   * `caps`: (optional) list of additional security policies to add.
-             See `security.md` for details
-   * `security-template`: (optional) alternate security template to use
-                          instead of `default`. See `security.md` for details
-   * `security-override`: (optional) high level overrides to use when
-                          `security-template` and `caps` are not
-                          sufficient.  See security.md for details
-   * `security-policy`: (optional) hand-crafted low-level raw security
-                        policy to use instead of using default
-                        template-based  security policy. See
-                        security.md for details
-   * `ports`: (optional) define what ports the service will work
-     * `internal`: the ports the service is going to connect to
-       * `tagname`: a free form name
-         * `port`: (optional) number/protocol, e.g. `80/tcp`
-         * `negotiable`: (optional) Y if the app can use a different port
-     * `external`: the ports the service offer to the world
-       * `tagname`: a free form name, some names have meaning like "ui"
-         * `port`: (optional) see above
-         * `negotiable`: (optional) see above
-   * `bus-name`: (optional) message bus connection name for the service.
-     May only be specified for snaps of 'type: framework' (see above). See
-     frameworks.md for details.
+     * `name`: (required) name of the service (only `[a-zA-Z0-9+.-]`)
+     * `description`: (required) description of the service
+     * `start`: (required) the command to start the service
+     * `stop`: (optional) the command to stop the service
+     * `stop-timeout`: (optional) the time in seconds to wait for the
+                       service to stop
+     * `poststop`: a command that runs after the service has stopped
+     * `caps`: (optional) list of additional security policies to add.
+               See `security.md` for details
+     * `security-template`: (optional) alternate security template to use
+                            instead of `default`. See `security.md` for details
+     * `security-override`: (optional) high level overrides to use when
+                            `security-template` and `caps` are not
+                            sufficient.  See security.md for details
+     * `security-policy`: (optional) hand-crafted low-level raw security
+                          policy to use instead of using default
+                          template-based  security policy. See
+                          security.md for details
+     * `ports`: (optional) define what ports the service will work
+         * `internal`: the ports the service is going to connect to
+             * `tagname`: a free form name
+                 * `port`: (optional) number/protocol, e.g. `80/tcp`
+                 * `negotiable`: (optional) Y if the app can use a different port
+         * `external`: the ports the service offer to the world
+             * `tagname`: a free form name, some names have meaning like "ui"
+                 * `port`: (optional) see above
+                 * `negotiable`: (optional) see above
+     * `bus-name`: (optional) message bus connection name for the service.
+       May only be specified for snaps of 'type: framework' (see above). See
+       frameworks.md for details.
 
  * `binaries`: the binaries (executables) that the snap provides
-   * `name`: (required) the name of the binary, the user will be able to
-             call it as $name.$pkgname (only `[a-zA-Z0-9+.-]`)
-   * `exec`: the program that gets executed (can be omited if name points
-             to a binary already)
-   * `caps`: (optional) see entry in `services` (above)
-   * `security-template`: (optional) see entry in `services` (above)
-   * `security-override`: (optional) see entry in `services` (above)
-   * `security-policy`: (optional) see entry in `services` (above)
+     * `name`: (required) the name of the binary, the user will be able to
+               call it as $name.$pkgname (only `[a-zA-Z0-9+.-]`)
+     * `exec`: the program that gets executed (can be omited if name points
+               to a binary already)
+     * `caps`: (optional) see entry in `services` (above)
+     * `security-template`: (optional) see entry in `services` (above)
+     * `security-override`: (optional) see entry in `services` (above)
+     * `security-policy`: (optional) see entry in `services` (above)
 
 ## license.txt