diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 26d2f35..f74eeef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ Below are a few tools that can be used to run containers: -### Docker +### Docker (Preferred) If you have [Docker](https://docs.docker.com/desktop/) installed, the containers can be run with the following command: diff --git a/README.md b/README.md index 26a652f..3ac1739 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The following requirements must be met to use this package in your project: * While `EctoPGMQ.Migrations` contains helper functions for _managing_ the PGMQ extension, this package does **NOT** include the PGMQ extension. For additional information about installing PGMQ, see - [PGMQ Installation](`m:EctoPGMQ#pgmq-installation`). + [PGMQ Installation](pgmq_installation.md). ## Installation diff --git a/guides/fifo_message_groups.md b/guides/fifo_message_groups.md index f17c75b..20c8b7b 100644 --- a/guides/fifo_message_groups.md +++ b/guides/fifo_message_groups.md @@ -5,7 +5,7 @@ This guide covers the usage of FIFO message groups. ## When to Use While PGMQ queues are inherently FIFO data structures, messages can be processed -in non-deterministic order when message processing is parallelized within a +in a non-deterministic order when message processing is parallelized within a single consumer and/or across multiple consumers. In many cases, this isn't an issue but there is sometimes a need to consume messages strictly in order within a group. In order to support this, PGMQ exposes a number of functions that read diff --git a/guides/notifications.md b/guides/notifications.md index f8e2b73..650ae64 100644 --- a/guides/notifications.md +++ b/guides/notifications.md @@ -19,9 +19,9 @@ setting the throttle interval to `0`. ## Managing Notifications -The notification configuration can be managed with `EctoPGMQ.create_queue/4` -and `EctoPGMQ.update_queue/4` (or the corresponding functions in the -`EctoPGMQ.Migrations` module): +The notification configuration for a queue can be managed with +`EctoPGMQ.create_queue/4` and `EctoPGMQ.update_queue/4` (or the corresponding +functions in the `EctoPGMQ.Migrations` module): ```elixir # Create a queue with notifications enabled