From db28721d3c8322a0fe21eb0fb95c4560de1c6026 Mon Sep 17 00:00:00 2001 From: Markus Hauru Date: Wed, 24 Apr 2024 16:47:52 +0100 Subject: [PATCH] Fix some typos and broken links in the docs Signed-off-by: Markus Hauru --- docs/source/docker/docker.rst | 2 +- docs/source/getting-started/database.rst | 2 +- docs/source/getting-started/installation.rst | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/docker/docker.rst b/docs/source/docker/docker.rst index 170a5fce39..c1ef0e7818 100644 --- a/docs/source/docker/docker.rst +++ b/docs/source/docker/docker.rst @@ -10,7 +10,7 @@ Augur provides a separate Docker image for each layer of our application (databa Building the images -------------------- -All ``Dockerfiles`` and other Docker-related files are located in ``util/docker/``, where ```` is either ``backend``, ``frontend``, or ``database``. To build these images locally, use the following command, being sure to replace ```` and ```` as appropriate. +All ``Dockerfiles`` and other Docker-related files are located in ``docker/``, where ```` is either ``backend``, ``frontend``, or ``database``. To build these images locally, use the following command, being sure to replace ```` and ```` as appropriate. .. code-block:: bash diff --git a/docs/source/getting-started/database.rst b/docs/source/getting-started/database.rst index 056be08ba3..8eee00416a 100644 --- a/docs/source/getting-started/database.rst +++ b/docs/source/getting-started/database.rst @@ -1,7 +1,7 @@ Database setup =============== -One of the reasons that Augur is so powerful is because of its `unified data model <../schema/data-model.html>`_. +One of the reasons that Augur is so powerful is because of its `unified data model <../schema/overview.html>`_. To ensure this data model remains performant with large amounts of data, we use PostgreSQL as our database engine. We'll need to set up a PostgreSQL instance and create a database, after which Augur can take care of the rest. Make sure to save off the credentials you use when creating the database; you'll need them again to configure Augur. diff --git a/docs/source/getting-started/installation.rst b/docs/source/getting-started/installation.rst index df0379f1f9..5c2e2f62f7 100644 --- a/docs/source/getting-started/installation.rst +++ b/docs/source/getting-started/installation.rst @@ -69,6 +69,7 @@ After installation, you must also set up your rabbitmq instance by running the b to communicate with nodes. Then, start rabbitmq server with + .. code-block:: bash sudo systemctl start rabbitmq.service @@ -76,7 +77,7 @@ Then, start rabbitmq server with If your setup of rabbitmq is successful your broker url should look like this: -broker_url = 'amqp://augur:password123@localhost:5672/augur_vhost' +``broker_url = 'amqp://augur:password123@localhost:5672/augur_vhost'`` During installation you will be prompted for this broker url.