diff --git a/docs/source/guides/install-guides/apt/automatic_install.rst b/docs/source/guides/install-guides/apt/automatic_install.rst index 63b17e7cc..84dd06fd8 100644 --- a/docs/source/guides/install-guides/apt/automatic_install.rst +++ b/docs/source/guides/install-guides/apt/automatic_install.rst @@ -1,5 +1,5 @@ -Automatically Installing xCAT -============================= +Automatic Install Using ``go-xcat`` +=================================== .. include:: ../common_sections.rst :start-after: BEGIN_automatic_install diff --git a/docs/source/guides/install-guides/apt/manual_install.rst b/docs/source/guides/install-guides/apt/manual_install.rst index b811708a2..0f048e5f0 100644 --- a/docs/source/guides/install-guides/apt/manual_install.rst +++ b/docs/source/guides/install-guides/apt/manual_install.rst @@ -1,5 +1,5 @@ -Manually Installing xCAT -======================== +Manual Install Using Software Repositories +========================================== .. include:: ../common_sections.rst :start-after: BEGIN_install_xcat_introduction diff --git a/docs/source/guides/install-guides/common_sections.rst b/docs/source/guides/install-guides/common_sections.rst index c40a27df2..d4fdad136 100644 --- a/docs/source/guides/install-guides/common_sections.rst +++ b/docs/source/guides/install-guides/common_sections.rst @@ -54,20 +54,20 @@ xCAT consists of two software packages: ``xcat-core`` and ``xcat-dep`` .. BEGIN_installation_methods -There are two methods for installing xCAT. The first method, automatic install, leverages a tool named `go-xcat` to automatically install xCAT and its components. The second method is to manually install xCAT through the provided repositories. +The following sections describe the different methods for installing xCAT. .. END_installation_methods .. BEGIN_automatic_install -`go-xcat` is a tool that can be used to fully install or update xCAT +``go-xcat`` is a tool that can be used to fully install or update xCAT. ``go-xcat`` will automatically download the correct package manager repository file from xcat.org and use the public repository to install xCAT. If the xCAT management node does not have internet connectivity, use process described in the Manual Installation section of the guide. -#. Download the `go-xcat` tool using `wget`: :: +#. Download the ``go-xcat`` tool using ``wget``: :: - wget http:xcat.org/files/go-xcat -O - >/tmp/go-xcat + wget http://xcat.org/files/go-xcat -O - >/tmp/go-xcat chmod +x /tmp/go-xcat -#. Run the `go-xcat` tool: :: +#. Run the ``go-xcat`` tool: :: /tmp/go-xcat install # installs the latest stable version of xCAT /tmp/go-xcat -x devel install # installs the latest development version of xCAT diff --git a/docs/source/guides/install-guides/index.rst b/docs/source/guides/install-guides/index.rst index a284f704a..09a92b510 100644 --- a/docs/source/guides/install-guides/index.rst +++ b/docs/source/guides/install-guides/index.rst @@ -4,7 +4,7 @@ Install Guides ============== .. toctree:: - :maxdepth: 2 + :maxdepth: 2 yum/index.rst zypper/index.rst diff --git a/docs/source/guides/install-guides/yum/automatic_install.rst b/docs/source/guides/install-guides/yum/automatic_install.rst index 63b17e7cc..84dd06fd8 100644 --- a/docs/source/guides/install-guides/yum/automatic_install.rst +++ b/docs/source/guides/install-guides/yum/automatic_install.rst @@ -1,5 +1,5 @@ -Automatically Installing xCAT -============================= +Automatic Install Using ``go-xcat`` +=================================== .. include:: ../common_sections.rst :start-after: BEGIN_automatic_install diff --git a/docs/source/guides/install-guides/yum/manual_install.rst b/docs/source/guides/install-guides/yum/manual_install.rst index b811708a2..0f048e5f0 100644 --- a/docs/source/guides/install-guides/yum/manual_install.rst +++ b/docs/source/guides/install-guides/yum/manual_install.rst @@ -1,5 +1,5 @@ -Manually Installing xCAT -======================== +Manual Install Using Software Repositories +========================================== .. include:: ../common_sections.rst :start-after: BEGIN_install_xcat_introduction diff --git a/docs/source/guides/install-guides/zypper/automatic_install.rst b/docs/source/guides/install-guides/zypper/automatic_install.rst index 63b17e7cc..84dd06fd8 100644 --- a/docs/source/guides/install-guides/zypper/automatic_install.rst +++ b/docs/source/guides/install-guides/zypper/automatic_install.rst @@ -1,5 +1,5 @@ -Automatically Installing xCAT -============================= +Automatic Install Using ``go-xcat`` +=================================== .. include:: ../common_sections.rst :start-after: BEGIN_automatic_install diff --git a/docs/source/guides/install-guides/zypper/manual_install.rst b/docs/source/guides/install-guides/zypper/manual_install.rst index b811708a2..0f048e5f0 100644 --- a/docs/source/guides/install-guides/zypper/manual_install.rst +++ b/docs/source/guides/install-guides/zypper/manual_install.rst @@ -1,5 +1,5 @@ -Manually Installing xCAT -======================== +Manual Install Using Software Repositories +========================================== .. include:: ../common_sections.rst :start-after: BEGIN_install_xcat_introduction