summary refs log tree commit diff
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-06-17 10:47:38 -0700
committerGitHub <noreply@github.com>2022-06-17 10:47:38 -0700
commit3d94d07db39bf29f9742c95e19b52b8ffcf6baa7 (patch)
treefb29c432bbd1f479b68fa1d2b393217f56183e66
parentFix inconsistencies in event validation (#13088) (diff)
downloadsynapse-3d94d07db39bf29f9742c95e19b52b8ffcf6baa7.tar.xz
Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076)
-rw-r--r--changelog.d/13076.doc1
-rw-r--r--docs/opentracing.md5
2 files changed, 4 insertions, 2 deletions
diff --git a/changelog.d/13076.doc b/changelog.d/13076.doc
new file mode 100644
index 0000000000..75dc4630ea
--- /dev/null
+++ b/changelog.d/13076.doc
@@ -0,0 +1 @@
+Update OpenTracing docs to reference the configuration manual rather than the configuration file.
diff --git a/docs/opentracing.md b/docs/opentracing.md
index f91362f112..abb94b565f 100644
--- a/docs/opentracing.md
+++ b/docs/opentracing.md
@@ -57,8 +57,9 @@ https://www.jaegertracing.io/docs/latest/getting-started.
 ## Enable OpenTracing in Synapse
 
 OpenTracing is not enabled by default. It must be enabled in the
-homeserver config by uncommenting the config options under `opentracing`
-as shown in the [sample config](./sample_config.yaml). For example:
+homeserver config by adding the `opentracing` option to your config file. You can find 
+documentation about how to do this in the [config manual under the header 'Opentracing'](usage/configuration/config_documentation.md#opentracing).
+See below for an example Opentracing configuration: 
 
 ```yaml
 opentracing: