2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-22 03:00:26 +00:00

Added suggested changes to go-xcat documentation

This commit is contained in:
Patrick Lundgren
2016-10-25 11:17:34 -04:00
parent bf6e84f5e5
commit 0a2bfd94b7
8 changed files with 18 additions and 18 deletions

View File

@@ -1,5 +1,5 @@
Automatically Installing xCAT
=============================
Automatic Install Using ``go-xcat``
===================================
.. include:: ../common_sections.rst
:start-after: BEGIN_automatic_install

View File

@@ -1,5 +1,5 @@
Manually Installing xCAT
========================
Manual Install Using Software Repositories
==========================================
.. include:: ../common_sections.rst
:start-after: BEGIN_install_xcat_introduction

View File

@@ -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

View File

@@ -4,7 +4,7 @@ Install Guides
==============
.. toctree::
:maxdepth: 2
:maxdepth: 2
yum/index.rst
zypper/index.rst

View File

@@ -1,5 +1,5 @@
Automatically Installing xCAT
=============================
Automatic Install Using ``go-xcat``
===================================
.. include:: ../common_sections.rst
:start-after: BEGIN_automatic_install

View File

@@ -1,5 +1,5 @@
Manually Installing xCAT
========================
Manual Install Using Software Repositories
==========================================
.. include:: ../common_sections.rst
:start-after: BEGIN_install_xcat_introduction

View File

@@ -1,5 +1,5 @@
Automatically Installing xCAT
=============================
Automatic Install Using ``go-xcat``
===================================
.. include:: ../common_sections.rst
:start-after: BEGIN_automatic_install

View File

@@ -1,5 +1,5 @@
Manually Installing xCAT
========================
Manual Install Using Software Repositories
==========================================
.. include:: ../common_sections.rst
:start-after: BEGIN_install_xcat_introduction