aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
authorElrond <elrond+mediagoblin.org@samba-tng.org>2012-04-05 19:46:24 +0200
committerElrond <elrond+mediagoblin.org@samba-tng.org>2012-04-05 19:49:14 +0200
commit5be6425c2812945b1346f59c9b8188cdaf9168d9 (patch)
tree98da8361ad14d927fd6c89a59fcafd0f2d626fbc /docs/source
parent775ec9e8f77cb4dd0d4a0388d40e0ae813bbf244 (diff)
downloadmediagoblin-5be6425c2812945b1346f59c9b8188cdaf9168d9.tar.lz
mediagoblin-5be6425c2812945b1346f59c9b8188cdaf9168d9.tar.xz
mediagoblin-5be6425c2812945b1346f59c9b8188cdaf9168d9.zip
Start adding release notes.
This is especially for noting the switch to sql and explaining how to convert your mongodb data over to sql.
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/relnotes.rst52
2 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 444ed688..187a0382 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -31,6 +31,7 @@ Table of Contents:
configuration
media-types
help
+ relnotes
theming
codebase
diff --git a/docs/source/relnotes.rst b/docs/source/relnotes.rst
new file mode 100644
index 00000000..7a157a0c
--- /dev/null
+++ b/docs/source/relnotes.rst
@@ -0,0 +1,52 @@
+.. MediaGoblin Documentation
+
+ Written in 2012 by MediaGoblin contributors
+
+ To the extent possible under law, the author(s) have dedicated all
+ copyright and related and neighboring rights to this software to
+ the public domain worldwide. This software is distributed without
+ any warranty.
+
+ You should have received a copy of the CC0 Public Domain
+ Dedication along with this software. If not, see
+ <http://creativecommons.org/publicdomain/zero/1.0/>.
+
+=============
+Release Notes
+=============
+
+This chapter has important information for releases in it.
+If you're upgrading from a previous release, please read it
+carefully, or at least skim over it.
+
+
+0.3.0
+=====
+
+This release has one important change. You need to act when
+upgrading from a previous version!
+
+This release changes the database system from MongoDB to
+SQL(alchemy). If you want to setup a fresh instance, just
+follow the instructions in the deployment chapter. If on
+the other hand you want to continue to use one instance,
+read on.
+
+To convert our data from MongoDB to SQL(alchemy), you need
+to follow these steps:
+
+1. Make sure your MongoDB is still running and has your
+ data, it's needed for the conversion.
+
+2. Configure the sql_engine URI in the config to represent
+ your target database (see: Deployment docs)
+
+3. You need an empty database.
+
+4. Then run the following command::
+
+ bin/gmg [-cf mediagoblin_config.ini] convert_mongo_to_sql
+
+5. Start your server and investigate.
+
+6. That's it.