simplebus / docs Goto Github PK

The docs need updating to reflect the latest releases of simple-bus/symfony-bridge (5.2.0) and simple-bus/asynchronous-bundle (3.1.0) which now support private command handlers and event subscribers.

Describe what we do and what SimpleBus is not intended to do. We should describe the following thing.

• Why there is no QueryBus
• Why we don't allow to return anything
• That we are not a Event Sourcing library perse but it can be one if you created that part of the implementation

It seems that small typo error:
Why we do not have queries. Why we chose not to return thins from command handlers. Should be
Why we do not have queries. Why we chose not to return things from command handlers.

Move the documentation from the TODO section to this page

• http://docs.simplebus.io/en/latest/Bundles/DoctrineOrmBridgeBundle.html
• http://docs.simplebus.io/en/latest/SymfonyBridge/doctrine_orm_bridge_bundle.html

Adding an contributing step by step guide.

Move the documentation from the TODO section to this page

• http://docs.simplebus.io/en/latest/Bundles/CommandBusBundle.html
• http://docs.simplebus.io/en/latest/SymfonyBridge/command_bus_bundle.html

Personally i like the XML syntax and we use that in our projects but at the moment we only give the YAML examples i think we should investigate a multiple examples tabs way like symfony does this.

I missed the last section of your Asynchronous example while i was reviewing it. But the last part is not something i would suggest running in a cronjob. The rabbitmq:consume is a command that never stops running and keeps consuming messages. If there is no message there it just waits ontil there is a new message to consume. So if you configure this every minute than you will end up with a new worker every minute. We run this commands using supervisord.

• http://docs.simplebus.io/en/latest/Introduction/asynchronous-example.html#consuming-messages

There are some packages that integrate a specific thing that is not in the core but it may help some users in some way. I have listed a few examples

• Form intergration
• Mq2phpBundle

SimpleBus/rabbitmq-bundle-bridge#23

Like the suggestion in the main repository https://github.com/SimpleBus/MessageBus/issues/65

• MessageBus/getting_started
• MessageBus/message_recorder
• MessageBus/upgrade_guide
• SymfonyBridge/getting_started
• SymfonyBridge/upgrade_guide

Move the documentation from the TODO section to this page

• http://docs.simplebus.io/en/latest/Bundles/EventBusBundle.html
• http://docs.simplebus.io/en/latest/SymfonyBridge/event_bus_bundle.html

services:
    Infrastructure\CommandBus\Handler\:
        resource: '../../src/Infrastructure/CommandBus/Handler'
        public: true
        tags:
            - 'command_handler'

    Infrastructure\EventBus\Listener\:
        resource: '../../src/Infrastructure/EventBus/Listener'
        public: true
        tags:
            - 'event_subscriber'

@ruudk Do you have time for this?

• http://docs.simplebus.io/en/latest/Components/Asynchronous.html

I cannot generate the docs locally:

$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
make: sphinx-build: No such file or directory
make: *** [html] Error 1