Merge lp:~dholbach/snappy/markdown-doc-fixes into lp:~snappy-dev/snappy/snappy-moved-to-github

[Daniel Holbach]

- fix markdown syntax: use of <pre> for stdout messages or demonstration of file syntax, fix items of unordered list
 - fix typos: "as follow" → "as follows", "empy" → "empty"

[Sergio Schvezov (sergiusens)]

review: Approve

[Snappy Tarmac (snappydevtarmac)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

=== modified file 'docs/config.md'
--- docs/config.md	2015-02-17 14:07:45 +0000
+++ docs/config.md	2015-04-22 13:18:45 +0000
@@ -9,13 +9,13 @@
 
 We plan to support a schema file for the yaml as well to make e.g. web
 based editing of the config simpler.  The format of the configuration
-is as follow:
-    
-config:
-     packagename:
-        key: value
-    another-pkg:
-        key: value
+is as follows:
+
+	config:
+	  packagename:
+	    key: value
+	  another-pkg:
+	    key: value
 
 The application provides a configuration handler in
 meta/hooks/config. This configuration handler must provide reading new
@@ -25,9 +25,9 @@
 The package config hook must return exitcode 0 and return valid yaml
 of the form:
 
-config:
-  packagename:
-    key: value
+	config:
+	  packagename:
+	    key: value
 
 on stdout.
 
@@ -36,8 +36,8 @@
 success/failure of get/set the configuration. The current key/value
 pairs are suppprted right now:
 
-    - error: optional error string
-    - warning: optional warning string
+ - error: optional error string
+ - warning: optional warning string
 
 Some key/value pairs in the configuration are fixed and all
 applications. E.g. all applications that listen to a port must support
@@ -53,37 +53,46 @@
 Examples:
 ---------
 
-Example to set config:
-
-    snappy calls meta/hooks/config and sends the following over stdin:
-        config:
-            ubuntu-core:
-                timezone: Europe/Berlin
+Example to set config.
+
+snappy calls meta/hooks/config and sends the following over stdin:
+
+	config:
+	  ubuntu-core:
+	    timezone: Europe/Berlin
+
     The meta/hooks/config sends the following back:
-        config:
-            ubuntu-core:
-                timezone: Europe/Berlin
+
+	config:
+	  ubuntu-core:
+	    timezone: Europe/Berlin
 
 Example to get a config:
 
-snappy calls meta/hooks/config with empy input
-The meta/hooks/config sends the following back:
-        config:
-            ubuntu-core:
-                timezone: Europe/Berlin
-        status:
-            ubuntu-core:
-                ok: true
+snappy calls meta/hooks/config with empty input. The meta/hooks/config sends 
+the following back:
+
+	config:
+	  ubuntu-core:
+	    timezone: Europe/Berlin
+	status:
+	  ubuntu-core:
+	    ok: true
 
 Example to set a non-existing config:
-    snappy -> meta/hooks/config
-        config:
-            ubuntu-core:
-                tea-in-the-morning: false
-    meta/hooks/config exit with status 10 and message:
-        status:
-            ubuntu-core:
-                error: Unknown config option "tea-in-the-morning"
+
+snappy -> meta/hooks/config
+        
+	config:
+	  ubuntu-core:
+	    tea-in-the-morning: false
+
+meta/hooks/config exit with status 10 and message:
+        
+	status:
+	  ubuntu-core:
+	    error: Unknown config option "tea-in-the-morning"
+
 [snappy fails the install of the app]
 
 

=== modified file 'docs/frameworks.md'
--- docs/frameworks.md	2015-03-31 19:54:51 +0000
+++ docs/frameworks.md	2015-04-22 13:18:45 +0000
@@ -1,6 +1,6 @@
 # Frameworks
 ## Definition
-Frameworks are a direct extension of the Ubuntu Core. As such Frameworks have
+Frameworks are a direct extension of the Ubuntu Core. As such frameworks have
 the following attributes:
 
 * Frameworks exist primarily to provide mediation of shared resources (eg,
@@ -35,7 +35,7 @@
 * used as a method to bypass app isolation
 * able to be forked (a user may of course always sideload a modified framework)
 
-Note: snappy frameworks are somewhat different from the Ubuntu for Phones
+*Note:* snappy frameworks are somewhat different from the Ubuntu for Phones
 [click frameworks](https://wiki.ubuntu.com/Click/Frameworks) and are more
 flexible. Most importantly, click frameworks for Ubuntu for Phones map to a
 particular release and are contracts between the platform (OS) and apps. Snappy
@@ -233,8 +233,9 @@
 * if we implement this, how should we declare `bar-srv` access to `bar-srv` is
   restricted in this manner?
 * should we allow users the ability to to use the `binaries` with the appended
-  package name? Eg:
-    $ baz.foo --version
-    1.1.235
+  package name? Eg::
+
+    	$ baz.foo --version
+    	1.1.235
 * ...