From 24d8c35592de2e310a6c9e15fce7f18dcddceea0 Mon Sep 17 00:00:00 2001 From: Azrenbeth Date: Fri, 27 Aug 2021 14:19:43 +0000 Subject: deploy: 54aa7047ebf0d2605e31bdd4933effc4eb63813b --- develop/print.html | 121 +++++++---------------------------------------------- 1 file changed, 14 insertions(+), 107 deletions(-) (limited to 'develop/print.html') diff --git a/develop/print.html b/develop/print.html index 5e78d64aa9..0df3aedb73 100644 --- a/develop/print.html +++ b/develop/print.html @@ -184,65 +184,6 @@

Welcome to the documentation repository for Synapse, the reference Matrix homeserver implementation.

Installation Instructions

-

There are 3 steps to follow under Installation Instructions.

-

Choosing your server name

It is important to choose the name for your server before you install Synapse, because it cannot be changed later.

@@ -11527,43 +11468,6 @@ small processing times.

Contributing

Welcome to Synapse

This document aims to get you started with contributing to this repo!

-

1. Who can contribute to Synapse?

Everyone is welcome to contribute code to matrix.org projects, provided that they are willing to @@ -11572,7 +11476,7 @@ follow a simple 'inbound=outbound' model for contributions: the act of submitting an 'inbound' contribution means that the contributor agrees to license the code under the same terms as the project's overall 'outbound' license - in our case, this is almost always Apache Software License v2 (see -LICENSE).

+LICENSE).

2. What do I need?

The code of Synapse is written in Python 3. To do pretty much anything, you'll need a recent version of Python 3.

The source code of Synapse is hosted on GitHub. You will also need a recent version of git.

@@ -11606,16 +11510,19 @@ pip install tox

Fix your favorite problem or perhaps find a Good First Issue to work on.

7. Turn coffee and documentation into code and documentation!

-

Synapse's code style is documented here. Please follow -it, including the conventions for the sample configuration -file.

-

There is a growing amount of documentation located in the docs +

Synapse's code style is documented +here. +Please follow it, including the conventions for the +sample configuration file.

+

There is a growing amount of documentation located in the +docs directory. This documentation is intended primarily for sysadmins running their -own Synapse instance, as well as developers interacting externally with -Synapse. docs/dev exists primarily to house documentation for -Synapse developers. docs/admin_api houses documentation -regarding Synapse's Admin API, which is used mostly by sysadmins and external -service developers.

+own Synapse instance, as well as developers interacting externally with Synapse. +docs/development +exists primarily to house documentation for Synapse developers. +docs/admin_api +houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins +and external service developers.

If you add new files added to either of these folders, please use GitHub-Flavoured Markdown.

Some documentation also exists in Synapse's GitHub @@ -11859,7 +11766,7 @@ flag to git commit, which uses the name and email set in your

By now, you know the drill!

Notes for maintainers on merging PRs etc

There are some notes for those with commit access to the project on how we -manage git here.

+manage git here.

Conclusion

That's it! Matrix is a very open and collaborative project as you might expect given our obsession with open communication. If we're going to successfully -- cgit 1.5.1