Merge pull request #2291 from mab68/rpi-documentation

Raspberry Pi documentation fixes
faucetsdn · Aug 15, 2018 · 5ab6b49 · 5ab6b49
2 parents eebf148 + ce9e819
commit 5ab6b49
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 269 deletions.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -243,6 +243,18 @@ Openstack's `diskimage-builder <https://docs.openstack.org/diskimage-builder/lat
 
 Pre-built images are available on our build host `<https://builder.faucet.nz>`_.
 
+Installing on Raspberry Pi
+--------------------------
+
+We already provide a Raspberry Pi image running FAUCET which can be retrieved from the `latest faucet Raspbian image download <https://github.com/faucetsdn/faucet/releases/latest>`_.
+
+The image can then be copied onto an SD card following the same steps from the official `Raspberry Pi installation guide <https://www.raspberrypi.org/documentation/installation/installing-images/linux.md>`_.
+
+Once you have booted up the Raspberry Pi and logged in using the default credentials you can follow through the :doc:`../tutorials/first_time` tutorial starting from :ref:`tutorial-configure-prometheus` to properly configure each component.
+
+.. note::
+	It is strongly recommended to use a Raspberry Pi 3 or better.
+
 Building the images
 ~~~~~~~~~~~~~~~~~~~
 

diff --git a/docs/tutorials/first_time.rst b/docs/tutorials/first_time.rst
@@ -39,6 +39,8 @@ Package installation
 
            sudo apt-get install faucet-all-in-one
 
+.. _tutorial-configure-prometheus:
+
 Configure prometheus
 ^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -9,4 +9,3 @@ Tutorials
     vlans
     routing
     nfv_services
-    raspbian_image
diff --git a/docs/tutorials/raspbian_image.rst b/docs/tutorials/raspbian_image.rst