aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQuentin Gliech <quenting@element.io>2024-10-17 17:34:12 +0200
committerQuentin Gliech <quenting@element.io>2024-10-17 17:34:12 +0200
commit891950f7b601ae5cf7da997f58957756da916614 (patch)
tree84b6532cba4348286bd6b6b7817e9173e803a7de /docs
parent6e6c3de0a6d93cd9e91234ce48e7968eb77e25e9 (diff)
Replace references to the repository
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ.md16
-rw-r--r--docs/_config.yml2
-rw-r--r--docs/development/CONTRIBUTING.md14
-rw-r--r--docs/development/sytest.md2
-rw-r--r--docs/installation/1_planning.md4
-rw-r--r--docs/installation/docker/1_docker.md4
-rw-r--r--docs/installation/helm/1_helm.md6
-rw-r--r--docs/installation/manual/4_configuration.md10
8 files changed, 29 insertions, 29 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 2ef9e6c2..a7ba979e 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -18,13 +18,13 @@ Mostly, although there are still bugs and missing features. If you are a confide
## Is Dendrite feature-complete?
-No, although a good portion of the Matrix specification has been implemented. Mostly missing are client features - see the [readme](https://github.com/matrix-org/dendrite/blob/main/README.md) at the root of the repository for more information.
+No, although a good portion of the Matrix specification has been implemented. Mostly missing are client features - see the [readme](https://github.com/element-hq/dendrite/blob/main/README.md) at the root of the repository for more information.
## Why doesn't Dendrite have "x" yet?
-Dendrite development is currently supported by a small team of developers and due to those limited resources, the majority of the effort is focused on getting Dendrite to be
-specification complete. If there are major features you're requesting (e.g. new administration endpoints), we'd like to strongly encourage you to join the community in supporting
-the development efforts through [contributing](./development/CONTRIBUTING.md).
+Dendrite development is currently supported by a small team of developers and due to those limited resources, the majority of the effort is focused on getting Dendrite to be
+specification complete. If there are major features you're requesting (e.g. new administration endpoints), we'd like to strongly encourage you to join the community in supporting
+the development efforts through [contributing](./development/CONTRIBUTING.md).
## Is there a migration path from Synapse to Dendrite?
@@ -37,7 +37,7 @@ No, Dendrite has a very different database schema to Synapse and the two are not
## Can I configure which port Dendrite listens on?
-Yes, use the cli flag `-http-bind-address`.
+Yes, use the cli flag `-http-bind-address`.
## I've installed Dendrite but federation isn't working
@@ -130,9 +130,9 @@ We don't officially support this or any other dedicated media storage solutions.
## Is there an upgrade guide for Dendrite?
-Run a newer docker image. We don't officially support deployments other than Docker.
-Most of the time you should be able to just
-- stop
+Run a newer docker image. We don't officially support deployments other than Docker.
+Most of the time you should be able to just
+- stop
- replace binary
- start
diff --git a/docs/_config.yml b/docs/_config.yml
index ed93fd79..7af68039 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -10,7 +10,7 @@ plugins:
- jekyll-feed
aux_links:
"GitHub":
- - "//github.com/matrix-org/dendrite"
+ - "//github.com/element-hq/dendrite"
aux_links_new_tab: true
sass:
sass_dir: _sass
diff --git a/docs/development/CONTRIBUTING.md b/docs/development/CONTRIBUTING.md
index caab1e74..0d6f533c 100644
--- a/docs/development/CONTRIBUTING.md
+++ b/docs/development/CONTRIBUTING.md
@@ -101,7 +101,7 @@ We also have unit tests which we run via:
DENDRITE_TEST_SKIP_NODB=1 go test --race ./...
```
-This only runs SQLite database tests. If you wish to execute Postgres tests as well, you'll either need to
+This only runs SQLite database tests. If you wish to execute Postgres tests as well, you'll either need to
have Postgres installed locally (`createdb` will be used) or have a remote/containerized Postgres instance
available.
@@ -119,7 +119,7 @@ code is functioning as intended is great, and to ensure that we will find out qu
in the future if any regressions happen.
We use the standard [Go testing package](https://gobyexample.com/testing) for this,
-alongside some helper functions in our own [`test` package](https://pkg.go.dev/github.com/matrix-org/dendrite/test).
+alongside some helper functions in our own [`test` package](https://pkg.go.dev/github.com/element-hq/dendrite/test).
## Continuous integration
@@ -131,7 +131,7 @@ test suites ([Complement](https://github.com/matrix-org/complement) and
[SyTest](https://github.com/matrix-org/sytest)).
You can see the progress of any CI jobs at the bottom of the Pull Request page, or by
-looking at the [Actions](https://github.com/matrix-org/dendrite/actions) tab of the Dendrite
+looking at the [Actions](https://github.com/element-hq/dendrite/actions) tab of the Dendrite
repository.
We generally won't accept a submission unless all of the CI jobs are passing. We
@@ -152,7 +152,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/development/sytest.md](https://github.com/matrix-org/dendrite/blob/main/docs/development/sytest.md#using-a-sytest-docker-image)
+[docs/development/sytest.md](https://github.com/element-hq/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.
@@ -162,17 +162,17 @@ tests.
## Picking things to do
If you're new then feel free to pick up an issue labelled [good first
-issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue).
+issue](https://github.com/element-hq/dendrite/labels/good%20first%20issue).
These should be well-contained, small pieces of work that can be picked up to
help you get familiar with the code base.
Once you're comfortable with hacking on Dendrite there are issues labelled as
-[help wanted](https://github.com/matrix-org/dendrite/labels/help-wanted),
+[help wanted](https://github.com/element-hq/dendrite/labels/help-wanted),
these are often slightly larger or more complicated pieces of work but are
hopefully nonetheless fairly well-contained.
We ask people who are familiar with Dendrite to leave the [good first
-issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue)
+issue](https://github.com/element-hq/dendrite/labels/good%20first%20issue)
issues so that there is always a way for new people to come and get involved.
## Getting help
diff --git a/docs/development/sytest.md b/docs/development/sytest.md
index 2f681f3e..7f2c27e6 100644
--- a/docs/development/sytest.md
+++ b/docs/development/sytest.md
@@ -28,7 +28,7 @@ go build -o bin/ ./cmd/...
```
If you are fixing an issue marked with
-[Are We Synapse Yet](https://github.com/matrix-org/dendrite/labels/are-we-synapse-yet)
+[Are We Synapse Yet](https://github.com/element-hq/dendrite/labels/are-we-synapse-yet)
then there will be a list of Sytests that you should add to the whitelist when you
have fixed that issue. This MUST be included in your PR to ensure that the issue
is fully resolved.
diff --git a/docs/installation/1_planning.md b/docs/installation/1_planning.md
index e113ca2d..3ae601ef 100644
--- a/docs/installation/1_planning.md
+++ b/docs/installation/1_planning.md
@@ -77,8 +77,8 @@ therefore does not need this to be manually installed.
A reverse proxy such as [Caddy](https://caddyserver.com), [NGINX](https://www.nginx.com) or
[HAProxy](http://www.haproxy.org) is useful for deployments. Configuring this is not covered in this documentation, although sample configurations
-for [Caddy](https://github.com/matrix-org/dendrite/blob/main/docs/caddy) and
-[NGINX](https://github.com/matrix-org/dendrite/blob/main/docs/nginx) are provided.
+for [Caddy](https://github.com/element-hq/dendrite/blob/main/docs/caddy) and
+[NGINX](https://github.com/element-hq/dendrite/blob/main/docs/nginx) are provided.
### Windows
diff --git a/docs/installation/docker/1_docker.md b/docs/installation/docker/1_docker.md
index f3399972..85de694f 100644
--- a/docs/installation/docker/1_docker.md
+++ b/docs/installation/docker/1_docker.md
@@ -9,7 +9,7 @@ permalink: /installation/docker/install
# Installing Dendrite using Docker Compose
-Dendrite provides an [example](https://github.com/matrix-org/dendrite/blob/main/build/docker/docker-compose.yml)
+Dendrite provides an [example](https://github.com/element-hq/dendrite/blob/main/build/docker/docker-compose.yml)
Docker compose file, which needs some preparation to start successfully.
Please note that this compose file only has Postgres as a dependency, and you need to configure
a [reverse proxy](../planning#reverse-proxy).
@@ -57,5 +57,5 @@ You can then change `config/dendrite.yaml` to your liking.
Once you're done changing the config, you can now start up Dendrite with
```bash
-docker-compose -f docker-compose.yml up
+docker-compose -f docker-compose.yml up
```
diff --git a/docs/installation/helm/1_helm.md b/docs/installation/helm/1_helm.md
index 00fe4fdc..57de4ca5 100644
--- a/docs/installation/helm/1_helm.md
+++ b/docs/installation/helm/1_helm.md
@@ -16,8 +16,8 @@ helm repo add dendrite https://matrix-org.github.io/dendrite/
helm repo update
```
-Next you'll need to create a `values.yaml` file and configure it to your liking. All possible values can be found
-[here](https://github.com/matrix-org/dendrite/blob/main/helm/dendrite/values.yaml), but at least you need to configure
+Next you'll need to create a `values.yaml` file and configure it to your liking. All possible values can be found
+[here](https://github.com/element-hq/dendrite/blob/main/helm/dendrite/values.yaml), but at least you need to configure
a `server_name`, otherwise the chart will complain about it:
```yaml
@@ -55,4 +55,4 @@ dendrite_config:
server_name: "localhost"
```
-Using this option, the `database.connection_string` will be set for you automatically. \ No newline at end of file
+Using this option, the `database.connection_string` will be set for you automatically.
diff --git a/docs/installation/manual/4_configuration.md b/docs/installation/manual/4_configuration.md
index 624cc415..23069799 100644
--- a/docs/installation/manual/4_configuration.md
+++ b/docs/installation/manual/4_configuration.md
@@ -11,7 +11,7 @@ permalink: /installation/manual/configuration
A YAML configuration file is used to configure Dendrite. A sample configuration file is
present in the top level of the Dendrite repository:
-* [`dendrite-sample.yaml`](https://github.com/matrix-org/dendrite/blob/main/dendrite-sample.yaml)
+* [`dendrite-sample.yaml`](https://github.com/element-hq/dendrite/blob/main/dendrite-sample.yaml)
You will need to duplicate the sample, calling it `dendrite.yaml` for example, and then
tailor it to your installation. At a minimum, you will need to populate the following
@@ -81,7 +81,7 @@ one address in the `addresses` field.
## Database connection using a global connection pool
-If you want to use a single connection pool to a single PostgreSQL database,
+If you want to use a single connection pool to a single PostgreSQL database,
then you must uncomment and configure the `database` section within the `global` section:
```yaml
@@ -103,9 +103,9 @@ these will override the `global` database configuration.
Dendrite supports full-text indexing using [Bleve](https://github.com/blevesearch/bleve). It is configured in the `sync_api` section as follows.
-Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing,
-to ensure the returned results match the expectations. A full list of possible languages
-can be found [here](https://github.com/matrix-org/dendrite/blob/5b73592f5a4dddf64184fcbe33f4c1835c656480/internal/fulltext/bleve.go#L25-L46).
+Depending on the language most likely to be used on the server, it might make sense to change the `language` used when indexing,
+to ensure the returned results match the expectations. A full list of possible languages
+can be found [here](https://github.com/element-hq/dendrite/blob/5b73592f5a4dddf64184fcbe33f4c1835c656480/internal/fulltext/bleve.go#L25-L46).
```yaml
sync_api: