Skip to content
This repository was archived by the owner on Nov 25, 2024. It is now read-only.

Commit 95d93b3

Browse files
S7evinKS7evinK
committed
Update docs
1 parent 4cc68ef commit 95d93b3

32 files changed

+69
-3
lines changed

‎docs/FAQ.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ nav_order: 1
44
permalink: /faq
55
---
66

7+
{% include deprecation.html %}
8+
79
# FAQ
810

911
## Why does Dendrite exist?

‎docs/INSTALL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
{% include deprecation.html %}
3+
14
# Installation
25

36
Please note that new installation instructions can be found

‎docs/_includes/deprecation.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{: .warning-title }
2+
> This documentation is out of date!
3+
>
4+
> This documentation site is for the versions of Dendrite maintained by the <em>Matrix.org Foundation</em> (<a href="https://github.com/matrix-org/dendrite">github.com/matrix-org/dendrite</a>), available under the Apache 2.0 licence.
5+
>
6+
> If you are interested in the documentation for a later version of Dendrite, please refer to <a href="https://element-hq.github.io/dendrite/">https://element-hq.github.io/dendrite/</a>.

‎docs/_sass/custom/custom.scss

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎docs/administration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 4
55
permalink: /administration
66
---
77

8+
{% include deprecation.html %}
9+
810
# Administration
911

1012
This section contains documentation on managing your existing Dendrite deployment.

‎docs/administration/1_createusers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ permalink: /administration/createusers
55
nav_order: 1
66
---
77

8+
{% include deprecation.html %}
9+
810
# Creating user accounts
911

1012
User accounts can be created on a Dendrite instance in a number of ways.

‎docs/administration/2_registration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ permalink: /administration/registration
55
nav_order: 2
66
---
77

8+
{% include deprecation.html %}
9+
810
# Enabling registration
911

1012
Enabling registration allows users to register their own user accounts on your

‎docs/administration/3_presence.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ permalink: /administration/presence
55
nav_order: 3
66
---
77

8+
{% include deprecation.html %}
9+
810
# Enabling presence
911

1012
Dendrite supports presence, which allows you to send your online/offline status

‎docs/administration/4_adminapi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 4
55
permalink: /administration/adminapi
66
---
77

8+
{% include deprecation.html %}
9+
810
# Supported admin APIs
911

1012
Dendrite supports, at present, a very small number of endpoints that allow

‎docs/administration/5_optimisation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 5
66
permalink: /administration/optimisation
77
---
88

9+
{% include deprecation.html %}
10+
911
# Optimise your installation
1012

1113
Now that you have Dendrite running, the following tweaks will improve the reliability

‎docs/administration/6_troubleshooting.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 6
55
permalink: /administration/troubleshooting
66
---
77

8+
{% include deprecation.html %}
9+
810
# Troubleshooting
911

1012
If your Dendrite installation is acting strangely, there are a few things you should

‎docs/development.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ has_children: true
44
permalink: /development
55
---
66

7+
{% include deprecation.html %}
8+
9+
{% include deprecation.html %}
10+
711
# Development
812

913
This section contains documentation that may be useful when helping to develop

‎docs/development/CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 1
55
permalink: /development/contributing
66
---
77

8+
{% include deprecation.html %}
9+
810
# Contributing to Dendrite
911

1012
Everyone is welcome to contribute to Dendrite! We aim to make it as easy as

‎docs/development/PROFILING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 4
55
permalink: /development/profiling
66
---
77

8+
{% include deprecation.html %}
9+
810
# Profiling Dendrite
911

1012
If you are running into problems with Dendrite using excessive resources (e.g. CPU or RAM) then you can use the profiler to work out what is happening.

‎docs/development/coverage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 3
55
permalink: /development/coverage
66
---
77

8+
{% include deprecation.html %}
9+
810
## Running unit tests with coverage enabled
911

1012
Running unit tests with coverage enabled can be done with the following commands, this will generate a `integrationcover.log`

‎docs/development/sytest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 2
55
permalink: /development/sytest
66
---
77

8+
{% include deprecation.html %}
9+
810
# SyTest
911

