flake8
passed.
JSHint
passed.
Add Doc Converter to the sample docker-compose.yaml configurations.
Review Request #14199 — Created Oct. 11, 2024 and updated
This updates our existing sample docker compose config files to show how to
launch Review Board alongside an instance of Doc Converter, the document
conversion service needed for Power Pack's document review feature.The configs now have an instruction step for dealing with "optional services",
which are any services that we may include in the file but are optional. For
now RabbitMQ and Doc Converter are the only optional services, but in the
future we'll add Review Bot too.The instructions for the RabbitMQ service make it clear that it can be
used with multiple services, not just Doc Converter, and lists the
services that require it.
Tested this sample docker-compose and successfully ran the containers. Was
able to upload documents to the Review Board server and have them converted.
| Summary | ID |
|---|---|
| 8e20b47408de8731b1b925921eb926cd2f36d7b7 |
| Description | From | Last Updated |
|---|---|---|
|
This should say docker-compose.docconverter.yaml. Can we also move it below the plain mysql and postgres ones? |
 david
|
|
|
It'll still be a long line, but can we add a newline before "[document review]"? |
david
|
|
|
Can you move this down just above the BROKER_URL line, and indent to match? |
david
|
- Commits:
-
Summary ID d74fce01eec43fb8a9d45a65f58bcaa8b8e5c197 2cae4174ce8c6255390f762bb50b3238d9588865
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.
-
Thinking about this.. I think we should just move the services into the existing docker-compose files. We can have the documentation mention that these are optional services, explain what they're for. That way there's less for users to have to choose from when seeing the files ("Do I want MySQL, Postgres, or Doc Converter?"), less for us to maintain, and we help move to Doc Converter being a standard service.
I'd love to eventually do the same for Review Bot.
- Change Summary:
-
- Gets rid of the Doc Converter-specific config file, and instead adds Doc Converter to the existing config files.
- Moved this onto master instead of the 7.x branch.
- Summary:
-
Add a sample docker-compose.yaml for launching Review Board with Doc Converter.Add Doc Converter to the sample docker-compose.yaml configurations.
- Description:
-
~ This adds a sample docker compose config file that shows how to launch
~ Review Board alongside an instance of Doc Converter, the document ~ conversion service needed for Power Pack's document review feature. The ~ comments in the file also point to Power Pack's documentation for ~ instructions on other ways to set up the Doc Converter service. ~ This updates our existing sample docker compose config files to show how to
~ launch Review Board alongside an instance of Doc Converter, the document ~ conversion service needed for Power Pack's document review feature. ~ ~ The configs now have an instruction step for dealing with "optional services",
+ which are any services that we may include in the file but are optional. For + now RabbitMQ and Doc Converter are the only optional services, but in the + future we'll add Review Bot too. + + The instructions for the RabbitMQ service make it clear that it can be
+ used with multiple services, not just Doc Converter, and lists the + services that require it. - Commits:
-
Summary ID 2cae4174ce8c6255390f762bb50b3238d9588865 8e20b47408de8731b1b925921eb926cd2f36d7b7 - Branch:
-
release-7.xmaster
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.