Merge pull request #8 from jhodapp/git-repo

Add Ubuntu Core Stacks bits as a new subsection

README.md

@@ -3,3 +3,25 @@
 This documentation will walk you through the steps of building and managing an Ubuntu Core device.
 
 You can find it published on [docs.ubuntu.com/core](http://docs.ubuntu.com/core).
+
+# Building
+
+To build the documentation you need to install documentation-builder:
+
+    $ snap install documentation-builder
+
+Then install the git-repo utility:
+
+    $ mkdir $HOME/.bin/
+    $ export PATH=$PATH:$HOME/.bin/repo
+    $ curl https://storage.googleapis.com/git-repo-downloads/repo > $HOME/.bin/repo
+    $ chmod a+x $HOME/.bin/repo
+
+From the root of the documentation source tree do the following to get the Ubuntu
+Core Stacks bits:
+
+    $ repo init -u git@github.com:CanonicalLtd/ubuntu-core-docs.git
+    $ repo sync
+    $ documentation-builder
+
+All of the generated documentation will be under build/

default.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<manifest>
+  <remote name="origin" fetch="https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git" />
+  <default revision="master" remote="origin"  sync-j="4" />
+  <project path="en/stacks/audio/alsa" name="alsa-utils" />
+  <project path="en/stacks/bluetooth" name="bluez" />
+  <project path="en/stacks/network/modem-manager" name="modem-manager" />
+  <project path="en/stacks/network/network-manager" name="network-manager" />
+  <project path="en/stacks/network/ofono" name="ofono" />
+  <project path="en/stacks/network/wifi-ap" name="wifi-ap" />
+  <project path="en/stacks/audio/pulseaudio" name="pulseaudio" />
+  <project path="en/stacks/tpm/tpm" name="tpm" />
+  <project path="en/stacks/tpm/tpm2" name="tpm2" />
+  <project path="en/stacks/disk/udisks2" name="udisks2" />
+  <project path="en/stacks/power" name="upower" />
+  <project path="en/stacks/testing" name="engineering-tests" />
+</manifest>

en/metadata.yaml

@@ -47,6 +47,36 @@ navigation:
       - title: Advanced - Branded store
         location: guides/go-to-production/advanced.md
 
+  - title: Ubuntu Core Stacks
+
+    children:
+      - title: Introduction
+        location: stacks/index.md
+
+# TODO:
+#   * Need Markdown documentation for location-service
+#   * Need Markdown documentation for media-hub
+#   * Need Markdown documentation for upower
+#   * Need to move the wifi-ap documentation from Google Docs to Markdown
+      - title: Stack Items
+        children:
+          - title: Audio management
+            location: stacks/audio/index.md
+          - title: Bluetooth management
+            location: stacks/bluetooth/doc/overview.md
+          - title: Disk management
+            location: stacks/disk/index.md
+#          - title: Location services
+#            location: stacks/location/docs/index.md
+#          - title: Media playback & recording
+#            location: stacks/media/docs/index.md
+          - title: Network management & services
+            location: stacks/network/index.md
+#          - title: Power management
+#            location: stacks/power/docs/index.md
+          - title: TPM
+            location: stacks/tpm/index.md
+
 #      - title: Debugging
 
 #  - title: Manage devices

en/stacks/audio/index.md

@@ -0,0 +1,10 @@
+---
+title: Audio management
+---
+
+# Audio management
+
+There are currently two different snaps that help manage audio under Ubuntu Core Stacks:
+
+* alsa-utils
+* pulseaudio

en/stacks/disk/index.md

@@ -0,0 +1,10 @@
+---
+title: Disk management
+---
+
+# Disk management
+
+The following snap is used to manage disks, their mount points,
+partitions, formatting, etc under Ubuntu Core Stacks:
+
+* udisks2

en/stacks/index.md

@@ -0,0 +1,43 @@
+---
+title: What is Ubuntu Stacks?
+---
+
+# What is Ubuntu Core Stacks?
+
+Ubuntu Core Stacks is a set of snap packages that offer system-level functionality that
+enables important core system-level features not offered by the base Ubuntu Core
+system. With little to no additional effort, these snaps can be dropped in place
+on existing systems bringing significant new value to these systems.
+These snaps have been well tested in various commercial offerings and are
+actively maintained by an internal Canonical team.
+
+Please note that some additional integration work to these snaps may be required if
+new applications of these snaps diverges significantly from existing applications.
+
+# What Ubuntu Core Stacks offers
+
+Ubuntu Core Stacks currently offers the following areas of functionality relevant
+to many different types of Ubuntu Core-based systems:
+
+* [Audio management](audio/index.md)
+* [Bluetooth device management](bluetooth/doc/overview.md)
+* [Disk management](disk/index.md)
+* Location services (GPS, WiFi, etc)
+* Multimedia management
+* Cellular modem device data management
+* [Network interface management](network/network-manager/docs/index.md) (both wired and wireless)
+* Power management for battery-operated devices
+* [TPM](tpm/index.md) [Reference](https://en.wikipedia.org/wiki/Trusted_Platform_Module)
+* WiFi Access Point (AP)
+
+* Extensive manual and automatic testing framework for above functionality via
+  [Plainbox](https://pypi.python.org/pypi/plainbox) and [Spread](https://github.com/snapcore/spread)
+
+# Contributing source changes to these snaps
+
+  You may find the existing source repositories for these snaps as well as where to
+  submit contributions to them [here](https://code.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/).
+  You may also file bugs against these snaps [here](https://bugs.launchpad.net/snappy-hwe-snaps).
+
+  Please see the following documentation which covers how to retrieve and submit sources
+  from Launchpad using git: [getting and pushing code](https://help.launchpad.net/Code/Git#Getting_code)

en/stacks/network/index.md

@@ -0,0 +1,12 @@
+---
+title: Network management & services
+---
+
+# Network management & services
+
+There are currently several snaps which manage networking, modems
+and one that instantly creates a wireless access point:
+
+* modem-manager
+* [network-manager](network-manager/docs/index.md)
+* wifi-ap

en/stacks/tpm/index.md

@@ -0,0 +1,14 @@
+---
+title: TPM
+---
+
+# Trusted Platform Module (TPM)
+
+There are currently two different snaps that help manage TPM under Ubuntu Core Stacks
+depending on the version of TPM that your hardware device supports:
+
+* tpm
+* tpm2
+
+[See this page](https://en.wikipedia.org/wiki/Trusted_Platform_Module) for more
+information about TPM.