diff --git a/docs/src/content/docs/plugins/loaders/mysql.mdx b/docs/src/content/docs/plugins/loaders/mysql.mdx index 7bc0406..44dbd23 100644 --- a/docs/src/content/docs/plugins/loaders/mysql.mdx +++ b/docs/src/content/docs/plugins/loaders/mysql.mdx @@ -4,7 +4,7 @@ title: MySQL Loader Plugin import { Tabs, TabItem } from '@astrojs/starlight/components'; -The MySQL loader plugin transforms `.sql` files into JavaScript functions that Emigrate can use to execute the migrations. +The MySQL loader plugin transforms `.sql` files into JavaScript functions that Emigrate can use to execute the migrations. In the same package you can find the [MySQL Generator](/plugins/generators/mysql/) and the [MySQL Storage](/plugins/storage/mysql/). ## Installation diff --git a/docs/src/content/docs/plugins/storage/mysql.mdx b/docs/src/content/docs/plugins/storage/mysql.mdx index 8ccbc55..5250b84 100644 --- a/docs/src/content/docs/plugins/storage/mysql.mdx +++ b/docs/src/content/docs/plugins/storage/mysql.mdx @@ -4,7 +4,7 @@ title: MySQL Storage import { Tabs, TabItem } from '@astrojs/starlight/components'; -The MySQL storage plugin uses a MySQL database to store the migration history (*duh*). +The MySQL storage plugin uses a MySQL database to store the migration history (*duh*). In the same package you can find the [MySQL Loader](/plugins/loaders/mysql/) and the [MySQL Generator](/plugins/generators/mysql/). ## Installation diff --git a/docs/src/content/docs/reference/configuration.mdx b/docs/src/content/docs/reference/configuration.mdx index 6f9f1eb..e8753da 100644 --- a/docs/src/content/docs/reference/configuration.mdx +++ b/docs/src/content/docs/reference/configuration.mdx @@ -47,7 +47,7 @@ Set the directory where your migrations are located, relative to the project roo **type:** `string | EmigrateReporter | Promise | (() => Promise)` **default:** `"default"` - the default reporter -Set the reporter to use for the different commands. Specifying a reporter is most useful in a CI or production environment where you either ship logs or want to have a machine-readable format. +Set the reporter to use for the different commands. Specifying a [reporter](/plugins/reporters/) is most useful in a CI or production environment where you either ship logs or want to have a machine-readable format. ```js title="emigrate.config.js" {2} export default { @@ -77,7 +77,7 @@ The default reporter automatically detects if the current environment is an inte **type:** `string | EmigrateStorage | Promise | (() => Promise)` -Set the storage plugin to use for storing and reading the migration history. This option is required by all Emigrate commands except `new` which doesn't use it. +Set the [storage plugin](/plugins/storage/) to use for storing and reading the migration history. This option is required by all Emigrate commands except `new` which doesn't use it. ```js title="emigrate.config.js" {2} export default { @@ -86,7 +86,7 @@ export default { ``` :::note -Each storage plugin can have its own configuration options, see the corresponding [Storage Plugin](/storage/) section for more information. +Each storage plugin can have its own configuration options, see the corresponding [Storage Plugin](/plugins/storage/) section for more information. ::: ### `plugins` @@ -97,8 +97,8 @@ Set the plugins to use for the different commands. There are different types of In short: -* [Loader Plugins](/loaders/) - are used for transforming non-JavaScript files into JavaScript files that can be executed by Node.js. These are only used by the `up` command. -* [Generator Plugins](/generators/) - are used for generating new migration files. These are only used by the `new` command. +* [Loader Plugins](/plugins/loaders/) - are used for transforming non-JavaScript files into JavaScript files that can be executed by Node.js. These are only used by the `up` command. +* [Generator Plugins](/plugins/generators/) - are used for generating new migration files. These are only used by the `new` command. ```js title="emigrate.config.js" {2} export default { @@ -107,7 +107,7 @@ export default { ``` :::tip[Did you know?] -The same package can expose multiple plugins, so you can specify the plugin only once and it can be used as both a loader and a generator (and storage, in the case of [MySQL](/storage/mysql) for instance). +The same package can expose multiple plugins, so you can specify the plugin only once and it can be used as both a loader and a generator (and storage, in the case of [MySQL](/plugins/storage/mysql) for instance). ::: ### `template`