1012
Dendrite uses [SyTest](https://github.com/matrix-org/sytest) for its

‎docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ layout: home
33
nav_exclude: true
44
---
55

6+
{% include deprecation.html %}
7+
68
# Dendrite
79

810
Dendrite is a second-generation Matrix homeserver written in Go! Following the microservice

‎docs/installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 2
55
permalink: /installation
66
---
77

8+
{% include deprecation.html %}
9+
810
# Installation
911

1012
This section contains documentation on installing a new Dendrite deployment.

‎docs/installation/1_planning.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 1
55
permalink: /installation/planning
66
---
77

8+
{% include deprecation.html %}
9+
810
# Planning your installation
911

1012
## Database

‎docs/installation/2_domainname.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 2
55
permalink: /installation/domainname
66
---
77

8+
{% include deprecation.html %}
9+
810
# Setting up the domain
911

1012
Every Matrix server deployment requires a server name which uniquely identifies it. For

‎docs/installation/docker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 4
66
permalink: /docker
77
---
88

9+
{% include deprecation.html %}
10+
911
# Installation using Docker
1012

1113
This section contains documentation how to install Dendrite using Docker

‎docs/installation/docker/1_docker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ nav_order: 1
77
permalink: /installation/docker/install
88
---
99

10+
{% include deprecation.html %}
11+
1012
# Installing Dendrite using Docker Compose
1113

1214
Dendrite provides an [example](https://github.com/matrix-org/dendrite/blob/main/build/docker/docker-compose.yml)

‎docs/installation/helm.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 3
66
permalink: /helm
77
---
88

9+
{% include deprecation.html %}
10+
911
# Helm
1012

1113
This section contains documentation how to use [Helm](https://helm.sh/) to install Dendrite on a [Kubernetes](https://kubernetes.io/) cluster.

‎docs/installation/helm/1_helm.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ nav_order: 1
77
permalink: /installation/helm/install
88
---
99

10+
{% include deprecation.html %}
11+
1012
# Installing Dendrite using Helm
1113

1214
To install Dendrite using the Helm chart, you first have to add the repository using the following commands:

‎docs/installation/manual.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 5
66
permalink: /manual
77
---
88

9+
{% include deprecation.html %}
10+
911
# Manual Installation
1012

1113
This section contains documentation how to manually install Dendrite

‎docs/installation/manual/1_build.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ nav_order: 1
77
permalink: /installation/manual/build
88
---
99

10+
{% include deprecation.html %}
11+
1012
# Build all Dendrite commands
1113

1214
Dendrite has numerous utility commands in addition to the actual server binaries.

‎docs/installation/manual/2_database.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ grand_parent: Installation
77
permalink: /installation/manual/database
88
---
99

10+
{% include deprecation.html %}
11+
1012
# Preparing database storage
1113

1214
Dendrite uses SQL databases to store data. Depending on the database engine being used, you

‎docs/installation/manual/3_signingkey.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 3
66
permalink: /installation/manual/signingkeys
77
---
88

9+
{% include deprecation.html %}
10+
911
# Generating signing keys
1012

1113
All Matrix homeservers require a signing private key, which will be used to authenticate

‎docs/installation/manual/4_configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 4
66
permalink: /installation/manual/configuration
77
---
88

9+
{% include deprecation.html %}
10+
911
# Configuring Dendrite
1012

1113
A YAML configuration file is used to configure Dendrite. A sample configuration file is

‎docs/installation/manual/5_starting_dendrite.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ nav_order: 5
66
permalink: /installation/manual/start
77
---
88

9+
{% include deprecation.html %}
10+
911
# Starting Dendrite
1012

1113
Once you have completed all preparation and installation steps,

‎docs/other/p2p.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: P2P Matrix
33
nav_exclude: true
44
---
55

6+
{% include deprecation.html %}
7+
68
# P2P Matrix
79

810
These are the instructions for setting up P2P Dendrite, current as of May 2020. There's both Go stuff and JS stuff to do to set this up.

‎docs/other/peeking.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
nav_exclude: true
33
---
44

5+
{% include deprecation.html %}
6+
57
## Peeking
68

79
Local peeking is implemented as per [MSC2753](https://github.com/matrix-org/matrix-doc/pull/2753).

0 commit comments

Comments
 (0)