diff --git a/.changeset/funny-elephants-live.md b/.changeset/funny-elephants-live.md new file mode 100644 index 0000000..f629de9 --- /dev/null +++ b/.changeset/funny-elephants-live.md @@ -0,0 +1,5 @@ +--- +'@emigrate/docs': major +--- + +Rename the URL path "/commands/" to "/cli/" to make it more clear that those pages are the documentation for the CLI. This change is a BREAKING CHANGE because it changes the URL path of the pages. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 676bea6..c36d9a8 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -30,4 +30,4 @@ ### Minor Changes - cbc35bd: Add first version of the [Baseline guide](https://emigrate.dev/guides/baseline) -- cbc35bd: Document the new --limit, --from and --to options for the ["up" command](https://emigrate.dev/commands/up/) +- cbc35bd: Document the new --limit, --from and --to options for the ["up" command](https://emigrate.dev/cli/up/) diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 17b41c2..a35ee37 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -82,26 +82,26 @@ export default defineConfig({ items: [ { label: 'Introduction', - link: '/commands/', + link: '/cli/', }, { label: 'Commands', items: [ { label: 'emigrate up', - link: '/commands/up/', + link: '/cli/up/', }, { label: 'emigrate list', - link: '/commands/list/', + link: '/cli/list/', }, { label: 'emigrate new', - link: '/commands/new/', + link: '/cli/new/', }, { label: 'emigrate remove', - link: '/commands/remove/', + link: '/cli/remove/', }, ], }, diff --git a/docs/src/content/docs/commands/index.mdx b/docs/src/content/docs/cli/index.mdx similarity index 100% rename from docs/src/content/docs/commands/index.mdx rename to docs/src/content/docs/cli/index.mdx diff --git a/docs/src/content/docs/commands/list.mdx b/docs/src/content/docs/cli/list.mdx similarity index 100% rename from docs/src/content/docs/commands/list.mdx rename to docs/src/content/docs/cli/list.mdx diff --git a/docs/src/content/docs/commands/new.mdx b/docs/src/content/docs/cli/new.mdx similarity index 100% rename from docs/src/content/docs/commands/new.mdx rename to docs/src/content/docs/cli/new.mdx diff --git a/docs/src/content/docs/commands/remove.mdx b/docs/src/content/docs/cli/remove.mdx similarity index 97% rename from docs/src/content/docs/commands/remove.mdx rename to docs/src/content/docs/cli/remove.mdx index d6adb9f..6590d17 100644 --- a/docs/src/content/docs/commands/remove.mdx +++ b/docs/src/content/docs/cli/remove.mdx @@ -55,7 +55,7 @@ The `remove` command is used to remove a migration from the history. This is use The name of the migration file to remove, including the extension, e.g. `20200101000000_some_migration.js`, or a relative file path to a migration file to remove, e.g: `migrations/20200101000000_some_migration.js`. -Using relative file paths is useful in terminals that support autocomplete, and also when you copy and use the relative migration file path from the output of the `list` command. +Using relative file paths is useful in terminals that support autocomplete, and also when you copy and use the relative migration file path from the output of the `list` command. ## Options diff --git a/docs/src/content/docs/commands/up.mdx b/docs/src/content/docs/cli/up.mdx similarity index 100% rename from docs/src/content/docs/commands/up.mdx rename to docs/src/content/docs/cli/up.mdx diff --git a/docs/src/content/docs/guides/baseline.mdx b/docs/src/content/docs/guides/baseline.mdx index 2e2df5e..62381f0 100644 --- a/docs/src/content/docs/guides/baseline.mdx +++ b/docs/src/content/docs/guides/baseline.mdx @@ -113,8 +113,8 @@ CREATE TABLE public.posts ( ### Log the baseline migration -For new environments this baseline migration will automatically be run when you run `emigrate up`. -For any existing environments you will need to run `emigrate up` with the `--no-execution` flag to prevent the migration from being executed and only log the migration: +For new environments this baseline migration will automatically be run when you run `emigrate up`. +For any existing environments you will need to run `emigrate up` with the `--no-execution` flag to prevent the migration from being executed and only log the migration: @@ -155,7 +155,7 @@ For any existing environments you will need to run `emigrate up` with the -In case you have already added more migration files to your migration directory you can limit the "up" command to just log the baseline migration by specifying the `--to` option: +In case you have already added more migration files to your migration directory you can limit the "up" command to just log the baseline migration by specifying the `--to` option: @@ -198,7 +198,7 @@ In case you have already added more migration files to your migration directory ### Verify the baseline migration status -You can verify the status of the baseline migration by running the `emigrate list` command: +You can verify the status of the baseline migration by running the `emigrate list` command: @@ -251,5 +251,5 @@ Emigrate list v0.14.1 /your/project/path ### Happy migrating! -You can now start adding new migrations to your migration directory and run `emigrate up` to apply them to your database. +You can now start adding new migrations to your migration directory and run `emigrate up` to apply them to your database. Which should be part of your CD pipeline to ensure that your database schema is always up to date in each environment. diff --git a/docs/src/content/docs/guides/typescript.mdx b/docs/src/content/docs/guides/typescript.mdx index 267846a..7214f5c 100644 --- a/docs/src/content/docs/guides/typescript.mdx +++ b/docs/src/content/docs/guides/typescript.mdx @@ -47,7 +47,7 @@ After installing `tsx` you can load it in two ways. #### Via CLI -Using the `--import` flag you can load `tsx` before running your migration files. +Using the `--import` flag you can load `tsx` before running your migration files. diff --git a/docs/src/content/docs/plugins/generators/index.mdx b/docs/src/content/docs/plugins/generators/index.mdx index de8c0da..69be705 100644 --- a/docs/src/content/docs/plugins/generators/index.mdx +++ b/docs/src/content/docs/plugins/generators/index.mdx @@ -22,5 +22,5 @@ The generator is responsible for generating migration files in a specific format :::note -Instead of having to install a generator plugin, you can also use the much simpler `--template` option to specify a custom template file for new migrations. +Instead of having to install a generator plugin, you can also use the much simpler `--template` option to specify a custom template file for new migrations. ::: diff --git a/docs/src/content/docs/plugins/generators/js.mdx b/docs/src/content/docs/plugins/generators/js.mdx index b77c6be..e45a8d3 100644 --- a/docs/src/content/docs/plugins/generators/js.mdx +++ b/docs/src/content/docs/plugins/generators/js.mdx @@ -79,4 +79,4 @@ A generator plugin for generating new m -For more information see the `new` command's documentation. +For more information see the `new` command's documentation. diff --git a/docs/src/content/docs/plugins/generators/mysql.mdx b/docs/src/content/docs/plugins/generators/mysql.mdx index d36e7d3..9793eaf 100644 --- a/docs/src/content/docs/plugins/generators/mysql.mdx +++ b/docs/src/content/docs/plugins/generators/mysql.mdx @@ -79,4 +79,4 @@ The MySQL generator creates new migration files with the `.sql` extension. In th -For more information see the `new` command's documentation. +For more information see the `new` command's documentation. diff --git a/docs/src/content/docs/plugins/generators/postgres.mdx b/docs/src/content/docs/plugins/generators/postgres.mdx index 748c511..524d632 100644 --- a/docs/src/content/docs/plugins/generators/postgres.mdx +++ b/docs/src/content/docs/plugins/generators/postgres.mdx @@ -79,4 +79,4 @@ The PostgreSQL generator creates new migration files with the `.sql` extension. -For more information see the `new` command's documentation. +For more information see the `new` command's documentation. diff --git a/docs/src/content/docs/plugins/reporters/json.mdx b/docs/src/content/docs/plugins/reporters/json.mdx index a1118fd..f9a5d4f 100644 --- a/docs/src/content/docs/plugins/reporters/json.mdx +++ b/docs/src/content/docs/plugins/reporters/json.mdx @@ -49,7 +49,7 @@ The reporter is included by default and does not need to be installed separately -See for instance the Reporter Option for the `up` command for more information. +See for instance the Reporter Option for the `up` command for more information. ### Via configuration file diff --git a/docs/src/content/docs/plugins/reporters/pino.mdx b/docs/src/content/docs/plugins/reporters/pino.mdx index e76d6ff..46adc8a 100644 --- a/docs/src/content/docs/plugins/reporters/pino.mdx +++ b/docs/src/content/docs/plugins/reporters/pino.mdx @@ -87,7 +87,7 @@ The `@emigrate/reporter-` prefix is optional when using this reporter. -See for instance the Reporter Option for the `up` command for more information. +See for instance the Reporter Option for the `up` command for more information. ### Via configuration file diff --git a/docs/src/content/docs/plugins/reporters/pretty.mdx b/docs/src/content/docs/plugins/reporters/pretty.mdx index 1f0cbe0..c81cb77 100644 --- a/docs/src/content/docs/plugins/reporters/pretty.mdx +++ b/docs/src/content/docs/plugins/reporters/pretty.mdx @@ -11,7 +11,7 @@ The reporter is included by default and does not need to be installed separately ## Usage -By default, Emigrate uses the "pretty" reporter, but it can also be explicitly set by using the `--reporter` flag. +By default, Emigrate uses the "pretty" reporter, but it can also be explicitly set by using the `--reporter` flag.