From f141e6a5513128eee4f597427bc7b1e95596ab5d Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Thu, 22 Dec 2022 18:03:01 +0000 Subject: [PATCH] More docs for release prep --- docs/contributing.rst | 1 + docs/contributors.rst | 22 ++++++++++++++++++++++ docs/features.rst | 1 + docs/index.rst | 1 + docs/interoperability.rst | 6 +++--- docs/releases/0.6.rst | 29 ++++++++++++++++++++++++++--- 6 files changed, 54 insertions(+), 6 deletions(-) create mode 100644 docs/contributors.rst diff --git a/docs/contributing.rst b/docs/contributing.rst index 53b0df0..8b01b59 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -11,6 +11,7 @@ want to contribute we'd love help in the following areas: * Writing (for our development and user documentation) * Moderation (relayed advice and guidelines from those who have done it for Mastodon or others) * Compliance, Trust & Safety (professional advice and guidelines on what servers will require) +* Other ActivityPub Servers (to help debug federation issues) If you're interested in helping out, join `our Discord server `_ or email contact@jointakahe.org, and mention what you'd like to help with. diff --git a/docs/contributors.rst b/docs/contributors.rst new file mode 100644 index 0000000..f2ec196 --- /dev/null +++ b/docs/contributors.rst @@ -0,0 +1,22 @@ +Contributors +============ + +Takahē would not be where it is today without the efforts of its contributors. +If you're interested in becoming a contributor, see our :doc:`contributing` +page! + + +* Creator & Main Developer + + * `Andrew Godwin `_ + + +* Core Contributors + + * `Michael Manfre `_ + * `Tyler Kennedy (TkTech) `_ + + +* Other Contributors + + * Please see our `GitHub contributors list `_. diff --git a/docs/features.rst b/docs/features.rst index 960cfad..de01843 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -26,6 +26,7 @@ Currently, it supports: * Server defederation (blocking) * Signup flow * Password reset flow +* Invites system for restricting signups * Hashtag trending system with moderation * Mastodon-compatible client API for use with apps (alpha stage) diff --git a/docs/index.rst b/docs/index.rst index 7e90654..13129fb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,3 +23,4 @@ in alpha. For more information about Takahē, see stator tuning releases/index + contributors diff --git a/docs/interoperability.rst b/docs/interoperability.rst index af674cf..cbef665 100644 --- a/docs/interoperability.rst +++ b/docs/interoperability.rst @@ -41,7 +41,7 @@ needed: * Peertube * Pixelfed - * Replies may not federate? + * Replies may not federate? * Pleroma @@ -49,7 +49,7 @@ needed: These servers have the beginnings of support but known bugs that need fixing: * Gotosocial - * Issues pulling accounts + * Issues pulling accounts * Mitra - * Sends Follow Accept messages in a compact format we don't accept yet + * Sends Follow Accept messages in a compact format we don't accept yet diff --git a/docs/releases/0.6.rst b/docs/releases/0.6.rst index 288ea9f..20c96cf 100644 --- a/docs/releases/0.6.rst +++ b/docs/releases/0.6.rst @@ -6,12 +6,16 @@ This release focuses primarily on server completeness and stability, with an extra helping of moderation tools as well. -This is the first release we might *recommend you start a community on*. Bear in +This is the first release we *might* recommend you start a community on. Bear in mind that this is still beta software, and so not free of bugs, but we've now reached enough stability and moderation functionality that it's doable. We're also spooling up invites on `takahe.social `_ as part of our own push in this regard - see https://jointakahe.org/takahesocial/ for -more on that. +more information and how to get an invite. + +If you're curious on the reasons *not* to use Takahē yet, see what's left +to implement on our :doc:`features` page, and our federation and client +compatibility list on our :doc:`interoperability` page. Major features: @@ -36,7 +40,6 @@ Major features: * Separate moderation and admin user permission levels * Terms Of Service, Privacy Policy, and Server Rules page functionality - Additionally, we've made lots of bug fixes and other improvements, including: * Profile and post URLs now work in search @@ -46,6 +49,26 @@ Additionally, we've made lots of bug fixes and other improvements, including: * All uploaded images are now WebP for efficiency * Sessions use signed cookies for reduced database load +Our plan for the 0.7 release is not finalised, but likely includes: + +* Emoji admin page +* User-initiated identity deletion +* Server announcements system +* Initial video support + +I would also like to specifically thank `Michael Manfre `_ +and `Tyler Kennedy (TkTech) `_ for their help during the 0.6 +development cycle; it is people like them, who turn up and help with the boring +and unglamarous parts of development, who make Open Source work. + +We're looking for specific help from the following people as we develop further: + +* Visual Design - We'd like to have a proper design system and identity for Takahē +* Instance admins or developers of non-Mastodon servers - We need help debugging + federation issues, especially where we're causing errors we can't see elsewhere. + +If you'd like to help with these or other areas, see :doc:`contributing` to +see how to get in touch. You can download images from `Docker Hub `_, or use the image name ``jointakahe/takahe:0.6``.