Skip to content

Commit 43f5376

Browse files
jason-price-mongodbjason-price-mongodb
authored
Merge pull request #66 from ianf-mongodb/DOCS-16498
DOCS-16498 Add Getting Started Page
2 parents 01eea4b + e4e5025 commit 43f5376

File tree

9 files changed

+180
-9
lines changed

9 files changed

+180
-9
lines changed

‎config/redirects

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ define: versions master
1818
[*]: ${prefix}/code-generation/code-generation/ -> ${base}/relational-migrator/code-generation/
1919
# Prep Code Generation end
2020

21+
# DOCS-16498 Getting Started Page Start
22+
[*]: ${prefix}/migration-scenarios/ -> ${base}/getting-started/migration-scenarios/
23+
[*]: ${prefix}/supported-databases/ -> ${base}/getting-started/supported-databases/
24+
# DOCS-16498 Getting Started Page End

‎snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ toc_landing_pages = [
3434
"code-generation/generate-app-code",
3535
"code-generation/query-converter",
3636
"diagrams/manage-diagrams",
37+
"getting-started",
3738
"prerequisites"
3839
]
3940

‎source/code-generation/query-converter/atlas-log-in.txt

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
.. _rm-atlas-log-in:
2+
3+
=================
4+
Log In with Atlas
5+
=================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can sign in to your Atlas account inside Relational Migrator. When
14+
you log in with your Atlas account in Relational Migrator, you can
15+
access the :ref:`Query Converter <rm-query-converter>` feature.
16+
17+
Before you Begin
18+
----------------
19+
20+
To log in with Atlas, you must have an existing :atlas:`Atlas account
21+
</tutorial/create-atlas-account>` and a
22+
:atlas:`deployment </create-connect-deployments>`.
23+
24+
About this Task
25+
---------------
26+
27+
- To log in with your Atlas account, Relational Migrator must be running
28+
on localhost on one of the following ports:
29+
30+
- ``8278``
31+
- ``8080``
32+
- ``443``
33+
34+
- If you run Relational Migrator on ports not listed above,
35+
the sign-in process fails.
36+
37+
- You might need to reauthenticate when your session token expires. To
38+
reauthenticate to your Atlas account, follow the same log in procedure
39+
below.
40+
41+
Steps
42+
-----
43+
44+
.. procedure::
45+
:style: normal
46+
47+
.. step:: Select log in option
48+
49+
On the top right of the Relational Migrator home screen, click
50+
the profile icon or the :guilabel:`Log in` button. The account
51+
login modal displays. Click the :icon-lg:`LogIn`
52+
:guilabel:`Log in with Atlas` button.
53+
54+
.. tip::
55+
56+
You can also initiate the log in process from the
57+
:guilabel:`Code Generation` tab by clicking the
58+
:icon-lg:`LogIn` :guilabel:`Log in with Atlas` button on the
59+
:guilabel:`Query Converter` pane.
60+
61+
.. step:: Enter your Atlas account credentials
62+
63+
Enter your :guilabel:`Email Address` and :guilabel:`Password`,
64+
then click :guilabel:`Log in`.
65+
66+
.. step:: (Optional) Log out of Atlas account
67+
68+
Click on the profile icon on the top right and click
69+
:icon-lg:`LogOut` :guilabel:`Log Out` to log out of your Atlas
70+
account.
71+
72+
Next Steps
73+
----------
74+
75+
- :ref:`rm-enable-query-converter`
76+
- :ref:`rm-convert-queries`
77+
78+
Learn More
79+
----------
80+
81+
- :atlas:`Create an Atlas Cluster </create-database-deployment/#clusters>`

‎source/connection-strings/connection-strings.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _rm-connection-strings:
2+
13
==================
24
Connection Strings
35
==================

