Drop empty documentation sections

... and fix the invalid installation guide to avoid confusions. Tempest plugins are developed for testing so detailed documentation is not usually needed. Change-Id: I9632a02b96e02b69e6592f731c214d771218fcdf
2025-01-07 11:00:14 +09:00
parent ee3079db74
commit 089c9a3835
18 changed files with 13 additions and 301 deletions
--- a/doc/source/admin/index.rst
+++ b/doc/source/admin/index.rst
@@ -1,5 +0,0 @@
 ====================
 Administrators guide
 ====================
 Administrators guide of openstack.
--- a/doc/source/cli/index.rst
+++ b/doc/source/cli/index.rst
@@ -1,5 +0,0 @@
 ================================
 Command line interface reference
 ================================
 CLI reference of openstack.
--- a/doc/source/configuration/index.rst
+++ b/doc/source/configuration/index.rst
@@ -1,5 +0,0 @@
 =============
 Configuration
 =============
 Configuration of openstack.
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -13,14 +13,8 @@ Contents:
   :maxdepth: 2
   readme
-   install/index
+   installation
   library/index
   contributor/index
   configuration/index
   cli/index
   user/index
   admin/index
   reference/index
 Indices and tables
 ==================
--- a/doc/source/install/common_configure.rst
+++ b/doc/source/install/common_configure.rst
@@ -1,10 +0,0 @@
 2. Edit the ``/etc/manila-tempest-plugin/manila-tempest-plugin.conf`` file and complete the following
   actions:
   * In the ``[database]`` section, configure database access:
     .. code-block:: ini
        [database]
        ...
        connection = mysql+pymysql://manila-tempest-plugin:MANILA-TEMPEST-PLUGIN_DBPASS@controller/manila-tempest-plugin
--- a/doc/source/install/common_prerequisites.rst
+++ b/doc/source/install/common_prerequisites.rst
@@ -1,75 +0,0 @@
 Prerequisites
 -------------
 Before you install and configure the openstack service,
 you must create a database, service credentials, and API endpoints.
 #. To create the database, complete these steps:
   * Use the database access client to connect to the database
     server as the ``root`` user:
     .. code-block:: console
        $ mysql -u root -p
   * Create the ``manila-tempest-plugin`` database:
     .. code-block:: none
        CREATE DATABASE manila-tempest-plugin;
   * Grant proper access to the ``manila-tempest-plugin`` database:
     .. code-block:: none
        GRANT ALL PRIVILEGES ON manila-tempest-plugin.* TO 'manila-tempest-plugin'@'localhost' \
          IDENTIFIED BY 'MANILA-TEMPEST-PLUGIN_DBPASS';
        GRANT ALL PRIVILEGES ON manila-tempest-plugin.* TO 'manila-tempest-plugin'@'%' \
          IDENTIFIED BY 'MANILA-TEMPEST-PLUGIN_DBPASS';
     Replace ``MANILA-TEMPEST-PLUGIN_DBPASS`` with a suitable password.
   * Exit the database access client.
     .. code-block:: none
        exit;
 #. Source the ``admin`` credentials to gain access to
   admin-only CLI commands:
   .. code-block:: console
      $ . admin-openrc
 #. To create the service credentials, complete these steps:
   * Create the ``manila-tempest-plugin`` user:
     .. code-block:: console
        $ openstack user create --domain default --password-prompt manila-tempest-plugin
   * Add the ``admin`` role to the ``manila-tempest-plugin`` user:
     .. code-block:: console
        $ openstack role add --project service --user manila-tempest-plugin admin
   * Create the manila-tempest-plugin service entities:
     .. code-block:: console
        $ openstack service create --name manila-tempest-plugin --description "openstack" openstack
 #. Create the openstack service API endpoints:
   .. code-block:: console
      $ openstack endpoint create --region RegionOne \
        openstack public http://controller:XXXX/vY/%\(tenant_id\)s
      $ openstack endpoint create --region RegionOne \
        openstack internal http://controller:XXXX/vY/%\(tenant_id\)s
      $ openstack endpoint create --region RegionOne \
        openstack admin http://controller:XXXX/vY/%\(tenant_id\)s
--- a/doc/source/install/get_started.rst
+++ b/doc/source/install/get_started.rst
@@ -1,9 +0,0 @@
 ==========================
 openstack service overview
 ==========================
 The openstack service provides...
 The openstack service consists of the following components:
 ``manila-tempest-plugin-api`` service
  Accepts and responds to end user compute API calls...
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
@@ -1,17 +0,0 @@
 ====================================
 openstack service installation guide
 ====================================
 .. toctree::
   :maxdepth: 2
   get_started.rst
   install.rst
   verify.rst
   next-steps.rst
 The openstack service (manila-tempest-plugin) provides...
 This chapter assumes a working setup of OpenStack following the
 `OpenStack Installation Tutorial
 <https://docs.openstack.org/project-install-guide/ocata/>`_.
