diff options
author | Kento Okamoto <kentokamoto@protonmail.com> | 2022-12-12 08:46:37 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-12 16:46:37 +0000 |
commit | 76db8e90defdfb9e61f6caea8a312c5d60bcc005 (patch) | |
tree | 6b9e3b03b0c56fad85ee26992a4d5ccaf72d1506 | |
parent | 7d2344049d0780e92b071939addc41219ce94f5a (diff) |
Dendrite Documentation Fix (#2913)
### Pull Request Checklist
<!-- Please read
https://matrix-org.github.io/dendrite/development/contributing before
submitting your pull request -->
I was reading through the Dendrite documentation on
https://matrix-org.github.io/dendrite/development/contributing and
noticed the installation link leads to a 404 error. This link works fine
if it is viewed directly from
[docs/CONTRIBUTING.md](https://github.com/matrix-org/dendrite/blob/main/docs/CONTRIBUTING.md)
but this might not be very obvious to new contributors who are reading
through the [contribution
page](https://matrix-org.github.io/dendrite/development/contributing)
directly.
This PR is mainly a small re-organization of the online documentation
mainly in the
[Development](https://matrix-org.github.io/dendrite/development) tab
along with any links throughout the doc that may be impacted by the
change. This does not contain any Go unit tests as this does not
actually touch core dendrite functionality.
* [ ] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off below using a legally
identifiable
name](https://matrix-org.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately
Signed-off-by: `Kento Okamoto <kentokamoto@proton.me>`
-rw-r--r-- | docs/FAQ.md | 4 | ||||
-rw-r--r-- | docs/development/CONTRIBUTING.md (renamed from docs/CONTRIBUTING.md) | 6 | ||||
-rw-r--r-- | docs/development/PROFILING.md (renamed from docs/PROFILING.md) | 0 | ||||
-rw-r--r-- | docs/development/coverage.md (renamed from docs/coverage.md) | 0 | ||||
-rw-r--r-- | docs/development/sytest.md (renamed from docs/sytest.md) | 0 | ||||
-rw-r--r-- | docs/development/tracing/opentracing.md (renamed from docs/tracing/opentracing.md) | 0 | ||||
-rw-r--r-- | docs/development/tracing/setup.md (renamed from docs/tracing/setup.md) | 0 |
7 files changed, 5 insertions, 5 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md index ca72b151..81613051 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -91,7 +91,7 @@ Please use PostgreSQL wherever possible, especially if you are planning to run a ## Dendrite is using a lot of CPU Generally speaking, you should expect to see some CPU spikes, particularly if you are joining or participating in large rooms. However, constant/sustained high CPU usage is not expected - if you are experiencing that, please join `#dendrite-dev:matrix.org` and let us know what you were doing when the -CPU usage shot up, or file a GitHub issue. If you can take a [CPU profile](PROFILING.md) then that would +CPU usage shot up, or file a GitHub issue. If you can take a [CPU profile](development/PROFILING.md) then that would be a huge help too, as that will help us to understand where the CPU time is going. ## Dendrite is using a lot of RAM @@ -99,7 +99,7 @@ be a huge help too, as that will help us to understand where the CPU time is goi As above with CPU usage, some memory spikes are expected if Dendrite is doing particularly heavy work at a given instant. However, if it is using more RAM than you expect for a long time, that's probably not expected. Join `#dendrite-dev:matrix.org` and let us know what you were doing when the memory usage -ballooned, or file a GitHub issue if you can. If you can take a [memory profile](PROFILING.md) then that +ballooned, or file a GitHub issue if you can. If you can take a [memory profile](development/PROFILING.md) then that would be a huge help too, as that will help us to understand where the memory usage is happening. ## Dendrite is running out of PostgreSQL database connections diff --git a/docs/CONTRIBUTING.md b/docs/development/CONTRIBUTING.md index 21b0e7ab..2aec4c36 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/development/CONTRIBUTING.md @@ -9,7 +9,7 @@ permalink: /development/contributing Everyone is welcome to contribute to Dendrite! We aim to make it as easy as possible to get started. - ## Contribution types +## Contribution types We are a small team maintaining a large project. As a result, we cannot merge every feature, even if it is bug-free and useful, because we then commit to maintaining it indefinitely. We will always accept: @@ -57,7 +57,7 @@ to do so for future contributions. ## Getting up and running -See the [Installation](installation) section for information on how to build an +See the [Installation](../installation) section for information on how to build an instance of Dendrite. You will likely need this in order to test your changes. ## Code style @@ -151,7 +151,7 @@ significant amount of CPU and RAM. Once the code builds, run [Sytest](https://github.com/matrix-org/sytest) according to the guide in -[docs/sytest.md](https://github.com/matrix-org/dendrite/blob/main/docs/sytest.md#using-a-sytest-docker-image) +[docs/development/sytest.md](https://github.com/matrix-org/dendrite/blob/main/docs/development/sytest.md#using-a-sytest-docker-image) so you can see whether something is being broken and whether there are newly passing tests. diff --git a/docs/PROFILING.md b/docs/development/PROFILING.md index f3b57347..f3b57347 100644 --- a/docs/PROFILING.md +++ b/docs/development/PROFILING.md diff --git a/docs/coverage.md b/docs/development/coverage.md index 7a3b7cb9..7a3b7cb9 100644 --- a/docs/coverage.md +++ b/docs/development/coverage.md diff --git a/docs/sytest.md b/docs/development/sytest.md index 3cfb99e6..3cfb99e6 100644 --- a/docs/sytest.md +++ b/docs/development/sytest.md diff --git a/docs/tracing/opentracing.md b/docs/development/tracing/opentracing.md index 8528c2ba..8528c2ba 100644 --- a/docs/tracing/opentracing.md +++ b/docs/development/tracing/opentracing.md diff --git a/docs/tracing/setup.md b/docs/development/tracing/setup.md index 06f89bf8..06f89bf8 100644 --- a/docs/tracing/setup.md +++ b/docs/development/tracing/setup.md |