Skip to content

Commit

Permalink
Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
lueschem committed Dec 15, 2016
1 parent 164c3eb commit 6c242f9
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 32 deletions.
23 changes: 4 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ goal, edi leverages top-notch open source technologies:

----


Getting Started
+++++++++++++++

See chapter `getting started`_.

.. _getting started: docs/getting_started.rst

License
+++++++

Expand All @@ -46,16 +38,9 @@ Warning
edi is still a very young project and therefore interfaces might change quickly and without notice.


Documentation
+++++++++++++

Please check here if you need additional documentation:

- `Getting started`_
- `Command cheat sheet`_
- `Reference list`_
More Information
++++++++++++++++

.. _Getting started: docs/getting_started.rst
.. _Command cheat sheet: docs/command_cheat_sheet.rst
.. _Reference list: docs/reference_list.rst
For more information please visit `http://www.get-edi.io`_.

.. _`http://www.get-edi.io`: http://www.get-edi.io
39 changes: 33 additions & 6 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ The following setup steps have been tested on Ubuntu 16.04.
Prerequisites
+++++++++++++

#. Install various packages that are required for the development of this project:

::

sudo apt install git-buildpackage python3-setuptools python3-setuptools-scm python3-sphinx python3-argcomplete python3-pytest python3-pytest-cov pep8 python3-pip python3-gnupg python3-yaml lxd debootstrap debhelper python3-requests-mock

#. Install Ansible with a version >= 2.1. On Ubuntu 16.04 you have to enable xenial-backports and then install Ansible as follows:

::
Expand All @@ -27,9 +21,38 @@ Prerequisites
The default settings are ok.
Use the storage backend "dir" if there is no zfs setup on your computer.

Install edi from the PPA
++++++++++++++++++++++++

For your convenience, you can directly install edi from a ppa:

#. Add the `edi-snapshots`_ ppa to your Ubuntu installation:

::

sudo add-apt-repository ppa:m-luescher/edi-snapshots
sudo apt-get update

#. Install edi:

::

sudo apt install edi

.. _`edi-snapshots`: https://launchpad.net/~m-luescher/+archive/ubuntu/edi-snapshots


Working with the edi Source Code
++++++++++++++++++++++++++++++++

Hint: You can skip this section if you just want to use edi without having a look at the source code.

#. Install various packages that are required for the development of this project:

::

sudo apt install git-buildpackage python3-setuptools python3-setuptools-scm python3-sphinx python3-argcomplete python3-pytest python3-pytest-cov pep8 python3-pip python3-gnupg python3-yaml lxd debootstrap debhelper python3-requests-mock

#. Clone the source code:

::
Expand All @@ -54,6 +77,10 @@ Working with the edi Source Code

source local_setup


Build a First Example
+++++++++++++++++++++

#. Clone the edi-examples repository:

::
Expand Down
8 changes: 1 addition & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,8 @@ Contents:
.. toctree::
:maxdepth: 2

introduction
getting_started
reference_list
command_cheat_sheet

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

1 change: 1 addition & 0 deletions docs/introduction.rst

0 comments on commit 6c242f9

Please sign in to comment.