From ca0735154fc53337778aaf1ef8c044c1dfaa7a81 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 14 Oct 2021 20:56:20 -0600 Subject: [PATCH 1/6] Remove false warning about copying the log config to a homeserver.yaml --- docs/usage/configuration/logging_sample_config.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/usage/configuration/logging_sample_config.md b/docs/usage/configuration/logging_sample_config.md index a673d487b85e..588c044fdece 100644 --- a/docs/usage/configuration/logging_sample_config.md +++ b/docs/usage/configuration/logging_sample_config.md @@ -4,11 +4,6 @@ Below is a sample logging configuration file. This file can be tweaked to contro homeserver will output logs. A restart of the server is generally required to apply any changes made to this file. -Note that the contents below are *not* intended to be copied and used as the basis for -a real homeserver.yaml. Instead, if you are starting from scratch, please generate -a fresh config using Synapse by following the instructions in -[Installation](../../setup/installation.md). - ```yaml {{#include ../../sample_log_config.yaml}} -``` \ No newline at end of file +``` From 6ed53a4299948cce26c54ec71f4589605120b4ee Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 14 Oct 2021 20:57:20 -0600 Subject: [PATCH 2/6] Create 11092.misc --- changelog.d/11092.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11092.misc diff --git a/changelog.d/11092.misc b/changelog.d/11092.misc new file mode 100644 index 000000000000..a46f5313f3c5 --- /dev/null +++ b/changelog.d/11092.misc @@ -0,0 +1 @@ +Fix documentation error regarding the copying of the sample log config. From e07e794d6bc8b66148fff5b992b85416059b0cfb Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Sun, 17 Oct 2021 22:51:13 -0600 Subject: [PATCH 3/6] Update docs/usage/configuration/logging_sample_config.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> --- docs/usage/configuration/logging_sample_config.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/usage/configuration/logging_sample_config.md b/docs/usage/configuration/logging_sample_config.md index 588c044fdece..e3eee6563660 100644 --- a/docs/usage/configuration/logging_sample_config.md +++ b/docs/usage/configuration/logging_sample_config.md @@ -2,7 +2,8 @@ Below is a sample logging configuration file. This file can be tweaked to control how your homeserver will output logs. A restart of the server is generally required to apply any -changes made to this file. +changes made to this file. The value of the `log_config` option in your homeserver +config should be the path to this file. ```yaml {{#include ../../sample_log_config.yaml}} From 3916c4f309fbdbf92d9248a4d68908266c16c667 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Sun, 17 Oct 2021 22:54:15 -0600 Subject: [PATCH 4/6] Update logging_sample_config.md --- docs/usage/configuration/logging_sample_config.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/usage/configuration/logging_sample_config.md b/docs/usage/configuration/logging_sample_config.md index e3eee6563660..499ab7cfe500 100644 --- a/docs/usage/configuration/logging_sample_config.md +++ b/docs/usage/configuration/logging_sample_config.md @@ -5,6 +5,10 @@ homeserver will output logs. A restart of the server is generally required to ap changes made to this file. The value of the `log_config` option in your homeserver config should be the path to this file. +Note that a default logging configuration (shown below) is created automatically alongside +the homeserver config when following the [installation instructions](../../setup/installation.md). +It should be named `.log.config` by default. + ```yaml {{#include ../../sample_log_config.yaml}} ``` From 7baec6e52021820fe9d8cac5c909a2a72812ced6 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 20 Oct 2021 12:17:41 +0100 Subject: [PATCH 5/6] Rename changelog: misc -> doc --- changelog.d/{11092.misc => 11092.doc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelog.d/{11092.misc => 11092.doc} (100%) diff --git a/changelog.d/11092.misc b/changelog.d/11092.doc similarity index 100% rename from changelog.d/11092.misc rename to changelog.d/11092.doc From c6707f4c6062e64645aeb1090e073da73e9b5a7a Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 20 Oct 2021 12:19:30 +0100 Subject: [PATCH 6/6] Reword changelog slightly --- changelog.d/11092.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/11092.doc b/changelog.d/11092.doc index a46f5313f3c5..916c2b3476b1 100644 --- a/changelog.d/11092.doc +++ b/changelog.d/11092.doc @@ -1 +1 @@ -Fix documentation error regarding the copying of the sample log config. +Clarify the the sample log config can be copied from the documentation without issue.