Skip to content

Commit 8991ed8

Browse files
authored
Merge pull request #14 from mongodb-developer/improve-instructions
Changed sections levels, improved overall installation instructions
2 parents 4307680 + 90f953c commit 8991ed8

File tree

4 files changed

+25
-14
lines changed

4 files changed

+25
-14
lines changed

docs/20-prerequisites/10-postgres.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,23 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
66

77
# 👐 PostgreSQL Database
88

9-
In this lab you will be migrating data from a PostgreSQL relational database. You have a few options to set up this database.
9+
In this lab you will be migrating data from a PostgreSQL relational database. You have a few options to set up this database. __Choose one option for your PostgreSQL database__.
1010

11-
### Option 1: Use a pre-configured database
11+
## Option 1: Use a pre-configured database
1212

13-
If you are participating in an instructor-led lab, they may have already set up this database for you. Ask your instructor for the
14-
connection URI and credentials.
13+
If you are participating in an instructor-led lab, they may have already set up this database for you. Ask your instructor for the connection URI and credentials.
1514

16-
### Option 2: Load the schema and data into your own PostgreSQL server
15+
:::info
16+
In an intructor-led lab you will use the provisioned PostgreSQL database, no need to do anything else
17+
:::
18+
19+
## Option 2: Load the schema and data into your own PostgreSQL server
1720

1821
If you already have a PostgreSQL server set up, you can import the schema and data used in this lab. Download the file
1922
[1-library-schema-and-data.sql](https://github.com/mongodb-developer/relational-migrator-lab/blob/main/docker/sample-postgres-library/init/1-library-schema-and-data.sql)
2023
file and load it using psql or [pgAdmin](https://www.pgadmin.org/download/).
2124

22-
### Option 3: Run a PostgreSQL container using Docker
25+
## Option 3: Run a PostgreSQL container using Docker
2326

2427
If you don't have an existing PostgreSQL server but have Docker installed, you can easily load a container pre-configured with
2528
PostgreSQL and the sample database:
@@ -36,7 +39,7 @@ docker run -p 5432:5432 sample-postgres-library
3639
```
3740
The PostgreSQL server can be accessed at localhost:5432 with a username of `postgres` and a password of `postgres`.
3841

39-
### Option 4: Load an SQL file
42+
## Option 4: Load an SQL file
4043
Choose this option if you just want a quick hands-on experience and you don't need to run actual migration.
4144
Download the file [library-schema.sql](https://github.com/mongodb-developer/relational-migrator-lab/blob/main/resource/library-schema.sql)
4245
and upload this file to the Relational Migrator later, at the **create a project** step.

docs/20-prerequisites/20-mongodb.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99
As we'll be importing data from a Relational Database into MongoDB, you'll need to have a MongoDB database. You have a
1010
few options to set up this database.
1111

12-
### Option 1: New MongoDB Atlas cluster
12+
## Option 1: New MongoDB Atlas cluster
1313

1414
The easiest way to run MongoDB is to use MongoDB Atlas, our cloud-hosted database offering.
1515
You can set a MongoDB Atlas account and a free forever M0 Cluster.
@@ -20,12 +20,12 @@ To get yours, follow the instructions on the [Intro Lab:](https://mongodb-develo
2020

2121
Be sure to [open up the cluster to allow connections from your local computer](https://www.mongodb.com/docs/guides/atlas/network-connections/#overview), and configure a database user with the readWriteAnyDatabase role.
2222

23-
### Option 2: Use an existing cluster
23+
## Option 2: Use an existing cluster
2424

2525
If you have an existing MongoDB Atlas, Enterprise or Community cluster, you can use it as the migration target. Make sure you
2626
know the URI for the cluster, and have a database user with the readWriteAnyDatabase role.
2727

28-
### Option 3: Run a MongoDB container using Docker
28+
## Option 3: Run a MongoDB container using Docker
2929

3030

3131
If you don't have an existing PostgreSQL server but have Docker installed, you can easily load a container pre-configured with

docs/20-prerequisites/30-relational-migrator.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,17 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
66

77
# 👐 MongoDB Relational Migrator
88

9-
Download and install MongoDB Relational Migrator
9+
Download and install MongoDB Relational Migrator.
1010

11-
Now you will need to go to the [MongoDB Relational Migrator downloads page](https://www.mongodb.com/try/download/relational-migrator), select your OS, download and install it. Once installed,
12-
run it and it will be running on a browser at http://127.0.0.1:8278/.
11+
- Go to the [MongoDB Relational Migrator downloads page](https://www.mongodb.com/try/download/relational-migrator), select your OS and download it
12+
- Install the MongoDB Relational Migrator
13+
- Start it
14+
- It should open a browser at the address http://127.0.0.1:8278/
1315

1416
<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/download-relational-migrator.png" alt="Screenshot of the download page for Relational Migrator" />
17+
18+
---
19+
20+
:::info
21+
There are more advanced ways to install the MongoDB Relational Migrator. You can check them out in [the installation docs page](https://www.mongodb.com/docs/relational-migrator/installation/). These won't be covered during this Lab.
22+
:::

docs/50-create-project/50-create-new-project.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import Screenshot from "@site/src/components/Screenshot";
22

33
# 👐 Creating a New Project
44

5-
Ensure Relational Migrator is installed and running (normally at http://127.0.0.1:8278/).
5+
Ensure Relational Migrator is installed and running (usually at http://127.0.0.1:8278/).
66

77

88

0 commit comments

Comments
 (0)