From 0a5e05e2701c3187036f520104056ed95f7e8516 Mon Sep 17 00:00:00 2001
From: Andrew Godwin
Date: Sun, 27 Nov 2022 14:04:43 -0700
Subject: Prepping release docs

---
 docs/releases/0.3.rst   | 23 +++++++++++++++++++++
 docs/releases/0.4.rst   | 54 +++++++++++++++++++++++++++++++++++++++++++++++++
 docs/releases/index.rst | 34 +++++++++++++++++++++++++++++++
 3 files changed, 111 insertions(+)
 create mode 100644 docs/releases/0.3.rst
 create mode 100644 docs/releases/0.4.rst
 create mode 100644 docs/releases/index.rst

(limited to 'docs/releases')

diff --git a/docs/releases/0.3.rst b/docs/releases/0.3.rst
new file mode 100644
index 0000000..519b43a
--- /dev/null
+++ b/docs/releases/0.3.rst
@@ -0,0 +1,23 @@
+0.3
+===
+
+*Released: 2022/11/24*
+
+This is the initial release of Takahē. It functions, but has limited features:
+
+* Web UI only (but can be installed as a PWA)
+* Creating posts, with CWs/summaries and visibility
+* Receiving posts, with CWs/summaries, visibility, images
+* Receiving post edits and deletions
+* Creating and receiving boosts
+* Creating and receiving likes
+* Delivering mentions to those mentioned, and notifications for incoming mentions
+* Following and unfollowing
+* Receiving follows and unfollows
+* A home timeline, a local timeline, and a federated timeline
+* Profile pages with bios, icons, and header images
+* Searching for users by exact handle
+* Multiple domain support
+* Multiple identity (per user account support)
+* Signup flow
+* Password reset flow
diff --git a/docs/releases/0.4.rst b/docs/releases/0.4.rst
new file mode 100644
index 0000000..f776125
--- /dev/null
+++ b/docs/releases/0.4.rst
@@ -0,0 +1,54 @@
+0.4
+===
+
+*Released: 2022/11/27*
+
+This release brings a whole set of new features during this alpha phase of
+the project:
+
+* Post editing
+* Post deletion
+* View replies under posts
+* Ability to post replies
+* Local-Only visibility for posts
+* Discoverability toggle for identities
+* Server defederation (blocking)
+* Revamped settings system with better validation
+* ARM64 Docker images (in addition to x64)
+
+In addition, bugfixes have been made to post creation, search, fanout, and more.
+
+
+Upgrade Notes
+-------------
+
+Settings
+~~~~~~~~
+
+The settings system has changed, and affected some of our environment variable
+names.
+
+* ``PGHOST``, ``PGUSER`` and similar are still supported, but a new
+  ``TAKAHE_DATABASE_SERVER`` env var is now the recommended way to
+  configure - it takes a URI/DSN.
+
+* ``TAKAHE_EMAIL_HOST`` and ``TAKAHE_SENDGRID_API_KEY`` have been removed, and
+  replaced with ``TAKAHE_EMAIL_SERVER``, that takes ``smtp://`` or ``sendgrid://`` URIs.
+
+* ``TAKAHE_MEDIA_BACKEND`` now expects a URI starting with ``s3://`` or ``gcs://``.
+
+You can see updated instructions of how to set all of these in :doc:`/installation`.
+
+
+Migrations
+~~~~~~~~~~
+
+There is one new database migration - it is backwards-compatible,
+so apply the migration *before* you update your webserver and stator deployments.
+
+
+Stator
+~~~~~~
+
+If you have low traffic, you may now run Stator via periodic fetch of a URL
+rather than a continuous background process. See :doc:`/installation` for more.
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
new file mode 100644
index 0000000..b47361d
--- /dev/null
+++ b/docs/releases/index.rst
@@ -0,0 +1,34 @@
+Releases
+========
+
+Versions
+--------
+
+.. toctree::
+   :maxdepth: 1
+
+   0.4
+   0.3
+
+
+Versioning Policy
+-----------------
+
+Takahē approximately follows Semantic Versioning, with some specific
+clarifications about what each upgrade means to you as a server administrator:
+
+* **Patch** releases are bugfixes or small feature improvements that do not
+  require a database migration. It is safe to run patch versions from the same
+  minor series at the same time during an upgrade.
+
+* **Minor** releases are larger feature improvements or other changes that
+  require a database migration. Unless otherwise noted, these will be
+  backwards-compatible migrations that can be applied to the database while the
+  previous version is still running, before the running code is updated.
+
+* **Major** releases may have major breaking changes that require significant
+  upgrade time to perform, and will likely incur downtime. The exception will
+  be our 1.0 release, which will be treated as a minor release, continuing
+  on from the 0.x release series.
+
+All release and upgrade notes can be found here, in the documentation.
-- 
cgit v1.2.3