Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos and broken links in the docs #2773

Merged
merged 1 commit into from
May 6, 2024
Merged

Fix some typos and broken links in the docs #2773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/docker/docker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<service_name>``, where ``<service_name>`` is either ``backend``, ``frontend``, or ``database``. To build these images locally, use the following command, being sure to replace ``<tag_name>`` and ``<service_name>`` as appropriate.
All ``Dockerfiles`` and other Docker-related files are located in ``docker/<service_name>``, where ``<service_name>`` is either ``backend``, ``frontend``, or ``database``. To build these images locally, use the following command, being sure to replace ``<tag_name>`` and ``<service_name>`` as appropriate.

.. code-block:: bash

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/database.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docs/source/getting-started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,15 @@ 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


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.

Expand Down
Loading