From 203812621587a71c98f97730e67991b3653f6198 Mon Sep 17 00:00:00 2001
From: drebs <drebs@riseup.net>
Date: Fri, 6 Oct 2017 08:20:44 -0300
Subject: [doc] move compatibility notes from readme to documentation pages

---
 docs/development.rst               |  1 +
 docs/development/compatibility.rst | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+)
 create mode 100644 docs/development/compatibility.rst

(limited to 'docs')

diff --git a/docs/development.rst b/docs/development.rst
index a7ff15aa..78d75ad2 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -11,4 +11,5 @@ should help you get started with development for Soledad.
    development/deprecation
    development/tests
    development/benchmarks
+   development/compatibility
    changelog
diff --git a/docs/development/compatibility.rst b/docs/development/compatibility.rst
new file mode 100644
index 00000000..a44499c2
--- /dev/null
+++ b/docs/development/compatibility.rst
@@ -0,0 +1,20 @@
+Compatibility
+=============
+
+This page keeps notes about compatibility between different versions of Soledad
+and between Soledad and other components of the `LEAP Platform
+<https://leap.se/docs/platform>`_.
+
+* Upgrades of Soledad Server < 0.9.0 to >= 0.9.0 need database migration
+  because older code used to use CouchDB's design documents, while newer code
+  got rid of that because it made everything cpu and memory hungry. See `the
+  documentation
+  <http://soledad.readthedocs.io/en/latest/migrations.html#soledad-server-0-8-to-0-9-couch-database-schema-migration-needed>`_
+  for more information.
+
+* Soledad Server >= 0.7.0 is incompatible with client < 0.7.0 because of
+  modifications on encrypted document MAC calculation.
+
+* Soledad Server >= 0.7.0 is incompatible with LEAP Platform < 0.6.1 because
+  that platform version implements ephemeral tokens databases and Soledad
+  Server needs to act accordingly.
-- 
cgit v1.2.3