openstack/python-tackerclient
Code Issues Proposed changes

Fix old links in installation guide

Browse Source 
The installation guide refers to old github links in order to
install python-tackerclient.

This patch replaces old links [1] with new source code links [2].
Additionally, restructure document content for readability.

[1] https://github.com/openstack/python-tackerclient
[2] https://opendev.org/openstack/python-tackerclient

Closes-Bug: #1914534
Change-Id: I4876a9a2f61d5539b724a888ee2d941a989be717
This commit is contained in:
Manpreet Kaur
2021-02-08 15:48:44 +05:30
parent bbe6d2c7e0
commit 17f4bcac1a
1 changed files with 22 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
doc/source/install/index.rst
View File

@@ -11,59 +11,53 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
============ ============
Installation Installation
============ ============
**Note:** The paths we are using for configuration files in these steps This document describes how to install python-tackerclient.
are with reference to Ubuntu Operating System. The paths may vary for
other Operating Systems.
The branch_name which is used in commands, specify the branch_name .. note::
as stable/<branch> for any stable branch installation. For eg:
stable/queens, stable/pike. If unspecified the default will be This installation guide contents are specific to Ubuntu distro.
master branch.
Using python install Using python install
==================== ====================
1. Clone python-tackerclient repository.
:: #. Clone python-tackerclient repository.
$ cd ~/ You can use -b for specific release, optionally.
$ git clone https://github.com/openstack/python-tackerclient -b <branch_name>
.. code-block:: console
2. Install python-tackerclient. $ cd ~/
$ git clone https://opendev.org/openstack/python-tackerclient -b <branch_name>
:: .. note::
$ cd python-tackerclient Make sure to replace the ``<branch_name>`` in command example with
$ sudo python setup.py install specific branch name, such as ``stable/victoria``.
#. Install python-tackerclient.
.. code-block:: console
$ cd python-tackerclient
$ sudo python3 setup.py install
Using pip Using pip
========= =========
You can also install the latest version by using ``pip`` command: You can also install the latest version by using ``pip`` command:
:: .. code-block:: console
$ pip install python-tackerclient
$ pip3 install python-tackerclient
Or, if it is needed to install ``python-tackerclient`` from master branch, Or, if it is needed to install ``python-tackerclient`` from master branch,
type type
:: .. code-block:: console
$ pip install git+https://github.com/openstack/python-tackerclient.git $ pip3 install git+https://opendev.org/openstack/python-tackerclient