Add release notes; update docs here and there.

README.rst

@@ -47,7 +47,7 @@ Installation & Documentation
 
 With Docker::
 
-    git clone https://github.com/scossu/lakesuperior.git
+    git clone --recurse-submodules https://github.com/scossu/lakesuperior.git
     cd lakesuperior
     docker-compose up
 

docs/contributing.rst

@@ -15,12 +15,11 @@ Lakesuperior is meant to live as a community project.
 Development Setup
 -----------------
 
-To set up the software for developing code, documentation, or tests::
+To set up the software for developing code, documentation, or tests, start in
+an empty project folder::
 
-    mkdir lsup # or whatever you may want to call it
-    cd lsup
     python3 -m venv venv
-    source bin/activate
+    source venv/bin/activate
     git clone --recurse-submodules https://github.com/scossu/lakesuperior.git src
     cd src
     pip install -e .
@@ -56,11 +55,11 @@ You can contribute by (from least to most involved):
 - Adding test coverage (**HOT**)
 - Browsing the list of open issues and picking a ticket that you may find
   interesting and within your reach
-- Suggesting new functionality or improvements and/or implementing them
+- Suggesting new functionality or improvements and implementing them
 
 Please open a ticket and discuss the issue you are raising before opening a PR.
 
-Documentation is critical. If you implement new modules, class or methods, or
+Documentation is critical. If you implement new modules, classes or methods, or
 modify them, please document them thoroughly and verify that the API docs are
 displaying and linking correctly.
 
@@ -72,5 +71,5 @@ and open a pull request against development. In case you find a critical bug,
 a hotfix can be proposed against master if agreed in the related issue
 discussion.
 
-Last but not least, read carefully the `Code of
-Conduct <../../code_of_conduct.md>`__.
+Last but not least, read carefully the `Code of Conduct
+<https://github.com/scossu/lakesuperior/blob/master/code_of_conduct.md>`__.

docs/release_notes.rst

@@ -2,6 +2,22 @@
 Release Notes
 =============
 
+1.0 Alpha 20
+------------
+
+*April 08, 2019*
+
+After 6 months and almost 200 commits, this release completes a major effort
+to further move performance-critical sections of the code to C libraries.
+
+The storage layer has been simplified by moving from 5-byte ``char*`` keys to
+``size_t`` integers (8 bytes in most architectures). This means that this
+version requires a data migration from previous vresions.
+
+:doc:`Performance benchmarks <performance>` have been updated with new results
+and charts.
+
+
 1.0 Alpha 19 HOTFIX
 -------------------
 

docs/setup.rst

@@ -15,7 +15,7 @@ your host machine.
    Edition <https://www.docker.com/community-edition>`__ for your
    operating system.
 2. Clone the Lakesuperior git repository:
-   ``git clone https://github.com/scossu/lakesuperior.git``
+   ``git clone --recurse-submodules https://github.com/scossu/lakesuperior.git``
 3. ``cd`` into repo folder
 4. Run ``docker-compose up``
 
@@ -36,7 +36,7 @@ modifications. Feedback is welcome.
 Dependencies
 ~~~~~~~~~~~~
 
-#. Python 3.5 or greater.
+#. Python 3.6 or greater.
 #. A message broker supporting the STOMP protocol. For testing and
    evaluation purposes, `CoilMQ <https://github.com/hozn/coilmq>`__ is
    included with the dependencies and should be automatically installed.
@@ -49,10 +49,8 @@ and paste the lines below in your console.
 
 ::
 
-    mkdir lsup_env # Or whatever you want to call it
-    cd lsup_env
-    python3 -m venv .
-    source bin/activate
+    python3 -m venv venv
+    source venv/bin/activate
     pip install lakesuperior
     # Start the message broker. If you have another
     # queue manager listening to port 61613 you can either configure a
@@ -60,7 +58,7 @@ and paste the lines below in your console.
     # message queue.
     coilmq&
     # Bootstrap the repo
-    echo yes | lsup-admin bootstrap
+    lsup-admin bootstrap # Confirm manually
     # Run the thing
     fcrepo