summary refs log tree commit diff
path: root/docs/development (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Create dependabot changelogs at release time (#15481)David Robertson2023-05-301-5/+7
| | | | | | | | | * Ditch dependabot changelog workflow * Summarise dependabot commits in release script * Changelog * Update scripts-dev/release.py
* Documentation improvements to contributing guide (#15667) (#15668)Grant McLean2023-05-261-5/+28
| | | | | | | | | Fix #15667 - Reiterate the importance of getting Rust installed and set up before attempting to install the Python dependencies. - Mention the importance of confirming that `poetry install` completed successfully and include a typical error that the user might see if it did not. - Expand on "Now edit homeserver.yaml" to give examples of things likely to need changing and to link to the relevant sections of the Synapse server documentation.
* Allow running Complement integration tests via podman (#15543)Andrew Morgan2023-05-051-0/+1
|
* Update development docs referencing outdated versions of sqlite we no longer ↵Shay2023-04-281-33/+1
| | | | support (#15498)
* Document how to run Synapse (#15022)Andy Balaam2023-02-081-0/+13
| | | | | | | | * Document how to run Synapse * Changelog for 15022 * Update docs/development/contributing_guide.md
* Allow enabling the asyncio reactor in complement (#14858)realtyem2023-02-011-0/+1
| | | Signed-off-by: Jason Little realtyem@gmail.com
* Merge branch 'master' into developH. Shay2023-01-311-0/+375
|\
| * Initial batch of notes on faster joins (#14677)David Robertson2023-01-301-0/+375
| | | | | | | | Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> Co-authored-by: Shay <hillerys@element.io>
* | Document how to handle Dependabot pull requests. (#14916)Patrick Cloke2023-01-251-0/+14
|/
* Require poetry>=1.3.2 (#14860)David Robertson2023-01-172-8/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Upgrade to new lockfile format Now requires poetry >= 1.2.2 to read and poetry >= 1.3.0 to write. Cheat sheet: ``` poetry --version poetry show > scratch/before pipx upgrade poetry poetry --version poetry show > scratch/after diff scratch{before,after} && echo "no change!" ``` * Use Poetry 1.3.2 when reading or writing lockfile * Remove unneeded(?) poetry dep for cibuildwheel * Update docs * Remove redundant call to setup-python * Remove outdated comments related to Poetry 1.x * Remove outdated docs line was fixed in #13082 * Minor improvements to poetry cheat sheet * Invoke setup-python-poetry with explicit version Not sure about this. It's hardcoding versions everywhere. * Changelog * Check the lockfile is version 2.0 Might one day incorporate other checks like #14742 * Typo fixes, thanks Sean Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Update link to towncrier in contribution guide (#14801)Dirk Klimpel2023-01-091-1/+1
| | | | | * Update link to towncrier in contribution guide * newsfile
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-051-5/+4
| | | | | | | | | | | | | | | | | * Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Add release note and update doc regarding ICU (#14712)Mathieu Velten2022-12-201-0/+2
| | | | | Fixes #14704. Signed-off-by: Mathieu Velten <mathieuv@matrix.org>
* Allow override for requesting specific worker types for Complement on ↵realtyem2022-11-081-0/+6
| | | | | | | | | | | | | | | | | | | | | | | command line. (#14324) * Expose getting SYNAPSE_WORKER_TYPES from external, allowing override of workers requested. * Add WORKER_TYPES variable option to complement.sh script that passes requested workers into start_for_complement.sh entrypoint. * Update docs to reflect this new ability. * Changelog * Don't rely on soft wrapping to format long strings Good idea dklimpel. Thanks for catching that. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Small nits just noticed in docs. * Fixup new line in docs. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
* Handle `gottestfmt` repository move (#14144)David Robertson2022-10-111-1/+1
|
* The changelog entry ending in a `.` or `!` is not optional (#14087)Andre Klärner2022-10-061-1/+1
|
* Add instruction for running unit tests in parallel (#13928)Ashish Kumar2022-09-281-0/+6
|
* Emphasize the right reasons to use `(room_id, event_id)` in a schema (#13915)Eric Eastwood2022-09-271-15/+16
| | | | | | | * Emphasize the right reasons to use (room_id, event_id) Follow-up to: - https://github.com/matrix-org/synapse/pull/13701 - https://github.com/matrix-org/synapse/pull/13771
* Document common fix of Poetry problems by removing egg-info (#13785)Eric Eastwood2022-09-151-0/+27
| | | | | `matrix_synapse.egg-info/` Mentioned at https://matrix.to/#/!vcyiEtMVHIhWXcJAfl:sw1v.org/$aKy_IjrKwb70aTVZWeW_6zt0k7OIZ1YkyZpkP9uiRaM?via=matrix.org&via=element.io&via=beeper.com and many other places.
* Add a stub Rust crate (#12595)Erik Johnston2022-09-061-1/+9
|
* Clarify `(room_id, event_id)` global uniqueness (#13701)Eric Eastwood2022-09-021-0/+24
| | | Summarized from @richvdh's reply at https://github.com/matrix-org/synapse/pull/13589#discussion_r961116999
* Update lock file for Poetry v1.2.0 (#13689)Erik Johnston2022-09-022-6/+5
|
* Use and recommend poetry 1.1.14, up from 1.1.12 (#13285)David Robertson2022-07-151-0/+25
|
* Inline URL preview documentation. (#13261)Patrick Cloke2022-07-121-62/+0
| | | Inline URL preview documentation near the implementation.
* Add info about configuration in the url preview docs (#13233)Shay2022-07-121-0/+1
| | | Cross-link doc pages for easier navigation.
* Add information on how the Synapse team does reviews. (#13132)Patrick Cloke2022-07-062-1/+45
|
* Add the ability to set the log level using the `SYNAPSE_TEST_LOG_LEVEL` ↵reivilibre2022-07-051-0/+4
| | | | environment when using `complement.sh`. (#13152)
* Add instructions for running Complement with `gotestfmt`-formatted output ↵reivilibre2022-06-161-0/+14
| | | | locally. (#13073)
* Merge the Complement testing Docker images into a single, multi-purpose ↵reivilibre2022-06-081-0/+5
| | | | | image. (#12881) Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* contributing_guide.md: fix link to DCORichard van der Hoff2022-05-241-2/+2
|
* Fix federation in demo scripts. (#12783)Patrick Cloke2022-05-181-4/+5
|
* Add documentation for cancellation of request processing (#12761)Sean Quah2022-05-181-0/+392
| | | | Signed-off-by: Sean Quah <seanq@matrix.org>
* Suggest using docker when testing against postgres (#12765)David Robertson2022-05-171-3/+28
| | | Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Fix docs on how to run specific Complement tests after recent ↵Eric Eastwood2022-05-091-2/+2
| | | | `complement.sh` change (#12664)
* Recommend poetry in docs (#12475)David Robertson2022-04-202-21/+264
| | | | | | | | | | | * Recommend poetry in docs - readme - contributor guide - upgrade notes - new dev cheat sheet for poetry Co-authored-by: Shay <hillerys@element.io> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Clarify that we mark as outliers because we don't have any state for them ↵Eric Eastwood2022-04-061-1/+2
| | | | | (#12345) As discussed at https://github.com/matrix-org/synapse/pull/12179#discussion_r837263852
* Allow specifying the Postgres database's port when running unit tests with ↵reivilibre2022-04-051-3/+11
| | | | Postgres. (#12376)
* Remove `dockerfile-pgtests` (#12336)David Robertson2022-03-311-21/+0
|
* Flesh out documentation for running SyTest against Synapse, including use of ↵reivilibre2022-03-301-1/+7
| | | | | Postgres and worker mode. (#12271) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Note that contributors can sign off privately (#12204)Andrew Morgan2022-03-111-0/+11
| | | Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
* Updates to the Room DAG concepts development document (#12179)Richard van der Hoff2022-03-101-18/+53
| | | | Some stuff that came up while we were talking about #12173.
* Clean-up demo scripts & documentation (#12143)Patrick Cloke2022-03-081-0/+41
| | | | | | | | | * Rewrites the demo documentation to be clearer, accurate, and moves it to our documentation tree. * Improvements to the demo scripts: * `clean.sh` now runs `stop.sh` first to avoid zombie processes. * Uses more modern Synapse configuration (and removes some obsolete configuration). * Consistently use the HTTP ports for server name, etc. * Remove the `demo/etc` directory and place everything into the `demo/808x` directories.
* Move scripts directory inside synapse, exposing as setuptools entry_points ↵David Robertson2022-03-021-3/+3
| | | | | | | | | | | | (#12118) * Two scripts are basically entry_points already * Move and rename scripts/* to synapse/_scripts/*.py * Delete sync_room_to_group.pl * Expose entry points in setup.py * Update linter script and config * Fixup scripts & docs mentioning scripts that moved Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Basic documentation for the release cycle. (#11954)Patrick Cloke2022-02-101-0/+37
|
* Minor updates, and docs, for schema delta files (#11823)Richard van der Hoff2022-01-251-0/+54
| | | | | | | | | * Make functions in python deltas optional It's annoying to always have to write stubs for these. * Documentation for delta files * changelog
* Docs: add missing PR submission process how-tos (#11821)Forest Johnson2022-01-251-1/+2
| | | | | | | * Docs: add missing PR submission process how-tos The documentation says that in order to submit a pull request you have to run the linter and links to [Run the linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters). IMO "Run the linters" should explain that development dependencies are a pre-requisite. I also included `pip install wheel` which I had to run inside my virtual environment on ubuntu before I `pip install -e ".[all,dev]"` would succeed.
* Fix preview of imgur and Tenor URLs. (#11669)Philippe Daouadi2022-01-181-1/+6
| | | | | | By scraping Open Graph information from the HTML even when an autodiscovery endpoint is found. The results are then combined to capture as much information as possible from the page.
* Mention python3-venv and libpq-dev dependencies in contribution guide (#11740)Andy Balaam2022-01-131-1/+3
|
* Document the `SYNAPSE_TEST_PERSIST_SQLITE_DB` unit test env var (#11715)Andrew Morgan2022-01-101-0/+21
|
* Update backward extremity docs to make it clear that it does not indicate ↵Eric Eastwood2021-12-031-9/+7
| | | | | | | whether we have fetched an events' `prev_events` (#11469) Spawning from https://github.com/matrix-org/synapse/pull/9445#discussion_r758958181 Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Improve code formatting and fix a few typos in docs (#11221)Sumner Evans2021-11-013-6/+8
| | | | | | * Labeled a lot more code blocks with the appropriate type * Fixed a couple of minor typos (missing/extraneous commas) Signed-off-by: Sumner Evans <me@sumnerevans.com>
* Clarify lack of Windows support in documentation (#11198)Sean Quah2021-10-291-6/+5
|
* Include the requirements for [mypy,lint] in [dev] (#11034)reivilibre2021-10-111-1/+1
|
* Revert accidental push to develop.Olivier Wilkinson (reivilibre)2021-10-081-1/+1
|
* Update contributing guide to use [all,dev]Olivier Wilkinson (reivilibre)2021-10-081-1/+1
|
* Add content to the Synapse documentation intro page (#10990)Andrew Morgan2021-10-061-1/+1
| | | Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
* Updated development doc on samling environment for testing. (#10973)Max Kratz2021-10-061-6/+5
|
* Update postgresql testing script (#10906)David Robertson2021-09-241-0/+47
| | | | | | | | | | | | | | | | | | - Use sytest:bionic. Sytest:latest is two years old (do we want CI to push out latest at all?) and comes with Python 3.5, which we explictly no longer support. The script now runs under PostgreSQL 10 as a result. - Advertise script in the docs - Move pg testing script to scripts-dev directory - Write to host as the script's exector, not root A few changes to make it speedier to re-run the tests: - Create blank DB in the container, not the script, so we don't have to `initdb` each time - Use a named volume to persist the tox environment, so we don't have to fetch and install a bunch of packages from PyPI each time Co-authored-by: reivilibre <olivier@librepush.net>
* Add documentation for experimental feature flags. (#10865)Patrick Cloke2021-09-221-0/+37
|
* Refactor oEmbed previews (#10814)Patrick Cloke2021-09-211-8/+13
| | | | | | | | | | | | | The major change is moving the decision of whether to use oEmbed further up the call-stack. This reverts the _download_url method to being a "dumb" functionwhich takes a single URL and downloads it (as it was before #7920). This also makes more minor refactorings: * Renames internal variables for clarity. * Factors out shared code between the HTML and rich oEmbed previews. * Fixes tests to preview an oEmbed image.
* Use attrs internally for the URL preview code & add documentation. (#10753)Patrick Cloke2021-09-071-0/+51
|
* Advertise matrix-org.github.io/synapse docs (#10595)David Robertson2021-08-311-5/+425
| | | | | Point to the book where possible, and use hyperlinks to github to refer to files not included in the book. Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
* Add developer documentation to explain room DAG concepts like `outliers` and ↵Eric Eastwood2021-08-031-0/+79
| | | | `state_groups` (#10464)
* Move dev/ docs to development/ (#10453)Eric Eastwood2021-07-226-0/+253
|
* Notes on boolean columns in database schemas (#10164)Richard van der Hoff2021-06-111-0/+42
|
* Support for database schema version ranges (#9933)Richard van der Hoff2021-06-111-0/+95
| | | This is essentially an implementation of the proposal made at https://hackmd.io/@richvdh/BJYXQMQHO, though the details have ended up looking slightly different.
* Compile and render Synapse's docs into a browsable, mobile-friendly and ↵Andrew Morgan2021-06-032-0/+19
searchable website (#10086)
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-11-09 02:40:14 +0000