--- a/doc/source/install/install-obs.rst
+++ b/doc/source/install/install-obs.rst
@@ -1,34 +0,0 @@
 .. _install-obs:
 Install and configure for openSUSE and SUSE Linux Enterprise
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This section describes how to install and configure the openstack service
 for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
 .. include:: common_prerequisites.rst
 Install and configure components
 --------------------------------
 #. Install the packages:
   .. code-block:: console
      # zypper --quiet --non-interactive install
 .. include:: common_configure.rst
 Finalize installation
 ---------------------
 Start the openstack services and configure them to start when
 the system boots:
 .. code-block:: console
   # systemctl enable openstack-manila-tempest-plugin-api.service
   # systemctl start openstack-manila-tempest-plugin-api.service
--- a/doc/source/install/install-rdo.rst
+++ b/doc/source/install/install-rdo.rst
@@ -1,33 +0,0 @@
 .. _install-rdo:
 Install and configure for Red Hat Enterprise Linux and CentOS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This section describes how to install and configure the openstack service
 for Red Hat Enterprise Linux 7 and CentOS 7.
 .. include:: common_prerequisites.rst
 Install and configure components
 --------------------------------
 #. Install the packages:
   .. code-block:: console
      # yum install
 .. include:: common_configure.rst
 Finalize installation
 ---------------------
 Start the openstack services and configure them to start when
 the system boots:
 .. code-block:: console
   # systemctl enable openstack-manila-tempest-plugin-api.service
   # systemctl start openstack-manila-tempest-plugin-api.service
--- a/doc/source/install/install-ubuntu.rst
+++ b/doc/source/install/install-ubuntu.rst
@@ -1,31 +0,0 @@
 .. _install-ubuntu:
 Install and configure for Ubuntu
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This section describes how to install and configure the openstack
 service for Ubuntu 14.04 (LTS).
 .. include:: common_prerequisites.rst
 Install and configure components
 --------------------------------
 #. Install the packages:
   .. code-block:: console
      # apt-get update
      # apt-get install
 .. include:: common_configure.rst
 Finalize installation
 ---------------------
 Restart the openstack services:
 .. code-block:: console
   # service openstack-manila-tempest-plugin-api restart
--- a/doc/source/install/install.rst
+++ b/doc/source/install/install.rst
@@ -1,20 +0,0 @@
 .. _install:
 Install and configure
 ~~~~~~~~~~~~~~~~~~~~~
 This section describes how to install and configure the
 openstack service, code-named manila-tempest-plugin, on the controller node.
 This section assumes that you already have a working OpenStack
 environment with at least the following components installed:
 .. (add the appropriate services here and further notes)
 Note that installation and configuration vary by distribution.
 .. toctree::
   :maxdepth: 2
   install-obs.rst
   install-rdo.rst
   install-ubuntu.rst
--- a/doc/source/install/next-steps.rst
+++ b/doc/source/install/next-steps.rst
@@ -1,9 +0,0 @@
 .. _next-steps:
 Next steps
 ~~~~~~~~~~
 Your OpenStack environment now includes the manila-tempest-plugin service.
 To add additional services, see
 https://docs.openstack.org/project-install-guide/ocata/.
--- a/doc/source/install/verify.rst
+++ b/doc/source/install/verify.rst
@@ -1,24 +0,0 @@
 .. _verify:
 Verify operation
 ~~~~~~~~~~~~~~~~
 Verify operation of the openstack service.
 .. note::
   Perform these commands on the controller node.
 #. Source the ``admin`` project credentials to gain access to
   admin-only CLI commands:
   .. code-block:: console
      $ . admin-openrc
 #. List service components to verify successful launch and registration
   of each process:
   .. code-block:: console
      $ openstack openstack service list
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -0,0 +1,12 @@
 ============
 Installation
 ============
 At the command line::
    $ pip install manila-tempest-plugin
 Or, if you have virtualenvwrapper installed::
    $ mkvirtualenv manila-tempest-plugin
    $ pip install manila-tempest-plugin
--- a/doc/source/library/index.rst
+++ b/doc/source/library/index.rst
@@ -1,7 +0,0 @@
 ========
 Usage
 ========
 To use openstack in a project::
    import manila-tempest-plugin
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -1,5 +0,0 @@
 ==========
 References
 ==========
 References of openstack.
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@@ -1,5 +0,0 @@
 ===========
 Users guide
 ===========
 Users guide of openstack.