From eeff5c7d241eeb1e70034eaea581c45313305d43 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Fri, 23 Feb 2018 23:08:55 +0000 Subject: [PATCH] Docs: Touch up getting started documentation This is to fix up a slight rendering issue with getting started documentation related to double code block syntax. Change-Id: I4b6777f77d148113e5a798aeb3daa520d05c1f0e --- AUTHORS | 1 + doc/source/getting-started.rst | 31 +++++++++++++------------------ 2 files changed, 14 insertions(+), 18 deletions(-) diff --git a/AUTHORS b/AUTHORS index 1d33c9a4..b82bb15d 100644 --- a/AUTHORS +++ b/AUTHORS @@ -9,5 +9,6 @@ Mark Burnett Mike Kochetov Pete Birley Scott Hussey +Stacey Fletcher Tin Lam portdirect diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index b8ad71d3..af28ffea 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -8,14 +8,14 @@ Pre-requisites To install tox run:: - $ sudo apt-get install tox + $ [sudo] apt-get install tox * PostgreSQL Deckhand only supports PostgreSQL. Install it by running:: - $ sudo apt-get update - $ sudo apt-get install postgresql postgresql-contrib + $ [sudo] apt-get update + $ [sudo] apt-get install postgresql postgresql-contrib Quickstart ---------- @@ -39,19 +39,17 @@ Move the sample configuration file into a desired directory Set the database string in the configuration file to ``sqlite://`` -:: +.. code-block:: ini - .. code-block:: ini + [database] - [database] + # + # From oslo.db + # - # - # From oslo.db - # - - # The SQLAlchemy connection string to use to connect to the database. - # (string value) - connection = sqlite:// + # The SQLAlchemy connection string to use to connect to the database. + # (string value) + connection = sqlite:// Finally, run Deckhand via Docker:: @@ -88,8 +86,6 @@ Substitute the connection information (which can be retrieved by running ``export | grep PIFPAF_POSTGRESQL_URL``) into the config file inside ``etc/deckhand/deckhand.conf.sample``:: -.. code-block:: ini - [database] # @@ -158,8 +154,6 @@ Retrieve the environment variable which contains connection information:: Substitute the connection information into the config file in ``${OS_DECKHAND_CONFIG_DIR}``:: -.. code-block:: ini - [database] # @@ -172,7 +166,8 @@ Substitute the connection information into the config file in Finally, run Deckhand:: - $ uwsgi --ini wsgi.ini + $ chmod +x entrypoint.sh + $ ./entrypoint.sh To kill the ephemeral DB afterward::