added info about database migrations

nextguyover · Aug 2, 2024 · e5bc751 · e5bc751
1 parent 582d14b
commit e5bc751
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/docs/development/database-schema-changes/index.md b/docs/development/database-schema-changes/index.md
@@ -0,0 +1,17 @@
+# Database Schema Changes
+
+!!! info "This section of the documentation is intended for developers"
+
+[EF Core database migrations](https://learn.microsoft.com/en-us/ef/core/managing-schemas/migrations/) are used to allow existing Confab databases to be updated alongside the database schema (as new features are added in future Confab versions). This page covers the database migration steps that should be performed any time the database schema is changed.
+
+Provided commands below should be run in the Visual Studio Package Manager Console (the .NET Core CLI can also be used).
+
+## Creating a Migration
+
+A new database migration should be created after any database schema changes. Replace `MigrationName` with a descriptive name for this migration.
+
+```
+
+Add-Migration MigrationName
+
+```
diff --git a/docs/development/index.md b/docs/development/index.md
@@ -1,5 +1,7 @@
 # Confab Development
 
+!!! info "This section of the documentation is intended for developers"
+
 ## Setting Up Dev Environment
 
 ### 1. Backend

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,6 +25,7 @@ nav:
     - config/index.md
   - Development:
     - development/index.md
+    - Database Schema Changes: development/database-schema-changes/index.md
   - About:
     - Design Philosophy: about/design.md
     - Future Roadmap: about/roadmap.md