From 76bdc3ce141b2ca69e6a85558f341f0d5db8a3b7 Mon Sep 17 00:00:00 2001
From: Anthony Dentinger <anthony.dentinger@polymtl.ca>
Date: Mon, 7 Nov 2016 12:26:54 -0500
Subject: [PATCH] docs: added a 'downloading and installing' page under
'users'.
Change-Id: I46cd890412a54e36c6199a20a698ba2cc3bb68a8
---
Makefile.packaging | 4 ++
docs/source/index.rst | 1 +
docs/source/intro/getting_started.rst | 3 +-
.../users/downloading_and_installing.rst | 41 +++++++++++++++++++
4 files changed, 48 insertions(+), 1 deletion(-)
create mode 100644 docs/source/users/downloading_and_installing.rst
diff --git a/Makefile.packaging b/Makefile.packaging
index 20c6796e..f1789966 100644
--- a/Makefile.packaging
+++ b/Makefile.packaging
@@ -99,6 +99,10 @@ include Makefile.packaging.distro_targets
## Other targets ##
###################
.PHONY: docs
+
+# Build the documentation
+# Note that newly added RST files will likely not display on all documents'
+# navigation bar unless the docs/build folder is manually deleted.
docs: env
env/bin/sphinx-build -b html docs/source docs/build/html
env/bin/sphinx-build -b texinfo docs/source docs/build/texinfo
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 75dbccb2..b741865c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -19,6 +19,7 @@ As a developer looking to get started with a contribution, see
:maxdepth: 1
:glob:
+ users/downloading_and_installing
users/connecting_to_ldap
users/setting_up_turn_stun
diff --git a/docs/source/intro/getting_started.rst b/docs/source/intro/getting_started.rst
index be183b2a..87841a9f 100644
--- a/docs/source/intro/getting_started.rst
+++ b/docs/source/intro/getting_started.rst
@@ -5,4 +5,5 @@ Getting Started
To get started with Ring, you can install it from our repositories.
Instructions on installing Ring can be found on the
-`download section <https://ring.cx/en/download>`_ of the Ring website.
+:ref:`Downloading and installing <downloading_and_installing>` section of the current
+documentation.
\ No newline at end of file
diff --git a/docs/source/users/downloading_and_installing.rst b/docs/source/users/downloading_and_installing.rst
new file mode 100644
index 00000000..5a5eadd8
--- /dev/null
+++ b/docs/source/users/downloading_and_installing.rst
@@ -0,0 +1,41 @@
+.. _downloading_and_installing:
+
+Downloading and installing
+==========================
+
+In order to download and install Ring, first go to Ring’s
+`download page <https://ring.cx/en/download>`_ and select the appropriate
+platform for your software.
+
+For Gnome/Linux clients
+#######################
+
+Installing via the terminal
+---------------------------
+
+To install Ring from the terminal, you just need to follow these next steps:
+
+ 1. Select your Linux distribution (e.g., Debian 8).
+ 2. Copy the commands in the dark box and paste them in a terminal. It’s possible that you need root access for this.
+ 3. Execute the commands.
+
+Installing using binary packages
+--------------------------------
+
+If you wish to use an installator and install Ring manually, go to Ring’s
+`manual installation <https://ring.cx/en/download/gnu-linux/manual>`_ page and
+follow these steps:
+
+ 1. Select your Linux distribution from the drop-down list.
+ 2. Download and execute the daemon installer.
+ 3. Download and execute the client installer.
+
+
+Whether you install Ring via the terminal or binary packages, Ring should have
+been installed on your operating system and should appear in your applications
+list.
+
+Troubleshooting
+###############
+
+*This subsection is currently empty.*
\ No newline at end of file
--
GitLab