diff --git a/Makefile.packaging b/Makefile.packaging index 20c6796e648416362df2071b4209b6da6d08bfba..f17899669770e62b40960f96298b3458d823047e 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 75dbccb2b122cf8e7c49a92f29639a007b5d3c0f..b741865c9cf87101c8e87d1b72d06c97f2c65ce4 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 be183b2affedbff6fc07fe17b03798d3b4df9e65..87841a9f4e52c352eb0a5f3dcda5f45ecfefcd98 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 0000000000000000000000000000000000000000..5a5eadd8ed1c9fd152fe6f07732f245c840f006b --- /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