diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 19dd13d..0849d10 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -2,4 +2,4 @@ Administrators guide ==================== -Administrators guide of fenix. +Administrators guide of Fenix. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index f3319c7..153ba3c 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -2,4 +2,4 @@ Command line interface reference ================================ -CLI reference of fenix. +CLI reference of Fenix. diff --git a/doc/source/index.rst b/doc/source/index.rst index e257c9e..333e339 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,10 +1,10 @@ -.. fenix documentation master file, created by +.. Fenix documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. ===================================== -Welcome to the documentation of fenix +Welcome to the documentation of Fenix ===================================== Contents: diff --git a/doc/source/install/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst index 70690e5..eab0f44 100644 --- a/doc/source/install/common_prerequisites.rst +++ b/doc/source/install/common_prerequisites.rst @@ -1,7 +1,7 @@ Prerequisites ------------- -Before you install and configure the fenix service, +Before you install and configure the Fenix service, you must create a database, service credentials, and API endpoints. #. To create the database, complete these steps: @@ -57,7 +57,7 @@ you must create a database, service credentials, and API endpoints. $ openstack role add --project service --user fenix admin - * Create the fenix service entities: + * Create the Fenix service entities: .. code-block:: console @@ -68,7 +68,7 @@ you must create a database, service credentials, and API endpoints. those nodes. This means you may want to have the ssh without password configured for Fenix service user. -#. Create the fenix service API endpoints: +#. Create the Fenix service API endpoints: .. code-block:: console @@ -82,8 +82,8 @@ you must create a database, service credentials, and API endpoints. Installation ------------ -Note! Fenix is not currently included to Linux distros. -You need to clone and install from source. +Note! Fenix is currently not included in Linux distributions. +You need to clone and install it from source. .. code-block:: console diff --git a/doc/source/install/get_started.rst b/doc/source/install/get_started.rst index 2d543c0..109a582 100644 --- a/doc/source/install/get_started.rst +++ b/doc/source/install/get_started.rst @@ -1,9 +1,9 @@ ====================== -fenix service overview +Fenix service overview ====================== -The fenix service provides... +The Fenix service provides... -The fenix service consists of the following components: +The Fenix service consists of the following components: ``fenix-api`` service Accepts and responds to end user API calls diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 7800a0a..18a7ea9 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -1,5 +1,5 @@ ================================ -fenix service installation guide +Fenix service installation guide ================================ .. toctree:: @@ -9,8 +9,8 @@ fenix service installation guide install.rst verify.rst -The fenix service (fenix) provides... +The host maintenance service (Fenix) provides... This chapter assumes a working setup of OpenStack following the `OpenStack Installation Tutorial -`_. +`_. diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst index 2bdffa5..1ae8482 100644 --- a/doc/source/install/install-obs.rst +++ b/doc/source/install/install-obs.rst @@ -4,7 +4,7 @@ Install and configure for openSUSE and SUSE Linux Enterprise ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the fenix service +This section describes how to install and configure the Fenix service for openSUSE and SUSE Linux Enterprise Server. .. include:: common_prerequisites.rst diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst index 75bfd11..6500f15 100644 --- a/doc/source/install/install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -4,7 +4,7 @@ Install and configure for Red Hat Enterprise Linux and CentOS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the fenix service +This section describes how to install and configure the Fenix service for Red Hat Enterprise Linux and CentOS. .. include:: common_prerequisites.rst diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst index 24aa70a..7a1f397 100644 --- a/doc/source/install/install-ubuntu.rst +++ b/doc/source/install/install-ubuntu.rst @@ -3,7 +3,7 @@ Install and configure for Ubuntu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the fenix +This section describes how to install and configure the Fenix service for Ubuntu. .. include:: common_prerequisites.rst diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst index 39f394e..45eb0f9 100644 --- a/doc/source/install/install.rst +++ b/doc/source/install/install.rst @@ -4,7 +4,7 @@ Install and configure ~~~~~~~~~~~~~~~~~~~~~ This section describes how to install and configure the -fenix service, code-named fenix, on the controller node. +host maintenance service, code-named Fenix, on the controller node. This section assumes that you already have a working OpenStack environment. diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst index 2688f9c..5c40ec1 100644 --- a/doc/source/library/index.rst +++ b/doc/source/library/index.rst @@ -1,7 +1,7 @@ -======== +===== Usage -======== +===== -To use fenix in a project:: +To use Fenix in a project:: TBD diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index c95a6ab..fc5ea40 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -2,4 +2,4 @@ References ========== -References of fenix. +References of Fenix.