From d5be909ccdfce014592586b2dccbc5ae67fc5a29 Mon Sep 17 00:00:00 2001 From: Derek Date: Sat, 1 Oct 2022 14:16:21 -0700 Subject: [PATCH] docs: minor updates to getting started docs --- GETTING_STARTED.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 5946005cd..5a204c07e 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -1,7 +1,7 @@ # Getting started Before you start, you should understand the concept of forward/up and reverse/down database migrations. -Configure a database for your application. Make sure that your database driver is supported [here](README.md#databases) +Configure a database for your application. Make sure that your database driver is supported [here](README.md#databases). ## Create migrations Create some migrations using migrate CLI. Here is an example: @@ -10,7 +10,7 @@ migrate create -ext sql -dir db/migrations -seq create_users_table ``` Once you create your files, you should fill them. -**IMPORTANT:** In a project developed by more than one person there is a chance of migrations inconsistency - e.g. two developers can create conflicting migrations, and the developer that created his migration later gets it merged to the repository first. +**IMPORTANT:** In a project developed by more than one person there is a chance of migrations inconsistency - e.g. two developers can create conflicting migrations, and the developer that created their migration later gets it merged to the repository first. Developers and Teams should keep an eye on such cases (especially during code review). [Here](https://github.com/golang-migrate/migrate/issues/179#issuecomment-475821264) is the issue summary if you would like to read more. @@ -30,7 +30,7 @@ Just add the code to your app and you're ready to go! Before commiting your migrations you should run your migrations up, down, and then up again to see if migrations are working properly both ways. (e.g. if you created a table in a migration but reverse migration did not delete it, you will encounter an error when running the forward migration again) -It's also worth checking your migrations in a separate, containerized environment. You can find some tools in the end of this document. +It's also worth checking your migrations in a separate, containerized environment. You can find some tools at the [end of this document](#further-reading). **IMPORTANT:** If you would like to run multiple instances of your app on different machines be sure to use a database that supports locking when running migrations. Otherwise you may encounter issues.