From 9694b5424507c03a2494713354e8a20a2f8a8d43 Mon Sep 17 00:00:00 2001 From: drebs Date: Thu, 28 Sep 2017 16:53:40 -0300 Subject: [doc] remove unused pages --- docs/common.rst | 32 -------------------------------- docs/debian-repackaging.rst | 41 ----------------------------------------- docs/migrations.rst | 22 ---------------------- docs/misc.rst | 5 +++-- docs/misc/sync.rst | 35 +++++++++++++++++++++++++++++++++++ docs/sync.rst | 35 ----------------------------------- 6 files changed, 38 insertions(+), 132 deletions(-) delete mode 100644 docs/common.rst delete mode 100644 docs/debian-repackaging.rst delete mode 100644 docs/migrations.rst create mode 100644 docs/misc/sync.rst delete mode 100644 docs/sync.rst diff --git a/docs/common.rst b/docs/common.rst deleted file mode 100644 index f7a3dfa8..00000000 --- a/docs/common.rst +++ /dev/null @@ -1,32 +0,0 @@ -Soledad Common documentation -============================ - -.. automodule:: leap.soledad.common - :members: - :undoc-members: - :private-members: - :show-inheritance: - -.. automodule:: leap.soledad.common.couch - :members: - :undoc-members: - :private-members: - :show-inheritance: - -.. automodule:: leap.soledad.common.crypto - :members: - :undoc-members: - :private-members: - :show-inheritance: - -.. automodule:: leap.soledad.common.document - :members: - :undoc-members: - :private-members: - :show-inheritance: - -.. automodule:: leap.soledad.common.errors - :members: - :undoc-members: - :private-members: - :show-inheritance: diff --git a/docs/debian-repackaging.rst b/docs/debian-repackaging.rst deleted file mode 100644 index 888d6c03..00000000 --- a/docs/debian-repackaging.rst +++ /dev/null @@ -1,41 +0,0 @@ -repackaging howto -================= - -How to repackage latest code ----------------------------- - -Enter debian branch:: - - git checkout debian/experimental - -Merge your latest and greatest:: - - git merge develop - -Bump the changelog:: - - vim debian/changelog - -dch should also get you there, adding a new entry. - -Edit the changelog so you get a new version (this is the version -that apt will report). For example, change:: - - soledad-common (0.3.4) unstable; urgency=low - -to:: - - soledad-common (0.3.4-1~testing_frobnication) unstable; urgency=low - - -Last, but not least, freeze the debian version:: - - python setup.py freeze_debianver - -It might be a good idea to edit by hand the version string -under _version too, so it's clear that you're packaging some bleeding -edge not to be confused with latest stable packages. - -And now you can happily repackage for your own deploys:: - - debuild -us -uc diff --git a/docs/migrations.rst b/docs/migrations.rst deleted file mode 100644 index 3d221a9a..00000000 --- a/docs/migrations.rst +++ /dev/null @@ -1,22 +0,0 @@ -Migrations -========== - -Some updates of Soledad need manual intervention for database migration because -of changes to the storage backend. In all such cases, we will document the -steps needed for migration in this page. - -Soledad Server 0.8 to 0.9 - Couch Database schema migration needed ------------------------------------------------------------------- - -Starting with Soledad Server 0.9.0, the CouchDB database schema was changed to -improve speed of the server side storage backend. Because of that, this script -has to be run for all Leap providers that used to provide email using Soledad -Server < 0.9.0. - -The migration script can be found: - -* In `the Soledad repository `_. -* In ``/usr/share/soledad-server/migration/0.9/`` when the ``soledad-server`` debian package is installed. - -Instructions for migration can be found in the ``README.md`` file. Make sure to read it carefully and backup your data before starting the migration process. - diff --git a/docs/misc.rst b/docs/misc.rst index 97d9ad73..67f3ca3d 100644 --- a/docs/misc.rst +++ b/docs/misc.rst @@ -7,5 +7,6 @@ relevant information about the development process. .. toctree:: :maxdepth: 2 - misc/benchmarks-website.rst - misc/benchmarks-python-graphs.rst + misc/sync + misc/benchmarks-website + misc/benchmarks-python-graphs diff --git a/docs/misc/sync.rst b/docs/misc/sync.rst new file mode 100644 index 00000000..b9d4c858 --- /dev/null +++ b/docs/misc/sync.rst @@ -0,0 +1,35 @@ +Soledad sync process +==================== + +TODO: this documentation needs to be updated to account for new streaming encryption method. + +Phases of sync: + +1. client acquires knowledge about server state. +2. client sends its documents to the server. +3. client downloads documents from the server. +4. client records its new state on the server. + +Originally in u1db: + +* **1** is a GET, +* **2** and **3** are one POST (send in body, receive in response), +* **4** is a PUT. + +In soledad: + +* **1** is a GET. +* **2** is either 1 or a series of sequential POSTS. + * **2.1** encrypt asynchronously + * **2.2** store in temp sync db +  * **2.3** upload sequentially +* **3** is a series of concurrent POSTS, insert sequentially on local client db. + * **3.1** download concurrently +  * **3.2** store in temp sync db +  * **3.3** decrypt asynchronously +  * **3.4** insert sequentially in local client db +* **4** is a PUT. + +This difference between u1db and soledad was made in order to be able to gracefully interrupt the sync in the middle of the upload or the download. + +it is essential that all the uploads and downloads are sequential: documents must be added in order. the download happens in parallel, but then locally they are added sequentially to the local db. diff --git a/docs/sync.rst b/docs/sync.rst deleted file mode 100644 index b9d4c858..00000000 --- a/docs/sync.rst +++ /dev/null @@ -1,35 +0,0 @@ -Soledad sync process -==================== - -TODO: this documentation needs to be updated to account for new streaming encryption method. - -Phases of sync: - -1. client acquires knowledge about server state. -2. client sends its documents to the server. -3. client downloads documents from the server. -4. client records its new state on the server. - -Originally in u1db: - -* **1** is a GET, -* **2** and **3** are one POST (send in body, receive in response), -* **4** is a PUT. - -In soledad: - -* **1** is a GET. -* **2** is either 1 or a series of sequential POSTS. - * **2.1** encrypt asynchronously - * **2.2** store in temp sync db -  * **2.3** upload sequentially -* **3** is a series of concurrent POSTS, insert sequentially on local client db. - * **3.1** download concurrently -  * **3.2** store in temp sync db -  * **3.3** decrypt asynchronously -  * **3.4** insert sequentially in local client db -* **4** is a PUT. - -This difference between u1db and soledad was made in order to be able to gracefully interrupt the sync in the middle of the upload or the download. - -it is essential that all the uploads and downloads are sequential: documents must be added in order. the download happens in parallel, but then locally they are added sequentially to the local db. -- cgit v1.2.3