diff options
Diffstat (limited to 'develop/development')
| -rw-r--r-- | develop/development/cas.html | 4 | ||||
| -rw-r--r-- | develop/development/contributing_guide.html | 38 | ||||
| -rw-r--r-- | develop/development/database_schema.html | 4 | ||||
| -rw-r--r-- | develop/development/demo.html | 4 | ||||
| -rw-r--r-- | develop/development/dependencies.html | 8 | ||||
| -rw-r--r-- | develop/development/experimental_features.html | 4 | ||||
| -rw-r--r-- | develop/development/git.html | 10 | ||||
| -rw-r--r-- | develop/development/internal_documentation/index.html | 4 | ||||
| -rw-r--r-- | develop/development/releases.html | 4 | ||||
| -rw-r--r-- | develop/development/reviews.html | 4 | ||||
| -rw-r--r-- | develop/development/room-dag-concepts.html | 4 | ||||
| -rw-r--r-- | develop/development/saml.html | 4 | ||||
| -rw-r--r-- | develop/development/synapse_architecture/cancellation.html | 4 | ||||
| -rw-r--r-- | develop/development/synapse_architecture/faster_joins.html | 4 | ||||
| -rw-r--r-- | develop/development/synapse_architecture/streams.html | 10 |
15 files changed, 54 insertions, 56 deletions
diff --git a/develop/development/cas.html b/develop/development/cas.html index 09ffd57cf1..d2936b41e6 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/cas.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/cas.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index 6975222cb4..29eee06328 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/contributing_guide.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/contributing_guide.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> @@ -162,14 +162,15 @@ <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1> <p>This document aims to get you started with contributing to Synapse!</p> <h1 id="1-who-can-contribute-to-synapse"><a class="header" href="#1-who-can-contribute-to-synapse">1. Who can contribute to Synapse?</a></h1> -<p>Everyone is welcome to contribute code to <a href="https://github.com/matrix-org">matrix.org -projects</a>, provided that they are willing to +<p>Everyone is welcome to contribute code to <a href="https://github.com/element-hq/synapse">Synapse</a>, +provided that they are willing to license their contributions under the same license as the project itself. We 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 -<a href="https://github.com/matrix-org/synapse/blob/develop/LICENSE">LICENSE</a>).</p> +<a href="https://github.com/element-hq/synapse/blob/develop/LICENSE">LICENSE</a>).</p> +<p>TODO THIS NEEDS UPDATING</p> <h1 id="2-what-do-i-need"><a class="header" href="#2-what-do-i-need">2. What do I need?</a></h1> <p>If you are running Windows, the Windows Subsystem for Linux (WSL) is strongly recommended for development. More information about WSL can be found at @@ -222,8 +223,8 @@ cp docs/sample_log_config.yaml log_config.yaml <ul> <li>Set a <code>server_name</code></li> <li>Adjusting paths to be correct for your system like the <code>log_config</code> to point to the log config you just copied</li> -<li>Using a <a href="https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#database">PostgreSQL database instead of SQLite</a></li> -<li>Adding a <a href="https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration_shared_secret"><code>registration_shared_secret</code></a> so you can use <a href="https://matrix-org.github.io/synapse/latest/setup/installation.html#registering-a-user"><code>register_new_matrix_user</code> command</a>.</li> +<li>Using a <a href="https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#database">PostgreSQL database instead of SQLite</a></li> +<li>Adding a <a href="https://vector-im.github.io/synapse/latest/usage/configuration/config_documentation.html#registration_shared_secret"><code>registration_shared_secret</code></a> so you can use <a href="https://vector-im.github.io/synapse/latest/setup/installation.html#registering-a-user"><code>register_new_matrix_user</code> command</a>.</li> </ul> <p>And then run Synapse with the following command:</p> <pre><code class="language-sh">poetry run python -m synapse.app.homeserver -c homeserver.yaml @@ -236,19 +237,19 @@ resolve any issues and re-run until successful.</p> <h1 id="5-get-in-touch"><a class="header" href="#5-get-in-touch">5. Get in touch.</a></h1> <p>Join our developer community on Matrix: <a href="https://matrix.to/#/#synapse-dev:matrix.org">#synapse-dev:matrix.org</a>!</p> <h1 id="6-pick-an-issue"><a class="header" href="#6-pick-an-issue">6. Pick an issue.</a></h1> -<p>Fix your favorite problem or perhaps find a <a href="https://github.com/matrix-org/synapse/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22">Good First Issue</a> +<p>Fix your favorite problem or perhaps find a <a href="https://github.com/element-hq/synapse/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22">Good First Issue</a> to work on.</p> <h1 id="7-turn-coffee-into-code-and-documentation"><a class="header" href="#7-turn-coffee-into-code-and-documentation">7. Turn coffee into code and documentation!</a></h1> <p>There is a growing amount of documentation located in the -<a href="https://github.com/matrix-org/synapse/tree/develop/docs"><code>docs</code></a> -directory, with a rendered version <a href="https://matrix-org.github.io/synapse">available online</a>. +<a href="https://github.com/element-hq/synapse/tree/develop/docs"><code>docs</code></a> +directory, with a rendered version <a href="https://vector-im.github.io/synapse">available online</a>. This documentation is intended primarily for sysadmins running their own Synapse instance, as well as developers interacting externally with Synapse. -<a href="https://github.com/matrix-org/synapse/tree/develop/docs/development"><code>docs/development</code></a> +<a href="https://github.com/element-hq/synapse/tree/develop/docs/development"><code>docs/development</code></a> exists primarily to house documentation for Synapse developers. -<a href="https://github.com/matrix-org/synapse/tree/develop/docs/admin_api"><code>docs/admin_api</code></a> houses documentation +<a href="https://github.com/element-hq/synapse/tree/develop/docs/admin_api"><code>docs/admin_api</code></a> houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins and external service developers.</p> <p>Synapse's code style is documented <a href="../code_style.html">here</a>. Please follow @@ -256,12 +257,9 @@ it, including the conventions for <a href="../code_style.html#configuration-code options and documentation</a>.</p> <p>We welcome improvements and additions to our documentation itself! When writing new pages, please -<a href="https://github.com/matrix-org/synapse/tree/develop/docs#adding-to-the-documentation">build <code>docs</code> to a book</a> +<a href="https://github.com/element-hq/synapse/tree/develop/docs#adding-to-the-documentation">build <code>docs</code> to a book</a> to check that your contributions render correctly. The docs are written in <a href="https://guides.github.com/features/mastering-markdown/">GitHub-Flavoured Markdown</a>.</p> -<p>Some documentation also exists in <a href="https://github.com/matrix-org/synapse/wiki">Synapse's GitHub -Wiki</a>, although this is primarily -contributed to by community authors.</p> <p>When changes are made to any Rust code then you must call either <code>poetry install</code> or <code>maturin develop</code> (if installed) to rebuild the Rust code. Using <a href="https://github.com/PyO3/maturin"><code>maturin</code></a> is quicker than <code>poetry install</code>, so is recommended when making frequent @@ -376,7 +374,7 @@ configuration:</p> <li>To run with Postgres, supply the <code>-e POSTGRES=1 -e MULTI_POSTGRES=1</code> environment flags.</li> <li>To run with Synapse in worker mode, supply the <code>-e WORKERS=1 -e REDIS=1</code> environment flags (in addition to the Postgres flags).</li> </ul> -<p>For more details about other configurations, see the <a href="https://github.com/matrix-org/sytest/blob/develop/docker/README.md">Docker-specific documentation in the SyTest repo</a>.</p> +<p>For more details about other configurations, see the <a href="https://github.com/vector-im/sytest/blob/develop/docker/README.md">Docker-specific documentation in the SyTest repo</a>.</p> <h2 id="run-the-integration-tests-complement"><a class="header" href="#run-the-integration-tests-complement">Run the integration tests (<a href="https://github.com/matrix-org/complement">Complement</a>).</a></h2> <p><a href="https://github.com/matrix-org/complement">Complement</a> is a suite of black box tests that can be run on any homeserver implementation. It can also be thought of as end-to-end (e2e) tests.</p> <p>It's often nice to develop on Synapse and write Complement tests at the same time. @@ -398,7 +396,7 @@ Here is how to run your local Synapse checkout against your local Complement che <li>If setting <code>WORKERS=1</code>, optionally set <code>WORKER_TYPES=</code> to declare which worker types you wish to test. A simple comma-delimited string containing the worker types defined from the <code>WORKERS_CONFIG</code> template in -<a href="https://github.com/matrix-org/synapse/blob/develop/docker/configure_workers_and_start.py#L54">here</a>. +<a href="https://github.com/element-hq/synapse/blob/develop/docker/configure_workers_and_start.py#L54">here</a>. A safe example would be <code>WORKER_TYPES="federation_inbound, federation_sender, synchrotron"</code>. See the <a href="../workers.html">worker documentation</a> for additional information on workers.</li> </ul> @@ -452,7 +450,7 @@ in the format of <code>PRnumber.type</code>. The type can be one of the followin <li><code>removal</code> (also used for deprecations)</li> <li><code>misc</code> (for internal-only changes)</li> </ul> -<p>This file will become part of our <a href="https://github.com/matrix-org/synapse/blob/master/CHANGES.md">changelog</a> at the next +<p>This file will become part of our <a href="https://github.com/element-hq/synapse/blob/master/CHANGES.md">changelog</a> at the next release, so the content of the file should be a short description of your change in the same style as the rest of the changelog. The file can contain Markdown formatting, and must end with a full stop (.) or an exclamation mark (!) for @@ -480,7 +478,7 @@ chicken-and-egg problem.</p> add the changelog file to your branch, or:</p> </li> <li> -<p>Look at the <a href="https://github.com/matrix-org/synapse/issues?q=">list of all +<p>Look at the <a href="https://github.com/element-hq/synapse/issues?q=">list of all issues/PRs</a>, add one to the highest number you see, and quickly open the PR before somebody else claims your number.</p> diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index 62e9dc7257..f2f776ebee 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/database_schema.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/database_schema.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/demo.html b/develop/development/demo.html index 84d8e000a2..886f124ae2 100644 --- a/develop/development/demo.html +++ b/develop/development/demo.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/demo.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/demo.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/dependencies.html b/develop/development/dependencies.html index 69e1e0db38..03da814adc 100644 --- a/develop/development/dependencies.html +++ b/develop/development/dependencies.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/dependencies.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/dependencies.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> @@ -216,9 +216,9 @@ phonenumbers = [ ] </code></pre> <p>We can see this pinned version inside the docker image for that release:</p> -<pre><code>$ docker pull matrixdotorg/synapse:v1.57.0 +<pre><code>$ docker pull vectorim/synapse:v1.97.0 ... -$ docker run --entrypoint pip matrixdotorg/synapse:v1.57.0 show phonenumbers +$ docker run --entrypoint pip vectorim/synapse:v1.97.0 show phonenumbers Name: phonenumbers Version: 8.12.44 Summary: Python version of Google's common library for parsing, formatting, storing and validating international phone numbers. diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index 4df4971891..b46ea01a6d 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/experimental_features.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/experimental_features.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/git.html b/develop/development/git.html index 71ff726695..cd675a4207 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/git.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/git.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> @@ -168,10 +168,10 @@ before. Here, by way of an arbitrary example, is the top of <code>git log --grap <p>Note how the commit comment explains clearly what is changing and why. Also note the <em>absence</em> of merge commits, as well as the absence of commits called things like (to pick a few culprits): -<a href="https://github.com/matrix-org/synapse/commit/84691da6c">“pep8”</a>, <a href="https://github.com/matrix-org/synapse/commit/474810d9d">“fix broken +<a href="https://github.com/element.-hq/synapse/commit/84691da6c">“pep8”</a>, <a href="https://github.com/element.-hq/synapse/commit/474810d9d">“fix broken test”</a>, -<a href="https://github.com/matrix-org/synapse/commit/c9d72e457">“oops”</a>, -<a href="https://github.com/matrix-org/synapse/commit/836358823">“typo”</a>, or <a href="https://github.com/matrix-org/synapse/commit/707374d5d">“Who's +<a href="https://github.com/element.-hq/synapse/commit/c9d72e457">“oops”</a>, +<a href="https://github.com/element.-hq/synapse/commit/836358823">“typo”</a>, or <a href="https://github.com/element.-hq/synapse/commit/707374d5d">“Who's the president?”</a>.</p> <p>There are a number of reasons why keeping a clean commit history is a good thing:</p> diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index 23006410f1..e56a6a1682 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -124,10 +124,10 @@ <a href="../../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/internal_documentation/README.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/internal_documentation/README.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/releases.html b/develop/development/releases.html index 49f83004f2..db1472d3f6 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/releases.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/releases.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/reviews.html b/develop/development/reviews.html index fc6977e379..e78a45369c 100644 --- a/develop/development/reviews.html +++ b/develop/development/reviews.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/reviews.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/reviews.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index 17027019e2..93a6fcd4cb 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/room-dag-concepts.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/room-dag-concepts.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/saml.html b/develop/development/saml.html index b73c73415c..fe9405c747 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -124,10 +124,10 @@ <a href="../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/saml.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/saml.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/synapse_architecture/cancellation.html b/develop/development/synapse_architecture/cancellation.html index ed1a616917..5102faf456 100644 --- a/develop/development/synapse_architecture/cancellation.html +++ b/develop/development/synapse_architecture/cancellation.html @@ -124,10 +124,10 @@ <a href="../../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/synapse_architecture/cancellation.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/synapse_architecture/cancellation.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/synapse_architecture/faster_joins.html b/develop/development/synapse_architecture/faster_joins.html index 9948e4a1b8..ce7c0cb5af 100644 --- a/develop/development/synapse_architecture/faster_joins.html +++ b/develop/development/synapse_architecture/faster_joins.html @@ -124,10 +124,10 @@ <a href="../../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/synapse_architecture/faster_joins.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/synapse_architecture/faster_joins.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> diff --git a/develop/development/synapse_architecture/streams.html b/develop/development/synapse_architecture/streams.html index 46475698b5..485b50dbab 100644 --- a/develop/development/synapse_architecture/streams.html +++ b/develop/development/synapse_architecture/streams.html @@ -124,10 +124,10 @@ <a href="../../print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> - <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository"> + <a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository"> <i id="git-repository-button" class="fa fa-github"></i> </a> - <a href="https://github.com/matrix-org/synapse/edit/develop/docs/development/synapse_architecture/streams.md" title="Suggest an edit" aria-label="Suggest an edit"> + <a href="https://github.com/element-hq/synapse/edit/develop/docs/development/synapse_architecture/streams.md" title="Suggest an edit" aria-label="Suggest an edit"> <i id="git-edit-button" class="fa fa-edit"></i> </a> </div> @@ -160,7 +160,7 @@ </div> <h2 id="streams"><a class="header" href="#streams">Streams</a></h2> -<p>Synapse has a concept of "streams", which are roughly described in <a href="https://github.com/matrix-org/synapse/blob/develop/synapse/storage/util/id_generators.py"><code>id_generators.py</code></a>. +<p>Synapse has a concept of "streams", which are roughly described in <a href="https://github.com/element.-hq/synapse/blob/develop/synapse/storage/util/id_generators.py"><code>id_generators.py</code></a>. Generally speaking, streams are a series of notifications that something in Synapse's database has changed that the application might need to respond to. For example:</p> <ul> @@ -168,9 +168,9 @@ For example:</p> <li>The account data stream reports changes to users' <a href="https://spec.matrix.org/v1.7/client-server-api/#client-config">account data</a>.</li> <li>The to-device stream reports when a device has a new <a href="https://spec.matrix.org/v1.7/client-server-api/#send-to-device-messaging">to-device message</a>.</li> </ul> -<p>See <a href="https://github.com/matrix-org/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py"><code>synapse.replication.tcp.streams</code></a> for the full list of streams.</p> +<p>See <a href="https://github.com/element.-hq/synapse/blob/develop/synapse/replication/tcp/streams/__init__.py"><code>synapse.replication.tcp.streams</code></a> for the full list of streams.</p> <p>It is very helpful to understand the streams mechanism when working on any part of Synapse that needs to respond to changes—especially if those changes are made by different workers. -To that end, let's describe streams formally, paraphrasing from the docstring of <a href="https://github.com/matrix-org/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96"><code>AbstractStreamIdGenerator</code></a>.</p> +To that end, let's describe streams formally, paraphrasing from the docstring of <a href="https://github.com/element.-hq/synapse/blob/a719b703d9bd0dade2565ddcad0e2f3a7a9d4c37/synapse/storage/util/id_generators.py#L96"><code>AbstractStreamIdGenerator</code></a>.</p> <h3 id="definition"><a class="header" href="#definition">Definition</a></h3> <p>A stream is an append-only log <code>T1, T2, ..., Tn, ...</code> of facts<sup class="footnote-reference"><a href="#1">1</a></sup> which grows over time. Only "writers" can add facts to a stream, and there may be multiple writers.</p> |