Skip to content

Commit f6360d8

Browse files
committed
Added links to docs about Redis, Postgres, RabbitMQ
fedify-dev#479 (comment)
1 parent 0b40bf0 commit f6360d8

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/cli.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -234,13 +234,14 @@ different configurations before making a decision.
234234
> command yet.
235235
236236
> [!NOTE]
237-
> You need to install and run Redis server, PostgreSQL server, or RabbitMQ
238-
> server locally to test those integrations.
237+
> You need to install and run [Redis server], [PostgreSQL server], and AMQP
238+
> server (e.g., [RabbitMQ server])locally to test those integrations.
239239
240240

241241
The `fedify test-init` command is used to test the `fedify init` command.
242242
It creates a temporary Fedify project with various combinations of options and
243-
tests the server using `lookup` command. This command is for contributors who make integration with various frameworks.
243+
tests the server using `lookup` command. This command is for contributors who
244+
make integration with various frameworks.
244245

245246
~~~~ sh
246247
fedify test-init
@@ -264,12 +265,19 @@ If you do not specify some options, it will test all the available options for
264265
those. So the above command will test all combinations of key–value stores and
265266
message queues with Deno runtime and Hono web framework.
266267

267-
You can also specify several options in a single category. For example, the below command tests the `fedify init` command with both Redis and PostgreSQL as key–value stores:
268+
You can also specify several options in a single category. For example, the
269+
below command tests the `fedify init` command with both Redis and PostgreSQL as
270+
key–value stores:
268271

269272
~~~~ sh
270273
fedify test-init -k redis -k postgres
271274
~~~~
272275

276+
277+
[Redis server]: https://redis.io/docs/latest/operate/oss_and_stack/install/archive/install-redis/
278+
[PostgreSQL server]: https://www.postgresql.org/download/
279+
[RabbitMQ server]: https://www.rabbitmq.com/docs/download
280+
273281
### `-h`/`--hyd-run`: Create temporary project and `lookup` an object
274282

275283
If you want to test except `--dry-run` option, you can use the `-h`/`--hyd-run` option. This will create a temporary project and run the `lookup` command on it.

0 commit comments

Comments
 (0)