‎source/getting-started.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _relational-migrator-get-started:
2+
3+
====================================
4+
Get Started with Relational Migrator
5+
====================================
6+
7+
.. facet::
8+
:name: genre
9+
:values: tutorial
10+
11+
.. meta::
12+
:description: MongoDB Relational Migrator is a tool to help you migrate your relational workloads to MongoDB.
13+
:keywords: database migration, database conversion
14+
15+
.. contents:: On this page
16+
:local:
17+
:backlinks: none
18+
:depth: 1
19+
:class: singlecol
20+
21+
Relational Migrator is a tool to help you migrate your relational
22+
data to MongoDB. This page guides you through installing the tool
23+
and running your first sync job.
24+
25+
To get familiar with Relational Migrator capabilities,
26+
features, and use cases, review the following resources:
27+
28+
- :ref:`<supported-databases>`
29+
- :ref:`<rm-migration-scenarios>`
30+
- `Relational Migrator Learning Byte <https://learn.mongodb.com/courses/mongodb-relational-migrator>`__
31+
32+
Steps
33+
-----
34+
35+
.. procedure::
36+
37+
.. step:: Install
38+
39+
You can install Relational Migrator with a
40+
:ref:`single machine install <single-machine-install>` suitable
41+
for testing or a :ref:`unattended server install <unattended-server>`
42+
for production workloads.
43+
44+
.. step:: Create a project
45+
46+
To start using Relational Migrator,
47+
:ref:`create a project <rm-projects>`. Projects hold the
48+
settings, schema conversion logic, and table mappings for a
49+
migration. You can connect your
50+
source and destination databases with the appropriate
51+
:ref:`connection strings <rm-connection-strings>`.
52+
53+
.. step:: Create mapping rules with suggested mappings
54+
55+
Use :ref:`suggested mappings<rm-new-rules-from-mappings>` to
56+
create initial mapping rules based on your
57+
relational schema. Mapping rules specify how data from each
58+
relational table migrates to MongoDB and how columns map to
59+
fields in MongoDB documents.
60+
61+
.. step:: Customize your mapping rules
62+
63+
Add or update :ref:`mapping rules <rm-mapping-rules>` to create
64+
the destination data model that best matches your
65+
application needs.
66+
67+
.. step:: Create a sync job
68+
69+
:ref:`Sync jobs <rm-sync-jobs>` move the data from relational
70+
tables to MongoDB collections. Sync jobs have two types:
71+
72+
- **Snapshot** for point in time migrations.
73+
- **Continuous** for ongoing change data capture zero-downtime migrations.
74+
75+
To start your migration to MongoDB,
76+
:ref:`create a sync job <rm-create-jobs>`.
77+
78+
.. toctree::
79+
:titlesonly:
80+
:hidden:
81+
82+
/getting-started/supported-databases
83+
/getting-started/migration-scenarios

‎source/migration-scenarios.txt renamed to ‎source/getting-started/migration-scenarios.txt

File renamed without changes.

‎source/supported-databases.txt renamed to ‎source/getting-started/supported-databases.txt

File renamed without changes.

‎source/includes/fact-relational-migrator-intro.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
MongoDB Relational Migrator is a tool to help you migrate relational workloads to MongoDB.
2+
Relational Migrator allows you to:
3+
4+
- Design an effective MongoDB schema derived from an existing relational schema.
5+
- Migrate data from Oracle, SQL Server, MySQL, PostgreSQL, or Sybase ASE
6+
to MongoDB, while transforming to the target schema.
7+
- Generate code artifacts to reduce the time required to update application code.

‎source/index.txt

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,7 @@ What is Relational Migrator
88

99
.. introduction::
1010

11-
MongoDB Relational Migrator is a tool to help you migrate relational workloads to MongoDB.
12-
Relational Migrator allows you to:
13-
14-
- Design an effective MongoDB schema, derived from an existing relational schema.
15-
- Migrate data from Oracle, SQL Server, MySQL, PostgreSQL, or Sybase ASE to MongoDB,
16-
while transforming to the target schema.
17-
- Generate code artifacts to reduce the time required to update application code.
11+
.. include:: /includes/fact-relational-migrator-intro.rst
1812

1913
|
2014

@@ -150,8 +144,7 @@ Explore libraries and tools for MongoDB.
150144
:titlesonly:
151145
:hidden:
152146

153-
/supported-databases
154-
/migration-scenarios
147+
/getting-started
155148
/installation
156149
/prerequisites
157150
/projects/projects

0 commit comments

Comments
 (0)