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

[Daniel Holbach]

  - machanisms -> mechanisms
  - immmutable -> immutable
  - change <code> markdown (pandoc doesn't know about ```yaml)
  - re-flow comments to wrap nicely

[Daniel Holbach (dholbach)]

Just to explain, here's how we got from oem.md to https://developer.ubuntu.com/en/snappy/guides/oem/ I basically ran:

    pandoc --from markdown --to html5 oem.md -o oem.html
    perl -ne 'BEGIN{print "<div class=\"row no-border\">\n<div class=\"eight-col\">\n"} print;END{print "</div>\n</div>"}' oem.html > oem.web-guidelines.html

[lp:~dholbach/snappy/even-more-markdown-fixes]

419. By Daniel Holbach on 2015-04-22

fix wording

[John Lenton (chipaca)]

review: Approve

=== modified file 'docs/oem.md'
--- docs/oem.md	2015-04-22 13:33:45 +0000
+++ docs/oem.md	2015-04-22 15:15:33 +0000
@@ -6,7 +6,7 @@
 It covers a broad range, such as the software stack with its configuration and
 hardware enablement.
 
-There can only be *one* snappy package of `type` `oem` and it can only be
+There can only be *one* snappy package of `type: oem` and it can only be
 installed during image provision.
 
 ## Nomenclature
@@ -88,7 +88,7 @@
 
 While these assets are typically used during provisioning, they may also be
 used against a running system. *Caution:* updating these assets on a running
-system may lead to a broken system unless redundancy or fallback machanisms
+system may lead to a broken system unless redundancy or fallback mechanisms
 aren't provided by the OEM.
 
 #### Partition layout
@@ -101,54 +101,58 @@
 
 ## Structure and layout
 
-The `package.yaml` is structured as
-
-```yaml
-name: package-string # mandatory
-vendor: vendor-string # mandatory
-icon: icon-path # mandatory
-version: version-string # mandatory
-type: oem # mandatory
-
-config: # optional
-    snappy-package-string:
-        property-string: property-value
-
-immutable-config: # optional
-    - filter-string
-
-oem:
-    store: # optional
-        id: id-string # optional
-
-    branding: # optional
-        name:  branding-name-string # optional
-        logo: logo-path # optional
-
-    software: # optional
-        built-in:
-            - # package list
-        preinstalled:
-            - # package list
-    hardware: # mandatory
-        platform: platform-string # mandatory
-        architecture: architecture-string # mandatory (armhf, amd64, i386, arm64, ...)
-        partition-layout: partition-layout-string # mandatory (system-AB)
-        booloader: bootloader-string # mandatory (u-boot or grub)
-        boot-assets: # optional
-            files: #optional
-                - path: file-path
-            raw-files: #optional
-                - path: file-path
-                  offset: offset-uint64
-```
+The `package.yaml` is structured as:
+
+
+	name: package-string # mandatory
+	vendor: vendor-string # mandatory
+	icon: icon-path # mandatory
+	version: version-string # mandatory
+	type: oem # mandatory
+
+	config: # optional
+		snappy-package-string:
+		    property-string: property-value
+
+	immutable-config: # optional
+		- filter-string
+
+	oem:
+		store: # optional
+		    id: id-string # optional
+
+		branding: # optional
+		    name:  branding-name-string # optional
+		    logo: logo-path # optional
+
+		software: # optional
+		    built-in:
+		        - # package list
+		    preinstalled:
+		        - # package list
+		hardware: # mandatory
+		    platform: platform-string # mandatory
+		    architecture: architecture-string 
+                          # mandatory (armhf, amd64, i386, 
+                          #            arm64, ...)
+		    partition-layout: partition-layout-string
+                              # mandatory (system-AB)
+		    booloader: bootloader-string 
+                          # mandatory (u-boot or grub)
+		    boot-assets: # optional
+		        files: #optional
+		            - path: file-path
+		        raw-files: #optional
+		            - path: file-path
+		              offset: offset-uint64
+
 
 The package header section is common to all packages
 
 The general rules for config:
 
 - only applied on first boot.
-- if the config is immmutable, updates on in `oem` package will be reflected.
+- if the config is immutable, updates to the `oem` package will be reflected.
 
 Rules about packages in the config: