diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index abce4d5aa..c876b0f74 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -117,21 +117,6 @@ If any of the following applies to the patch, a release note is required: A release note is suggested if a long-standing or important bug is fixed. Otherwise, a release note is not required. -Database Migrations -------------------- - -Monasca uses `Alembic `_ -migrations to set up its configuration database. If you need to change the -configuration database's schema, you need to create a migration to adjust the -database accordingly, as follows:: - - cd monasca_api/db/ - alembic revision - -This will create a new skeleton revision for you to edit. You will find -existing revisions to use for inspiration in the -``/monasca_api/db/alembic/versions/`` directory. - Task Tracking ~~~~~~~~~~~~~ .. This section is about where you track tasks- launchpad? storyboard? is there diff --git a/doc/source/contributor/db_migrations.rst b/doc/source/contributor/db_migrations.rst new file mode 100644 index 000000000..bee6ce705 --- /dev/null +++ b/doc/source/contributor/db_migrations.rst @@ -0,0 +1,17 @@ +Database Migrations +------------------- + +Monasca uses `Alembic `_ +migrations to set up its configuration database. If you need to change the +configuration database's schema, you need to create a migration to adjust the +database accordingly, as follows:: + + cd monasca_api/db/ + alembic revision + +This will create a new skeleton revision for you to edit. You will find +existing revisions to use for inspiration in the +``/monasca_api/db/alembic/versions/`` directory. + +Measurement data stored in a Time Series database (such as InfluxDB) would +be migrated to a new version using standard practice for a given TSDB. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index e611b2be7..8fcda36cb 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -6,4 +6,5 @@ Contribution documentation :maxdepth: 1 contributing.rst + db_migrations.rst code.rst