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

Commit e564bdd

Browse files
Add content to the Synapse documentation intro page (#10990)
Co-authored-by: Richard van der Hoff <[email protected]>
1 parent 4e51621 commit e564bdd

File tree

3 files changed

+76
-1
lines changed

3 files changed

+76
-1
lines changed

changelog.d/10990.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add additional content to the Welcome and Overview page of the documentation.

docs/development/contributing_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ TBD
6363

6464
# 5. Get in touch.
6565

66-
Join our developer community on Matrix: #synapse-dev:matrix.org !
66+
Join our developer community on Matrix: [#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org)!
6767

6868

6969
# 6. Pick an issue.

docs/welcome_and_overview.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,77 @@
33
Welcome to the documentation repository for Synapse, a
44
[Matrix](https://matrix.org) homeserver implementation developed by the matrix.org core
55
team.
6+
7+
## Installing and using Synapse
8+
9+
This documentation covers topics for **installation**, **configuration** and
10+
**maintainence** of your Synapse process:
11+
12+
* Learn how to [install](setup/installation.md) and
13+
[configure](usage/configuration/index.html) your own instance, perhaps with [Single
14+
Sign-On](usage/configuration/user_authentication/index.html).
15+
16+
* See how to [upgrade](upgrade.md) between Synapse versions.
17+
18+
* Administer your instance using the [Admin
19+
API](usage/administration/admin_api/index.html), installing [pluggable
20+
modules](modules/index.html), or by accessing the [manhole](manhole.md).
21+
22+
* Learn how to [read log lines](usage/administration/request_log.md), configure
23+
[logging](usage/configuration/logging_sample_config.md) or set up [structured
24+
logging](structured_logging.md).
25+
26+
* Scale Synapse through additional [worker processes](workers.md).
27+
28+
* Set up [monitoring and metrics](metrics-howto.md) to keep an eye on your
29+
Synapse instance's performance.
30+
31+
## Developing on Synapse
32+
33+
Contributions are welcome! Synapse is primarily written in
34+
[Python](https://python.org). As a developer, you may be interested in the
35+
following documentation:
36+
37+
* Read the [Contributing Guide](development/contributing_guide.md). It is meant
38+
to walk new contributors through the process of developing and submitting a
39+
change to the Synapse codebase (which is [hosted on
40+
GitHub](https://github.com/matrix-org/synapse)).
41+
42+
* Set up your [development
43+
environment](development/contributing_guide.md#2-what-do-i-need), then learn
44+
how to [lint](development/contributing_guide.md#run-the-linters) and
45+
[test](development/contributing_guide.md#8-test-test-test) your code.
46+
47+
* Look at [the issue tracker](https://github.com/matrix-org/synapse/issues) for
48+
bugs to fix or features to add. If you're new, it may be best to start with
49+
those labeled [good first
50+
issue](https://github.com/matrix-org/synapse/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
51+
52+
* Understand [how Synapse is
53+
built](development/internal_documentation/index.html), how to [migrate
54+
database schemas](development/database_schema.md), learn about
55+
[federation](federate.md) and how to [set up a local
56+
federation](federate.md#running-a-demo-federation-of-synapses) for development.
57+
58+
* We like to keep our `git` history clean. [Learn](development/git.md) how to
59+
do so!
60+
61+
* And finally, contribute to this documentation! The source for which is
62+
[located here](https://github.com/matrix-org/synapse/tree/develop/docs).
63+
64+
## Donating to Synapse development
65+
66+
Want to help keep Synapse going but don't know how to code? Synapse is a
67+
[Matrix.org Foundation](https://matrix.org) project. Consider becoming a
68+
supportor on [Liberapay](https://liberapay.com/matrixdotorg),
69+
[Patreon](https://patreon.com/matrixdotorg) or through
70+
[PayPal](https://paypal.me/matrixdotorg) via a one-time donation.
71+
72+
If you are an organisation or enterprise and would like to sponsor development,
73+
reach out to us over email at: support (at) matrix.org
74+
75+
## Reporting a security vulnerability
76+
77+
If you've found a security issue in Synapse or any other Matrix.org Foundation
78+
project, please report it to us in accordance with our [Security Disclosure
79+
Policy](https://www.matrix.org/security-disclosure-policy/). Thank you!

0 commit comments

Comments
 (0)