diff --git a/docs/100-toggle-view.mdx b/docs/100-toggle-view.mdx new file mode 100644 index 0000000..34da514 --- /dev/null +++ b/docs/100-toggle-view.mdx @@ -0,0 +1,8 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Toggle View + +At the bottom left, toggle between different views, we should be looking at the MDB view most of the time + + + diff --git a/docs/110-edit-mapping-authors-alias.mdx b/docs/110-edit-mapping-authors-alias.mdx new file mode 100644 index 0000000..acde221 --- /dev/null +++ b/docs/110-edit-mapping-authors-alias.mdx @@ -0,0 +1,14 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to authors collection (author_alias) + + +- On the ERD, click authors +- On the relational mappings list on the right, click on the edit icon of author_alias +- Rename Field name to alias +- In the list of fields, uncheck authorId +- Check create array of primitive values +- Click Save and close + + + diff --git a/docs/120-edit-mapping-authors-book.mdx b/docs/120-edit-mapping-authors-book.mdx new file mode 100644 index 0000000..4009fdd --- /dev/null +++ b/docs/120-edit-mapping-authors-book.mdx @@ -0,0 +1,15 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to authors collection (author_book) + + +- On the ERD, click authors +- On the relational mappings list on the right, click on the edit icon of author_book +- Rename Field name to alias +- In the list of fields, uncheck authorId +- Check create array of primitive values +- Click Save and close + + + + diff --git a/docs/130-edit-mapping-books-authors.mdx b/docs/130-edit-mapping-books-authors.mdx new file mode 100644 index 0000000..ddd8b01 --- /dev/null +++ b/docs/130-edit-mapping-books-authors.mdx @@ -0,0 +1,17 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to books collection (authors) + +- On the ERD, click books +- On the relational mappings list on the right, click +Add +- Select Embedded documents +- Select authors as Source table +- Check Merge fields into the parent +- Rename id field to _id +- Check name field and uncheck the rest +- Click Save and close +- We have embedded authors in the authorBooks field + + + + diff --git a/docs/140-edit-mapping-books-author-book.mdx b/docs/140-edit-mapping-books-author-book.mdx new file mode 100644 index 0000000..ccacdb0 --- /dev/null +++ b/docs/140-edit-mapping-books-author-book.mdx @@ -0,0 +1,15 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to books collection (author_book) + +- On the ERD, click `books` +- On the relational mappings list on the right, click on the edit icon of `author_book` +- Rename `Field name` to `authors` +- In the list of fields, uncheck `authorId` +- Uncheck all fields +- Click `Save and close` + + + + + diff --git a/docs/150-edit-mapping-books-book-attribute.mdx b/docs/150-edit-mapping-books-book-attribute.mdx new file mode 100644 index 0000000..6feac32 --- /dev/null +++ b/docs/150-edit-mapping-books-book-attribute.mdx @@ -0,0 +1,14 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to books collection (book_attribute) + + +- On the ERD, click books +- On the relational mappings list on the right, click on the edit icon of book_attribute +- Rename Field name to attributes +- Uncheck bookId +- Click Save and close + + + + diff --git a/docs/160-edit-mapping-books-book-genre.mdx b/docs/160-edit-mapping-books-book-genre.mdx new file mode 100644 index 0000000..8fa7eef --- /dev/null +++ b/docs/160-edit-mapping-books-book-genre.mdx @@ -0,0 +1,16 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to books collection (book_genre) + + +- On the ERD, click books +- On the relational mappings list on the right, click on the edit icon of book_genre +- Rename Field name to genres +- Check create array of primitive values +- Uncheck bookId +- Click Save and close + + + + + diff --git a/docs/170-edit-mapping-books-issue-detail.mdx b/docs/170-edit-mapping-books-issue-detail.mdx new file mode 100644 index 0000000..7beb219 --- /dev/null +++ b/docs/170-edit-mapping-books-issue-detail.mdx @@ -0,0 +1,17 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to issueDetails collection (books) + + + +- On the ERD, click issueDetails +- On the relational mappings list on the right, click +Add +- Select Embedded documents +- Select books as Source table +- Rename id field to _id +- Check title field and uncheck the rest +- Click Save and close +- We have embedded a book document in the book field + + + diff --git a/docs/180-edit-mapping-issue-detail-users.mdx b/docs/180-edit-mapping-issue-detail-users.mdx new file mode 100644 index 0000000..d4907cb --- /dev/null +++ b/docs/180-edit-mapping-issue-detail-users.mdx @@ -0,0 +1,18 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to issueDetails collection (users) + + + +- On the ERD, click issueDetails +- On the relational mappings list on the right, click +Add +- Select Embedded documents +- Select users as Source table +- Rename id field to _id +- Check name field and uncheck the rest +- Click Save and close +- We have embedded a user document in the user field + + + + diff --git a/docs/190-edit-mapping-issue-detail-issue-detail.mdx b/docs/190-edit-mapping-issue-detail-issue-detail.mdx new file mode 100644 index 0000000..87595cc --- /dev/null +++ b/docs/190-edit-mapping-issue-detail-issue-detail.mdx @@ -0,0 +1,16 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to issueDetails collection (issue_details) + + + + +- On the ERD, click books +- On the relational mappings list on the right, click on the edit icon of issue_details +- Check all fields except bookId and userId +- Click Save and close + + + + + diff --git a/docs/200-edit-mapping-reviews-user copy.mdx b/docs/200-edit-mapping-reviews-user copy.mdx new file mode 100644 index 0000000..b91e303 --- /dev/null +++ b/docs/200-edit-mapping-reviews-user copy.mdx @@ -0,0 +1,18 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Edit mapping to reviews collection (users) + +- On the ERD, click reviews +- On the relational mappings list on the right, click +Add +- Select Embedded documents +- Select users as Source table +- Check Merge fields into the parent with root as the Prefix +- Rename id field to _id +- Only check name field +- Click Save and close +- We have embedded a user document at the root level + + + + + diff --git a/docs/210-migration.mdx b/docs/210-migration.mdx new file mode 100644 index 0000000..984d9ee --- /dev/null +++ b/docs/210-migration.mdx @@ -0,0 +1,17 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Migration + +- At the top, switch to Data Migration tab +- Click create sync job +- Add source DB connection details +- Add MongoDB connection details +- Run Start + + + + + + + + diff --git a/docs/30-schema-in-postgresql.mdx b/docs/30-schema-in-postgresql.mdx new file mode 100644 index 0000000..ef3b6d4 --- /dev/null +++ b/docs/30-schema-in-postgresql.mdx @@ -0,0 +1,5 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Schema in Postgresql + + diff --git a/docs/40-desired-schema-mongodb.mdx b/docs/40-desired-schema-mongodb.mdx new file mode 100644 index 0000000..2eeeb7b --- /dev/null +++ b/docs/40-desired-schema-mongodb.mdx @@ -0,0 +1,5 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Desired Schema in MongoDB + + diff --git a/docs/50-create-new-project.mdx b/docs/50-create-new-project.mdx new file mode 100644 index 0000000..2e1f05b --- /dev/null +++ b/docs/50-create-new-project.mdx @@ -0,0 +1,14 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Creating a New Project + + + +## Click on New Project + + + + +## Click Connect database + + diff --git a/docs/60-connect-database.mdx b/docs/60-connect-database.mdx new file mode 100644 index 0000000..ab6bff6 --- /dev/null +++ b/docs/60-connect-database.mdx @@ -0,0 +1,8 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Connect Database + +Enter database configurations and click Test Connection +Click Connect to proceed to the next step + + diff --git a/docs/60-starting-the-relational-db.mdx b/docs/60-starting-the-relational-db.mdx deleted file mode 100644 index c6b0ccb..0000000 --- a/docs/60-starting-the-relational-db.mdx +++ /dev/null @@ -1,3 +0,0 @@ -# 📦 Starting the Relational Database - -## \ No newline at end of file diff --git a/docs/70-select-tables.mdx b/docs/70-select-tables.mdx new file mode 100644 index 0000000..619861d --- /dev/null +++ b/docs/70-select-tables.mdx @@ -0,0 +1,7 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Select Tables + +Check all + + diff --git a/docs/80-define-initial-schema.mdx b/docs/80-define-initial-schema.mdx new file mode 100644 index 0000000..fc5818a --- /dev/null +++ b/docs/80-define-initial-schema.mdx @@ -0,0 +1,14 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Define Initial Schema + +Select “Start with a recommended MongoDB schema” +Select the five collections that we want: +authors +books +issue_detials +reviews +users + + + diff --git a/docs/90-project-settings.mdx b/docs/90-project-settings.mdx new file mode 100644 index 0000000..29c5ffd --- /dev/null +++ b/docs/90-project-settings.mdx @@ -0,0 +1,12 @@ +import Screenshot from "@site/src/components/Screenshot"; + +# Project Settings + + +- On the top left, click settings icon +- Select single inherited primary key. This detects the primary key from the relational schema and sets them as the _id in MongoDB +- Optionally, toggle Suggested Mappings on and off. + + + + diff --git a/docs/summary.mdx b/docs/summary.mdx index 759a981..ad71992 100644 --- a/docs/summary.mdx +++ b/docs/summary.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 100 +sidebar_position: 1000 --- # 🎯 Summary diff --git a/static/img/100-image-001.png b/static/img/100-image-001.png new file mode 100644 index 0000000..47ba955 Binary files /dev/null and b/static/img/100-image-001.png differ diff --git a/static/img/110-image-001.png b/static/img/110-image-001.png new file mode 100644 index 0000000..8364c7a Binary files /dev/null and b/static/img/110-image-001.png differ diff --git a/static/img/120-image-001.png b/static/img/120-image-001.png new file mode 100644 index 0000000..f8bd1d7 Binary files /dev/null and b/static/img/120-image-001.png differ diff --git a/static/img/130-image-001.png b/static/img/130-image-001.png new file mode 100644 index 0000000..4bd2591 Binary files /dev/null and b/static/img/130-image-001.png differ diff --git a/static/img/140-image-001.png b/static/img/140-image-001.png new file mode 100644 index 0000000..7aa37a2 Binary files /dev/null and b/static/img/140-image-001.png differ diff --git a/static/img/150-image-001.png b/static/img/150-image-001.png new file mode 100644 index 0000000..fd2bb5b Binary files /dev/null and b/static/img/150-image-001.png differ diff --git a/static/img/160-image-001.png b/static/img/160-image-001.png new file mode 100644 index 0000000..7090a0b Binary files /dev/null and b/static/img/160-image-001.png differ diff --git a/static/img/170-image-001.png b/static/img/170-image-001.png new file mode 100644 index 0000000..216bcf0 Binary files /dev/null and b/static/img/170-image-001.png differ diff --git a/static/img/180-image-001.png b/static/img/180-image-001.png new file mode 100644 index 0000000..ab6d81e Binary files /dev/null and b/static/img/180-image-001.png differ diff --git a/static/img/190-image-001.png b/static/img/190-image-001.png new file mode 100644 index 0000000..263a5d8 Binary files /dev/null and b/static/img/190-image-001.png differ diff --git a/static/img/200-image-001.png b/static/img/200-image-001.png new file mode 100644 index 0000000..91f10ac Binary files /dev/null and b/static/img/200-image-001.png differ diff --git a/static/img/210-image-001.png b/static/img/210-image-001.png new file mode 100644 index 0000000..a9ec1d4 Binary files /dev/null and b/static/img/210-image-001.png differ diff --git a/static/img/210-image-002.png b/static/img/210-image-002.png new file mode 100644 index 0000000..d6d7e32 Binary files /dev/null and b/static/img/210-image-002.png differ diff --git a/static/img/210-image-003.png b/static/img/210-image-003.png new file mode 100644 index 0000000..5303acf Binary files /dev/null and b/static/img/210-image-003.png differ diff --git a/static/img/210-image-004.png b/static/img/210-image-004.png new file mode 100644 index 0000000..37b5443 Binary files /dev/null and b/static/img/210-image-004.png differ diff --git a/static/img/30-image-001.png b/static/img/30-image-001.png new file mode 100644 index 0000000..da86ee6 Binary files /dev/null and b/static/img/30-image-001.png differ diff --git a/static/img/40-image-001.png b/static/img/40-image-001.png new file mode 100644 index 0000000..a2f4523 Binary files /dev/null and b/static/img/40-image-001.png differ diff --git a/static/img/50-image-001.png b/static/img/50-image-001.png new file mode 100644 index 0000000..81be4de Binary files /dev/null and b/static/img/50-image-001.png differ diff --git a/static/img/50-image-002.png b/static/img/50-image-002.png new file mode 100644 index 0000000..61635b0 Binary files /dev/null and b/static/img/50-image-002.png differ diff --git a/static/img/60-image-001.png b/static/img/60-image-001.png new file mode 100644 index 0000000..b0d47e2 Binary files /dev/null and b/static/img/60-image-001.png differ diff --git a/static/img/70-image-001.png b/static/img/70-image-001.png new file mode 100644 index 0000000..44869ef Binary files /dev/null and b/static/img/70-image-001.png differ diff --git a/static/img/80-image-001.png b/static/img/80-image-001.png new file mode 100644 index 0000000..9e3bc79 Binary files /dev/null and b/static/img/80-image-001.png differ diff --git a/static/img/90-image-001.png b/static/img/90-image-001.png new file mode 100644 index 0000000..71e329b Binary files /dev/null and b/static/img/90-image-001.png differ