launchpad-reviewers team mailing list archive

[Jürgen Gmach <mp+415454@xxxxxxxxxxxxxxxxxx>]

Jürgen Gmach has proposed merging ~jugmac00/launchpad:add-doc-how-to-apply-database-changes into launchpad:master.

Commit message:
Add "How to apply database schema changes" how-to document

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~jugmac00/launchpad/+git/launchpad/+merge/415454
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~jugmac00/launchpad:add-doc-how-to-apply-database-changes into launchpad:master.

diff --git a/doc/how-to/apply-schema-changes.rst b/doc/how-to/apply-schema-changes.rst
new file mode 100644
index 0000000..8f6d9c3
--- /dev/null
+++ b/doc/how-to/apply-schema-changes.rst
@@ -0,0 +1,28 @@
+====================================
+How to apply database schema changes
+====================================
+
+.. note::
+
+    Please note that there is no database migration tool available.
+
+Whenever changes are made to the database schema,
+these changes need to be applied to databases in use.
+
+The straightforward way is to run the following command:
+
+.. note::
+
+    Running this command will erase and rebuild everything.
+
+.. code-block:: bash
+
+    make schema
+
+
+If you only want to rebuild the test template database,
+please run the following command:
+
+.. code-block:: bash
+
+    make -C database/schema
diff --git a/doc/index.rst b/doc/index.rst
index 399ca93..b3556f8 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -32,6 +32,7 @@ How-to Guides
    how-to/exceptions
    how-to/security
    how-to/new-user
+   how-to/apply-schema-changes
 
 Explanation
 ===========