chore: add documentation to the migrate command

flipt-io · Feb 8, 2024 · 8df75dc · 8df75dc
1 parent 4dc397c
commit 8df75dc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/cli/commands/migrate.mdx b/cli/commands/migrate.mdx
@@ -10,8 +10,9 @@ flipt migrate [flags]
 ### Options
 
 ```
-      --config string   path to config file
-  -h, --help            help for migrate
+      --config string     path to config file
+      --database string   string to denote which database type to migrate (default "default")
+  -h, --help              help for migrate
 ```
 
 ### More Info

diff --git a/configuration/analytics.mdx b/configuration/analytics.mdx
@@ -15,7 +15,7 @@ The data that gets reported into the storage backends are currently:
 
 - Flag Evaluation Count
 
-All of these analytics are viewable on the UI, and users can look back up to 24 hours of data for each metric.
+These analytics are viewable on the UI, and users can look back up to 24 hours of data for each metric.
 
 ![UI For Analytics](/images/configuration/analytics_quick_view.png)
 
@@ -31,6 +31,6 @@ The reason for this isn't just a separation of concerns on a general level, but
 
 ### Origin of Analytics
 
-Analytics are only produced currently as they pass through the server, which means if you use the [server sdks](/integration/server/rest) or the various [grpc sdks](/integration/server/grpc), analytical data will be sent to the backing store.
+Analytics are only produced currently as they pass through the server. This means you will receive data in your analytics database if your use either the [server sdks](/integration/server/rest) or the various [grpc sdks](/integration/server/grpc).
 
 For client-side evaluation no metrics will be sent into clickhouse, but we're working on a feature to get it supported.
diff --git a/configuration/storage.mdx b/configuration/storage.mdx
@@ -82,6 +82,8 @@ From time to time the Flipt database must be updated with new schema. To
 accomplish this, Flipt includes a `migrate` command that will run any pending
 database migrations for you.
 
+By default Flipt will run your application data migrations. You can run migrations on your [analytical](/configuration/analytics) databases by specifying the `--database=analytics` flag to the migrate command. 
+
 If Flipt is started and there are pending migrations, you will see the following
 error in the console: