From f89a3a02f74eb88a99e9dee068cc988e092cbe01 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 23 Mar 2022 11:14:10 +0000 Subject: [PATCH 1/4] Improve SyTest contrib docs --- docs/development/contributing_guide.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 071202e1965f..195b4d5b84af 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -254,8 +254,14 @@ configuration: ```sh $ docker run --rm -it -v /path/where/you/have/cloned/the/repository\:/src:ro -v /path/to/where/you/want/logs\:/logs matrixdotorg/sytest-synapse:buster ``` +(Note that the paths must be full paths! You could also write `$(realpath relative/path)` if needed.) -This configuration should generally cover your needs. For more details about other configurations, see [documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). +This configuration should generally cover your needs. + +- To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags. +- To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags). + +For more details about other configurations, see [documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). ## Run the integration tests ([Complement](https://github.com/matrix-org/complement)). From cd8b0b07da3df08ef8e612a78542f3c63916b524 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 23 Mar 2022 11:16:25 +0000 Subject: [PATCH 2/4] Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) --- changelog.d/12271.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/12271.doc diff --git a/changelog.d/12271.doc b/changelog.d/12271.doc new file mode 100644 index 000000000000..ecd59ec54065 --- /dev/null +++ b/changelog.d/12271.doc @@ -0,0 +1 @@ +Flesh out documentation for running SyTest against Synapse, including use of Postgres and worker mode. \ No newline at end of file From 625fe52d5a0ea184c28f7692bdec6135867ed4e6 Mon Sep 17 00:00:00 2001 From: "Olivier Wilkinson (reivilibre)" Date: Wed, 23 Mar 2022 11:34:30 +0000 Subject: [PATCH 3/4] Bring attention to the fact that the link is not just the bog standard README --- docs/development/contributing_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 195b4d5b84af..afa8766f8d49 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -261,7 +261,7 @@ This configuration should generally cover your needs. - To run with Postgres, supply the `-e POSTGRES=1 -e MULTI_POSTGRES=1` environment flags. - To run with Synapse in worker mode, supply the `-e WORKERS=1 -e REDIS=1` environment flags (in addition to the Postgres flags). -For more details about other configurations, see [documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). +For more details about other configurations, see the [Docker-specific documentation in the SyTest repo](https://github.com/matrix-org/sytest/blob/develop/docker/README.md). ## Run the integration tests ([Complement](https://github.com/matrix-org/complement)). From dc9de1f43403f22815eb41cb281271146466413e Mon Sep 17 00:00:00 2001 From: reivilibre Date: Wed, 30 Mar 2022 13:25:14 +0100 Subject: [PATCH 4/4] Update changelog.d/12271.doc Co-authored-by: Patrick Cloke --- changelog.d/12271.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/12271.doc b/changelog.d/12271.doc index ecd59ec54065..d9696fc5d5fa 100644 --- a/changelog.d/12271.doc +++ b/changelog.d/12271.doc @@ -1 +1 @@ -Flesh out documentation for running SyTest against Synapse, including use of Postgres and worker mode. \ No newline at end of file +Clarify documentation for running SyTest against Synapse, including use of Postgres and worker mode. \ No newline at end of file