Skip to content

Better Symfony doc nav #862

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.

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

Merged
merged 3 commits into from
May 28, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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/bundle/async_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ if ($replyMessage = $promise->receive(5000)) {
}
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/async_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,4 @@ services:
The `eventName` attribute accepts a regexp. You can do next `eventName: '/foo\..*?/'`.
It uses this transformer for all event with the name beginning with `foo.`

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/cli_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ Help:
A worker that consumes message from a broker. To use this broker you have to explicitly set a queue to consume from and a message processor service
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/config_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ enqueue:
reply_extension: true
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/consumption_extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ services:
- { name: 'enqueue.consumption.extension', priority: 10 }
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ You can add `-vvv` to see more information.

![Consume command verbosity](../images/consume_command_verbosity.png)

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/functional_testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ class FooTest extends WebTestCase
}
```

[back to index](../index.md)
[back to index](index.md)
16 changes: 16 additions & 0 deletions docs/bundle/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Symfony Bundle

* [Quick tour](quick_tour.md)
* [Config reference](config_reference.md)
* [Cli commands](cli_commands.md)
* [Message producer](message_producer.md)
* [Message processor](message_processor.md)
* [Async events](async_events.md)
* [Async commands](async_commands.md)
* [Job queue](job_queue.md)
* [Consumption extension](consumption_extension.md)
* [Production settings](production_settings.md)
* [Debugging](debugging.md)
* [Functional testing](functional_testing.md)

[back to index](../index.md)
2 changes: 1 addition & 1 deletion docs/bundle/job_queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,4 +297,4 @@ class ReindexProcessor implements Processor
}
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/message_processor.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,4 +181,4 @@ Now you can run a command and tell it to consume from a given queue and process
$ ./bin/console enqueue:transport:consume say_hello foo_queue -vvv
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/message_producer.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ $spoolProducer->sendCommand('a_processor_name', 'Hello there!');
$spoolProducer->flush();
```

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/production_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ redirect_stderr=true

_**Note**: Pay attention to `--time-limit` it tells the command to exit after 5 minutes._

[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/bundle/quick_tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@ $ ./bin/console enqueue:consume --setup-broker -vvv
_**Note**: Add -vvv to find out what is going while you are consuming messages. There is a lot of valuable debug info there._


[back to index](../index.md)
[back to index](index.md)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
* [Job queue](#job-queue)
- [Run unique job](job_queue/run_unique_job.md)
- [Run sub job(s)](job_queue/run_sub_job.md)
* [EnqueueBundle (Symfony)](#enqueue-bundle-symfony).
* [EnqueueBundle (Symfony)](bundle/index.md)
- [Quick tour](bundle/quick_tour.md)
- [Config reference](bundle/config_reference.md)
- [Cli commands](bundle/cli_commands.md)
Expand Down
5 changes: 5 additions & 0 deletions docs/quick_tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Enqueue is an MIT-licensed open source project with its ongoing development made
* [Client](#client)
* [Cli commands](#cli-commands)
* [Monitoring](#monitoring)
* [Symfony bundle](#symfony)

## Transport

Expand Down Expand Up @@ -287,3 +288,7 @@ $ app.php consume
There is a tool that can track sent\consumed messages as well as consumer performance. Read more [here](monitoring.md)

[back to index](index.md)

## Symfony

Read more [here](bundle/quick_tour.md) about using Enqueue as a Symfony Bundle.