diff --git a/book/introduction.md b/book/introduction.md index df2fbddf..e03e4e9e 100644 --- a/book/introduction.md +++ b/book/introduction.md @@ -21,6 +21,30 @@ If you'd like to engage in or observe any of those things, please join! [room]: https://matrix.to/#/#grapevine:computer.surgery +## Can I use it? + +Theoretically yes, but it's not ready for general use yet, because: + +* [There aren't any releases][releases-issue]. +* [There isn't very much user-facing documentation][docs-issue]. +* There have been several additions and breaking changes to the configuration + file format that haven't been documented in detail. This means you'll need to + read the source code to figure out what all the options are and what they do. + +If these issues don't scare you away, go for it! (And if you use NixOS, [here's +an example][nixos-example].) + +[docs-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/21 +[releases-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/18 +[nixos-example]: https://gitlab.computer.surgery/charles/servy-fleet/-/blob/main/config/grapevine/default.nix + +## Expectations management + +This project is run and maintained entirely by volunteers who are doing their +best. Additionally, due to our goals, the development of new features may be +slower than alternatives. We find this to be an acceptable tradeoff considering +the importance of the reliability of a project like this. + ## Goals Our goal is to provide a robust and reliable Matrix homeserver implementation. @@ -81,32 +105,6 @@ We require at least 1 approving code review from a maintainer[^2] before changes can be merged. This number may increase in the future as the list of maintainers grows. -## Expectations management - -This project is run and maintained entirely by volunteers who are doing their -best. Additionally, due to our goals, the development of new features may be -slower than alternatives. We find this to be an acceptable tradeoff considering -the importance of the reliability of a project like this. - -## Can I use it? - -Theoretically yes, but it's not ready for general use yet, because: - -* [There aren't any releases][releases-issue]. -* [There isn't very much user-facing documentation][docs-issue]. -* There have been several additions and breaking changes to the configuration - file format that haven't been documented in detail. This means you'll need to - read the source code to figure out what all the options are and what they do. - -If these issues don't scare you away, go for it! (And if you use NixOS, [here's -an example][nixos-example].) - -[docs-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/21 -[releases-issue]: https://gitlab.computer.surgery/matrix/grapevine/-/issues/18 -[nixos-example]: https://gitlab.computer.surgery/charles/servy-fleet/-/blob/main/config/grapevine/default.nix - ---- - [^1]: A "maintainer" is someone who has the ability to close issues opened by someone else and merge changes. [^2]: A maintainer approving their own change doesn't count.