diff --git a/docs/usage/example.rst b/docs/usage/example.rst index c3b14c01..5a5149c4 100644 --- a/docs/usage/example.rst +++ b/docs/usage/example.rst @@ -7,24 +7,24 @@ This is a quick guide for creating and running a simple pipeline to analysis an #. Install RAPIDS. See :ref:`Installation Section `. -#. Configure your database credentials (see example below or step 1 of :ref:`Usage Section ` for more information). +#. Configure your database credentials (see the example below or step 1 of :ref:`Usage Section ` for more information). - #. Create an ``.env`` file at the root of RAPIDS folder - #. Your MySQL user must have write permissions because we will restore our example database - #. Name your credentials group ``MY_GROUP``. - #. If you are trying to connect to a local MySQL server from our docker container set your host according to this link_. - #. You can name your database anyway you want, for example ``rapids_example`` + - Create an ``.env`` file at the root of RAPIDS folder + - Your MySQL user must have write permissions because we will restore our example database + - Name your credentials group ``MY_GROUP``. + - If you are trying to connect to a local MySQL server from our docker container set your host according to this link_. + - You can name your database any way you want, for example ``rapids_example`` .. code-block:: - - [MY_GROUP] - user=rapids - password=rapids - host=127.0.0.1 # or use host.docker.internal from our docker container - port=3306 - database=rapids_example -#. Make sure your Conda (python) environment is active (the environment is already active in our docker container). See step 6 of :ref:`install-page`. + [MY_GROUP] + user=rapids + password=rapids + host=127.0.0.1 # or use host.docker.internal from our docker container + port=3306 + database=rapids_example + +#. Make sure your conda environment is active (the environment is already active in our docker container). See step 6 of :ref:`install-page`. #. Run the following command to restore database from ``rapids_example.sql`` file::