From 77800e4117bb26133dc6ce1e5ebf3da9f4c672f5 Mon Sep 17 00:00:00 2001 From: Jordan Bancino Date: Wed, 8 Nov 2023 14:30:45 -0500 Subject: [PATCH] Housekeeping tasks with documentation and versioning. --- README.md | 23 +++++++++++----------- configure | 2 +- docs/CHANGELOG.md | 40 +++++++++++++++++++++++++------------- src/Routes/RouteVersions.c | 7 ++++++- 4 files changed, 44 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index f8efe63..003b8c7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -

-

Telodendria

+

Telodendria

Telodendria is an extremely powerful, yet lightweight and portable chat server designed to be easy to install and configure. Powered by @@ -12,7 +11,7 @@ hosting a complicated, high-maintenance homeserver or joining an existing homeserver for privacy or other reasons, then Telodendria might be for you. -> **Note:** Telodendria still in development. See [Status](#status). +!!!! **Note:** Telodendria still in development. See **Status** below. ## What is Matrix? @@ -64,12 +63,13 @@ incredibly outdated. Telodendria, on the other hand, aims to be stable. It should *just work* for long periods of time between upgrades, and you should never feel like Telodendria is going to change significantly between upgrades. +- **Well-Documented:** Telodendria places as much emphasis on documentation as on code, which means you can be sure that the documentation will always remain up-to-date, accurate, and most importantly, reasonably exhaustive. -[Read Technical Rationale →](docs/dev/rationale.md) +[Read Technical Rationale →](https://git.telodendria.io/Telodendria/Telodendria/src/branch/master/docs/dev/rationale.md) ## Get Started -Check out the [Documentation](docs/README.md) to get started with +Check out the [Documentation](https://git.telodendria.io/Telodendria/telodendria/src/branch/master/docs/README.md) to get started with Telodendria. ## Status @@ -79,13 +79,13 @@ not yet deliver on all of its promises. Currently, Telodendria is not ready for end-users yet. While it features very basic user authentication, it does not actually work as a chat server yet. -We are hoping to ship Telodendria `v0.4.0` by May of 2024. This +We are hoping to ship Telodendria `v1.7.0-alpha4` by May of 2024. This release should be usable for communication between **local users** only. Additional features, including federation with other Matrix homeservers will be added in future releases. -You can help speed up development by [sponsoring](#sponsorship) -Telodendria or [getting involved](docs/CONTRIBUTING.md). +You can help speed up development by **sponsoring** +Telodendria or [getting involved](https://git.telodendria.io/Telodendria/Telodendria/src/branch/master/docs/CONTRIBUTING.md). ## Sponsorship @@ -96,7 +96,7 @@ Telodendria's long-term success, please consider sponsoring the project. You can make a recurring donation to Telodendria using -[LiberaPay](https://bancino.net/Telodendria/donate). You can also make +[LiberaPay](https://liberapay.com/Telodendria/donate). You can also make one-time donations using [Stripe](https://donate.stripe.com/8wM29AfF5bRJc48eUU). If you would like to make a recurring donation larger than that allowed by @@ -108,7 +108,7 @@ LiberaPay, please contact Jordan Bancino over Matrix at While there are no set sponsorship tiers at this time, sponsoring Telodendria is a mutually beneficial relationship. Depending on the amount you donate, you can get your name, logo, and website links -on the [Sponsors](docs/SPONSORS.md) page, the project `README`, or the +on the [Sponsors](../sponsors) page, the project `README`, or the main website. ## License @@ -116,7 +116,7 @@ main website. All of the code and documentation for Telodendria is licensed under a modified MIT license. The MIT license is an extremely permissive license that has very few restrictions. Please consult the -[`LICENSE.txt`](LICENSE.txt) file for the actual license text. It is +[`LICENSE.txt`](https://git.telodendria.io/Telodendria/Telodendria/src/branch/master/LICENSE.txt) file for the actual license text. It is important to note that the Telodendria license text differs from the original MIT license in the following ways: @@ -133,4 +133,3 @@ to use the logo in any way as long as it represents or links to the official project. If Telodendria is forked, the logo must be removed completely from the project, and optionally replaced by a different one. - diff --git a/configure b/configure index 966eaf9..70e0aad 100755 --- a/configure +++ b/configure @@ -19,7 +19,7 @@ LIBS="-lm -pthread -lCytoplasm" # Set default args for all platforms -SCRIPT_ARGS="--cc=cc --prefix=/usr/local --enable-ld-extra --bin-name=telodendria --version=0.4.0 --static $@" +SCRIPT_ARGS="--cc=cc --prefix=/usr/local --enable-ld-extra --bin-name=telodendria --version=1.7.0-alpha4 --static $@" echo "Processing options..." echo "Ran with arguments: $SCRIPT_ARGS" diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6e8015c..004aad1 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -5,12 +5,22 @@ It is intended to be updated with every commit that makes a user-facing change w reporting in the change log. As such, it changes frequently between releases. Final change log entries are published as [Releases](releases). -## v0.4.0 +## v1.7.0-alpha4 **Not Released Yet.** -This release brings filters, rooms, and events! The core of the Matrix protocol architecture -is not in place. +This release brings filters, rooms, and events! The core of the Matrix +protocol architecture is now in place. + +Note that the versioning scheme has changed from `v0.X.0` to +`v1.7.0-alphaX`. This is so that Telodendria releases correspond to the +Matrix specification that they implement, in accordance with +[this blog post](https://telodendria.io/blog/on-matrixs-release-cadence-and-state-resolution-v1). +This versioning scheme change does not indicate a drastic leap forward +in Telodendria's development—the `-alpha4` suffix indicates that +this is the 4th pre-release, with the target being a stable `v1.7.0`. +Note also that we still have a *long* way to go before we reach that +stable release. ### Matrix Specification @@ -21,21 +31,23 @@ The following endpoints were added: ### Bug Fixes & General Improvements -- Fixed a double-free in `RouteUserProfile()` that would cause errors with certain -Matrix clients. (#35) +- Fixed a double-free in `RouteUserProfile()` that would cause errors +with certain Matrix clients. (#35) - Improved compatibility with NetBSD on various platforms. -- Moved [Cytoplasm](/Telodendria/Cytoplasm) to its own repository. -- Use a `configure` script and `make` to build Telodendria instead of custom scripts. +- Moved [Cytoplasm](/Telodendria/Cytoplasm) to its own repository. It +will now be maintained separately and have its own releases as well. +- Use a `configure` script and `make` to build Telodendria instead of +custom scripts. ### New Features -- Implemented `/_telodendria/admin/v1/deactivate/[localpart]` for admins to be able to -deactivate users. -- Added a **PUT** option to `/_telodendria/admin/v1/config` that gives the ability to change -only a subset of the configuration. -- Moved all administrator API endpoints to `/_telodendria/admin/v1`, because later revisions -of the administrator API may break clients, so we want a way to give those breaking revisions -new endpoints. +- Moved all administrator API endpoints to `/_telodendria/admin/v1`, +because later revisions of the administrator API may break clients, so +we want a way to give those breaking revisions new endpoints. +- Implemented `/_telodendria/admin/v1/deactivate/[localpart]` for admins +to be able to deactivate users. +- Added a **PUT** option to `/_telodendria/admin/v1/config` that gives +the ability to change only a subset of the configuration. ## v0.3.0 diff --git a/src/Routes/RouteVersions.c b/src/Routes/RouteVersions.c index c75321d..d4ff0a8 100644 --- a/src/Routes/RouteVersions.c +++ b/src/Routes/RouteVersions.c @@ -35,7 +35,12 @@ ROUTE_IMPL(RouteVersions, path, argp) (void) path; (void) argp; - ArrayAdd(versions, JsonValueString("v1.6")); +#define DECLARE_SPEC_VERSION(x) ArrayAdd(versions, JsonValueString(x)) + + DECLARE_SPEC_VERSION("v1.7"); + /* Declare additional spec version support here. */ + +#undef DECLARE_SPEC_VERSION HashMapSet(response, "versions", JsonValueArray(versions)); return response;