Fixes Documentation issue #245 #339
Conversation
docs/tutorial/installation.rst
Outdated
|
|
||
| Ensure the following steps are taken to configure `passive_declares`: | ||
|
|
||
| 1. **Access Configuration File**: Locate the `config.toml` file for Fedora Messaging. This file is typically found at `config.toml.example`. |
There was a problem hiding this comment.
That part is not correct, applications will usually have their Fedora Messaging config file at /etc/fedora-messaging/config.toml". The .example` file is just what is provided by the library as an example, that's not what client applications will actually use.
There was a problem hiding this comment.
Is it fine now ?
vidit-maheshwari
force-pushed
the
new_branch
branch
from
06a795a to
877da47
Compare
|
@abompard i have made the necessary changes, could you please review ? |
|
This setting is actually only necessary for clients of Fedora's restricted broker. Please add it to the appropriate section at the bottom of |
vidit-maheshwari
force-pushed
the
new_branch
branch
from
0248b17 to
72f8dc1
Compare
|
@abompard i have done the required changes as per your instructions. Kindly review it. |
docs/user-guide/quick-start.rst
Outdated
|
|
||
| **Note:** It is essential to configure the ``passive_declares`` option correctly in the ``/etc/fedora-messaging/config.toml`` file. This setting is mandatory for users of Fedora's ``/pubsub`` vhost and should be set to ``true``. It controls the declaration of queues and exchanges. | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Given the text above, I don't think this example brings a lot of value.
docs/user-guide/quick-start.rst
Outdated
| @@ -145,3 +145,11 @@ Connecting the Fedora's private virtual host requires working with the Fedora | |||
| infrastructure team. The current process and configuration for this is | |||
| documented in the `infrastructure team's development guide | |||
| <https://fedora-infra-docs.readthedocs.io/en/latest/dev-guide/messaging.html>`_. | |||
|
|
|||
| **Note:** It is essential to configure the ``passive_declares`` option correctly in the ``/etc/fedora-messaging/config.toml`` file. This setting is mandatory for users of Fedora's ``/pubsub`` vhost and should be set to ``true``. It controls the declaration of queues and exchanges. | |||
There was a problem hiding this comment.
Please follow the line length convention of this file.
There was a problem hiding this comment.
Hey @abompard i have made the changes kindly review it.
vidit-maheshwari
force-pushed
the
new_branch
branch
from
4a4dc2b to
6da2195
Compare
|
@abompard I have made the changes according to the line length convention and removed the example section as you said, Kindly review it if further any changes are required. |
|
Ah there's just one small thing, we have a linter that detected something wrong with the files not ending in a newline. Please setup pre-commit: |
vidit-maheshwari
force-pushed
the
new_branch
branch
2 times, most recently
from
9d7162e to
68abaf7
Compare
vidit-maheshwari
force-pushed
the
new_branch
branch
from
68abaf7 to
6f35e05
Compare
Summary
Fixes #245
This pull request aims to improve the documentation for configuring Fedora Messaging by adding a reminder regarding the
passive_declaresoption to be settrue.Changes Made
passive_declarestotruein the Fedora Messaging configuration.config.tomlfile and set thepassive_declaresoption.Purpose
By enhancing the documentation with this reminder, we aim to reduce potential issues for users of Fedora's
/pubsubvhost who might forget to configurepassive_declares. Ensuring thatpassive_declaresis correctly set totrueis essential for proper functioning of queues and exchanges in Fedora Messaging.Here is the preview of the changes made: