diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ca0598584..5a89e6841 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -97,7 +97,7 @@ To save waiting for CI to finish after every commit, it is ideal to run the checks locally before pushing, fixing errors first. This also saves other people time as only so many PRs can be tested at a given time. -To execute what Buildkite tests, first run `./build/scripts/build-test-lint.sh`; this +To execute what CI tests, first run `./build/scripts/build-test-lint.sh`; this script will build the code, lint it, and run `go test ./...` with race condition checking enabled. If something needs to be changed, fix it and then run the script again until it no longer complains. Be warned that the linting can take a diff --git a/docs/tracing/jaeger.png b/docs/tracing/jaeger.png deleted file mode 100644 index 8b1e61feb..000000000 Binary files a/docs/tracing/jaeger.png and /dev/null differ diff --git a/docs/tracing/setup.md b/docs/tracing/setup.md index 1f549af19..9e4fef7a3 100644 --- a/docs/tracing/setup.md +++ b/docs/tracing/setup.md @@ -1,13 +1,12 @@ --- title: Setup parent: Opentracing +grand_parent: Development permalink: /development/opentracing/setup --- ## OpenTracing Setup -![Trace when sending an event into a room](/docs/tracing/jaeger.png) - Dendrite uses [Jaeger](https://www.jaegertracing.io/) for tracing between microservices. Tracing shows the nesting of logical spans which provides visibility on how the microservices interact. This document explains how to set up Jaeger locally on a single machine.