Changed URL to actual local RM URL, fixed some style typos

dfreniche · dfreniche · commit 112ef98ac186 · 2025-02-12T09:26:21.000+01:00
diff --git a/docs/20-prerequisites/10-postgres.mdx b/docs/20-prerequisites/10-postgres.mdx
@@ -6,31 +6,31 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 
 # 👐 PostgreSQL Database
 
-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__.
+In this lab you will be migrating data from a PostgreSQL relational database. You have a few options to set up this database. __Choose just one option for your PostgreSQL database__.
 
 ## 👐 Option 1: Use a pre-configured database
 
 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.
 
 :::info
-In an intructor-led lab you will use the provisioned PostgreSQL database, no need to do anything else
+In an intructor-led lab you will use the provisioned PostgreSQL database, no need to do anything else.
 :::
 
 ## 🦸 Option 2: Load the schema and data into your own PostgreSQL server
 
 If you already have a PostgreSQL server set up, you can import the schema and data used in this lab. Download the file 
 [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)
-file and load it using psql or [pgAdmin](https://www.pgadmin.org/download/).
+ and load it using [psql](https://www.postgresql.org/docs/10/app-psql.html) or [pgAdmin](https://www.pgadmin.org/download/).
 
 ## 🦸 Option 3: Run a PostgreSQL container using Docker
 
 If you don't have an existing PostgreSQL server but have Docker installed, you can easily load a container pre-configured with 
 PostgreSQL and the sample database:
 
 1. Clone or download the code from this lab's [Github repo](https://github.com/mongodb-developer/relational-migrator-lab).
-2. Open a terminal window and navigate to the repo root
+2. Open a terminal window and navigate to the repo root.
 3. Build the Docker image by running the command: 
-```
+```sh
 docker build -f ./docker/sample-postgres-library/Dockerfile -t sample-postgres-library .
 ```
 4. Start the Docker container by running the command:
@@ -40,8 +40,8 @@ docker run -p 5432:5432 sample-postgres-library
 The PostgreSQL server can be accessed at localhost:5432 with a username of `postgres` and a password of `postgres`.
 
 ## 🦸 Option 4: Load an SQL file
-Choose this option if you just want a quick hands-on experience and you don't need to run actual migration.
+Choose this option if you just want a quick hands-on experience and you don't need to run an actual migration.
 Download the file [library-schema.sql](https://github.com/mongodb-developer/relational-migrator-lab/blob/main/resource/library-schema.sql)
-and upload this file to the Relational Migrator later, at the **create a project** step. 
+and upload this file to the Relational Migrator later, at the [create a project](/docs/category/-create-a-project) step. 
 
 This is just the schema of the database, without actual data, so, you will not be able to perform an actual migration since you do not have a source database. But you can model the schema and play around with the Relational Migrator.
diff --git a/docs/210-Migrate Data/10-migration.mdx b/docs/210-Migrate Data/10-migration.mdx
@@ -4,27 +4,27 @@ import Screenshot from "@site/src/components/Screenshot";
 
 - At the top, switch to Data Migration tab
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/210-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/210-image-001.png" alt="Screenshot of the connect modal" />
 
 - Click create sync job
 - Specify source DB connection details
   - The details will be populated from when you created the project. 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/210-image-002.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/210-image-002.png" alt="Screenshot of the connect modal" />
 
 - Specify MongoDB connection details
   - Enter the URI, database, username and password for your MongoDB cluster
   - If you are using Atlas, you can retrieve the details from the [Atlas portal](https://cloud.mongodb.com)
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/210-image-003.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/210-image-003.png" alt="Screenshot of the connect modal" />
 
 - Specify migration options 
   - Choose the `Drop destination collections before migration` option
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/210-image-004.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/210-image-004.png" alt="Screenshot of the connect modal" />
 
 - Read migration summary to confirm details
 - Run Start
 - Monitor the progress of the job
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/210-image-005.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/210-image-005.png" alt="Screenshot of the connect modal" />
diff --git a/docs/210-Migrate Data/20-view-migrated-data.mdx b/docs/210-Migrate Data/20-view-migrated-data.mdx
@@ -11,4 +11,4 @@ MongoDB Compass, or MongoDB Atlas. This topic assumes you have migrated your dat
 - Select the database you migrated data to
 - Select each of the collections and view the documents, confirming they conform to the schema you created.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/view-migrated-data-atlas.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/view-migrated-data-atlas.png" alt="Screenshot of the connect modal" />
diff --git a/docs/220-Generate code/10-generate-app-code.mdx b/docs/220-Generate code/10-generate-app-code.mdx
@@ -13,5 +13,5 @@ While this code is not production-ready, it can save developers significant time
 - Under Template, select `Sample Documents`. Notice how you can view examples of how data in each collection will be structured.
 - Under Template, select `JSON Schema (MongoDB)`. Notice how you can view and download JSON Schema validators which could be used to enforce schema compliance.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/generate-app-code.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/generate-app-code.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/220-Generate code/20-convert-queries.mdx b/docs/220-Generate code/20-convert-queries.mdx
@@ -15,5 +15,5 @@ in your choice of programming langauge. This feature uses Artifical Intelligence
 
 After a while, the equivalent MongoDB query will be shown at the right of the page. 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/convert-sql-queries.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/convert-sql-queries.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/220-Generate code/30-convert-sprocs.mdx b/docs/220-Generate code/30-convert-sprocs.mdx
@@ -14,5 +14,5 @@ in your choice of programming langauge. This feature uses Artifical Intelligence
 
 After a while, the equivalent MongoDB query will be shown at the right of the page. Try some other queries and langauges!
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/convert-sprocs.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/convert-sprocs.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/220-Generate code/40-testing-queries.mdx b/docs/220-Generate code/40-testing-queries.mdx
@@ -13,26 +13,26 @@ Relation Migrator allows you to go a step further, and verify the converted quer
 2. If you source data resides in the `public` schema in your PostgreSQL database, you may skip this step. Otherwise, you will need to add your source data schema into PostgreSQL's search path in order for the queries execute properly.
     
     Go to **Manage Connections**:
-    <Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/testing-queries-001.png" alt="Screenshot to manage connection" />
+    <Screenshot url="http://127.0.0.1:8278" src="img/testing-queries-001.png" alt="Screenshot to manage connection" />
     
     Edit your **JDBC URI** to include the search path. For example, if your source schema is `library`, add `options=-c%20search_path%3Dlibrary` as a query parameter to your URI:
     
-    <Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/testing-queries-002.png" alt="Screenshot to add search path" />
+    <Screenshot url="http://127.0.0.1:8278" src="img/testing-queries-002.png" alt="Screenshot to add search path" />
     
     Click **Save** and you can use the browser's **back button** to navigate back to the Query Converter page. 
 
 3. After which, you may expand the test query panel to begin executing your source query or converted query.
 
-    <Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/testing-queries-003.png" alt="Screenshot to expand query test panel" />
+    <Screenshot url="http://127.0.0.1:8278" src="img/testing-queries-003.png" alt="Screenshot to expand query test panel" />
 
 ## Executing queries for comparison
 
 1. Select the source query you want to test on the left pane. As an example, we will select the `get_books_by_genre` stored procedure.
 2. Convert the query to a MongoDB query if you have not done so, but note that the converted query may not always be correct.
 3. If it is a stored procedure, you will need to replace the placeholder parameter with a test value. In this example, we will replace it with `'Literature'`.
-    <Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/testing-queries-004.png" alt="Screenshot to show placeholder replacement" />
+    <Screenshot url="http://127.0.0.1:8278" src="img/testing-queries-004.png" alt="Screenshot to show placeholder replacement" />
 4. Click **RUN SOURCE QUERY** and **RUN CONVERTED QUERY** to execute the queries and  compare the results.
-    <Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/testing-queries-005.png" alt="Screenshot to show result comparison" />
+    <Screenshot url="http://127.0.0.1:8278" src="img/testing-queries-005.png" alt="Screenshot to show result comparison" />
 5. If the query results are different, check your MongoDB query. In this example, your MongoDB query should look like:
     ```js
         async function get_books_by_genre(db, genre_param) {
diff --git a/docs/40-desired-schema-mongodb.mdx b/docs/40-desired-schema-mongodb.mdx
@@ -8,7 +8,7 @@ that data that is frequently accessed together is stored together by using embed
 
 The following screenshot shows the MongoDB schema we will be creating in this lab.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/40-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/40-image-001.png" alt="Screenshot of the connect modal" />
 
 A few key points:
 - Books will contain an array of authors with author id and name for fast retrieval. This is using the [Extended Reference pattern](https://www.mongodb.com/blog/post/building-with-patterns-the-extended-reference-pattern) to reference a separate collection (Authors) but having in books enough information aubout the author.
diff --git a/docs/50-create-project/50-create-new-project.mdx b/docs/50-create-project/50-create-new-project.mdx
@@ -2,7 +2,7 @@ import Screenshot from "@site/src/components/Screenshot";
 
 # 👐 Creating a New Project
 
-Ensure Relational Migrator is installed and running (usually at http://127.0.0.1:8278/).
+Ensure the Relational Migrator is installed and running (usually at http://127.0.0.1:8278/).
 
 
 
@@ -12,8 +12,8 @@ Ensure Relational Migrator is installed and running (usually at http://127.0.0.1
 <Screenshot url="http://127.0.0.1:8278" src="img/50-image-001.png" alt="Screenshot of the connect modal" />
 
 ## Select one of the three options
-- Click **Connect database** if you are running the origin DB in the cloud, Docker or using your own hardware.
-- Click **Load schema from a file** if you don't have access to a source database and just want to work with the schema (you won't have any data to import though).
-- Click **Use a sample schema** to play around with a test schema, without any data. This does not require connecting to a real DB. We won't use this one in this Lab.
+- 👐 Click **Connect database** under "Connect to live database" if you are running the source database in the cloud, Docker or using your own hardware.
+- 🦸‍♂️ Click **Import .SQL file** under "Load schema from a file" if you don't have access to a source database and just want to work with the schema (you won't have any data to import though).
+- 🦸‍♂️ Click **Create sample** under "Use a sample schema" to play around with a test schema, without any data. This does not require connecting to a real DB. We won't use this one in this Lab.
 
 <Screenshot url="http://127.0.0.1:8278" src="img/50-image-002.png" alt="Screenshot of the connect modal" />
diff --git a/docs/50-create-project/60-connect-database.mdx b/docs/50-create-project/60-connect-database.mdx
@@ -10,7 +10,7 @@ We can store the credentials of our database so in the next session we can conne
 
 Then we'll select PostgreSQL as our source database.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/60-image-000.png" alt="Selecting PostgreSQL as Database" />
+<Screenshot url="http://127.0.0.1:8278" src="img/60-image-000.png" alt="Selecting PostgreSQL as Database" />
 
 ## Enter connection details
 
@@ -23,7 +23,7 @@ Enter the details for the PostgreSQL database you will be migrating from.
 - Click `Connect` to proceed to the next step.
 - You can give your connection a name and a tag to make it simpler to remember later
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/60-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/60-image-001.png" alt="Screenshot of the connect modal" />
 
 :::info
 🦸‍♂️ If you have followed the steps to configure PostgreSQL in a docker container, the hostname will be `localhost`, username `postgres` and password `postgres`. 
diff --git a/docs/50-create-project/70-select-tables.mdx b/docs/50-create-project/70-select-tables.mdx
@@ -4,7 +4,7 @@ import Screenshot from "@site/src/components/Screenshot";
 
 We want to migrate data from all of the tables, so check all of them (just check the library database) and then click `Next`.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/70-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/70-image-001.png" alt="Screenshot of the connect modal" />
 
 :::tip
 In a real project, you can select just a handful tables in case you're not interested in the whole database.
diff --git a/docs/50-create-project/80-define-initial-schema.mdx b/docs/50-create-project/80-define-initial-schema.mdx
@@ -18,7 +18,7 @@ Select the five collections that we want as they are the main Entities in our sc
 
 Any tables you did not check will be embedded in other collections. 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/80-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/80-image-001.png" alt="Screenshot of the connect modal" />
 
 Select the casing you'd like for your collections. Defaults to camelCase.
 
diff --git a/docs/60-project-settings.mdx b/docs/60-project-settings.mdx
@@ -9,5 +9,5 @@ import Screenshot from "@site/src/components/Screenshot";
 
 If we don't do this we'll have both an autogenerated `_id` field of type `ObjectId` and a `id` field copied from the relational DB.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/90-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/90-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/70-toggle-view.mdx b/docs/70-toggle-view.mdx
@@ -4,7 +4,7 @@ import Screenshot from "@site/src/components/Screenshot";
 
 At the bottom left, toggle between different views. We should be looking at the MDB view most of the time.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/100-image-000.png" alt="We can toggle between MDB, relational or both views" />
+<Screenshot url="http://127.0.0.1:8278" src="img/100-image-000.png" alt="We can toggle between MDB, relational or both views" />
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/100-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/100-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/10-edit-mapping-books-book-attribute.mdx b/docs/80-edit-mapping-rules/10-edit-mapping-books-book-attribute.mdx
@@ -32,4 +32,4 @@ We want to clean up the book_attributes array in our MongoDB schema. We want an
 Here we've implemented the [Attribute Pattern](https://www.mongodb.com/developer/products/mongodb/attribute-pattern/) for MongoDB. This will allow for easy indexing, querying based on attributes and extension of attributes. 
 :::
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/150-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/150-image-001.png" alt="Screenshot of the connect modal" />
diff --git a/docs/80-edit-mapping-rules/100-edit-mapping-issue-detail-issue-detail.mdx b/docs/80-edit-mapping-rules/100-edit-mapping-issue-detail-issue-detail.mdx
@@ -15,5 +15,5 @@ Now we want to remove some unncessary id fields from the issueDetails collection
 
 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/190-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/190-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/110-add-mapping-reviews-user.mdx b/docs/80-edit-mapping-rules/110-add-mapping-reviews-user.mdx
@@ -17,5 +17,5 @@ We want to store each user's name against their reviews.
 - Click `Save and close`.
 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/200-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/200-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/20-edit-mapping-books-book-genre.mdx b/docs/80-edit-mapping-rules/20-edit-mapping-books-book-genre.mdx
@@ -38,5 +38,5 @@ genres: [
 
 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/160-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/160-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/30-add-mapping-books-authors.mdx b/docs/80-edit-mapping-rules/30-add-mapping-books-authors.mdx
@@ -15,7 +15,7 @@ We want to modify the MongoDB schema so that each book contains an array of its
 - Click `Save and close` 
 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/130-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/130-image-001.png" alt="Screenshot of the connect modal" />
 
 ## 👐 Remove unneeded bookId from author details in books collection
 
@@ -40,7 +40,7 @@ This results in our `authors` array looking like:
     ]
 ```
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/140-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/140-image-001.png" alt="Screenshot of the connect modal" />
 
 
 :::info
diff --git a/docs/80-edit-mapping-rules/50-add-mapping-books-reviews.mdx b/docs/80-edit-mapping-rules/50-add-mapping-books-reviews.mdx
@@ -24,5 +24,5 @@ Limitations:
 - Continuous Migration Mode will not support this transformation
 - You will not be able to enable Data Verification when you create the Migration Job.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/150-image-002.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/150-image-002.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/60-edit-mapping-authors-alias.mdx b/docs/80-edit-mapping-rules/60-edit-mapping-authors-alias.mdx
@@ -10,5 +10,5 @@ We want to modify the MongoDB schema so that each author's aliases are represent
 - In the mapping rule's advanced settings, Check `create array of primitive values`.
 - Click `Save and close`.
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/110-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/110-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/70-edit-mapping-authors-authorbook.mdx b/docs/80-edit-mapping-rules/70-edit-mapping-authors-authorbook.mdx
@@ -16,5 +16,5 @@ We want to modify the authors collection so the array of books include just the
 - Click `Save and close`.
 
 
-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/120-image-001.png" alt="Screenshot of the connect modal" />
+<Screenshot url="http://127.0.0.1:8278" src="img/120-image-001.png" alt="Screenshot of the connect modal" />
 
diff --git a/docs/80-edit-mapping-rules/80-add-mapping-books-issue-detail.mdx b/docs/80-edit-mapping-rules/80-add-mapping-books-issue-detail.mdx
diff --git a/docs/80-edit-mapping-rules/90-add-mapping-issue-detail-users.mdx b/docs/80-edit-mapping-rules/90-add-mapping-issue-detail-users.mdx

Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ in your choice of programming langauge. This feature uses Artifical Intelligence`
`15`	`15`
`16`	`16`	`After a while, the equivalent MongoDB query will be shown at the right of the page.`
`17`	`17`
`18`		`-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/convert-sql-queries.png" alt="Screenshot of the connect modal" />`
	`18`	`+<Screenshot url="http://127.0.0.1:8278" src="img/convert-sql-queries.png" alt="Screenshot of the connect modal" />`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@ in your choice of programming langauge. This feature uses Artifical Intelligence`
`14`	`14`
`15`	`15`	`After a while, the equivalent MongoDB query will be shown at the right of the page. Try some other queries and langauges!`
`16`	`16`
`17`		`-<Screenshot url="https://www.mongodb.com/products/tools/relational-migrator" src="img/convert-sprocs.png" alt="Screenshot of the connect modal" />`
	`17`	`+<Screenshot url="http://127.0.0.1:8278" src="img/convert-sprocs.png" alt="Screenshot of the connect modal" />`
`18`	`18`