Skip to content

Commit c901dfd

Browse files
authored
DOCSP-30781 Add On This Page (#30)
* DOCSP-30781 Add On This Page
1 parent 5ee0420 commit c901dfd

File tree

12 files changed

+86
-11
lines changed

12 files changed

+86
-11
lines changed

source/code-generation/code-generation.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Code Generation
55
===============
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
In a migration project, in addition to migrating data, you frequently
814
update or rewrite parts of your application code. Relational Migrator's
915
Code Generation feature reduces the time and effort involved in this process.
@@ -74,8 +80,8 @@ Code Generation supports the following application templates:
7480
- Sample documents
7581
- Generates sample JSON documents that align to each collection's schema.
7682

77-
To learn how to download code files, see:
78-
83+
Get Started
84+
-----------
7985

8086
- :ref:`<rm-download-all-code-files>`
8187
- :ref:`<rm-download-single-code-file>`

source/connection-strings/connection-strings.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22
Connection Strings
33
==================
44

5+
.. contents:: On this page
6+
:local:
7+
:backlinks: none
8+
:depth: 1
9+
:class: singlecol
10+
511
Relational Migrator uses connection strings to connect to both
612
the relational and MongoDB databases. You can create connection strings:
713

814
- Using the UI when you create a project.
915
- Using the UI when you create a sync job.
1016
- By manually providing the Uniform Resource Identifier (URI).
1117

12-
To learn how to manually create your connection string URIs, see:
18+
Get Started
19+
-----------
1320

1421
- :ref:`rm-relational-database-connection-strings`
1522
- :ref:`rm-mongodb-database-connection-strings`

source/connection-strings/mongodb-database-connection-strings.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
MongoDB Database Connection Strings
55
===================================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
.. include:: /includes/uri-usage-disclaimer.rst
814

915
To start a migration job, Relational Migrator must connect to your MongoDB

source/connection-strings/relational-database-connection-strings.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Relational Database Connection Strings
55
======================================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
.. include:: /includes/uri-usage-disclaimer.rst
814

915
To analyze a schema or start a migration job, Relational Migrator must connect

source/diagrams/diagrams.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ rules.
3434
The relational view is unaffected by mapping rules, and only changes
3535
when you update your project's data model.
3636

37-
Learn More
38-
----------
37+
Get Started
38+
-----------
3939

4040
- :ref:`rm-understand-diagrams`
4141

source/diagrams/navigate-diagrams/navigate-diagrams.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Navigate Diagrams and Entities
55
==============================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
This page describes how to navigate your project's diagrams and
814
entities.
915

@@ -66,10 +72,10 @@ Multi-Select Mode, Relational Migrator highlights the box icon at the
6672
top of the diagram. When you release the shift key, Relational Migrator
6773
returns to Pan Mode.
6874

69-
Learn More
70-
----------
75+
Get Started
76+
-----------
7177

72-
:ref:`rm-apply-layout`
78+
- :ref:`rm-apply-layout`
7379

7480
.. toctree::
7581
:hidden:

source/diagrams/navigate-diagrams/working-with-entities/working-with-entities.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Working with Entities
55
=====================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
After you :ref:`create a project <rm-create-project-live>`, Relational Migrator creates an
814
initial diagram containing the entities and relationships in
915
the Relational and MongoDB models. The term "entity" refers to either a table in

source/jobs/data-verification/data-verification.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Data Verification
55
=================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
Data verification is a process that is built into the sync engine.
814
The data verification process uses the source and destination
915
connection strings to validate that a sync job was successful.
@@ -32,10 +38,10 @@ destination databases:
3238
- The data in the relational database tables has changed since the sync
3339
job was started.
3440

35-
Learn More
36-
----------
41+
Get Started
42+
-----------
3743

38-
:ref:`rm-use-data-verification`
44+
- :ref:`rm-use-data-verification`
3945

4046
.. toctree::
4147
:titlesonly:

source/jobs/sync-jobs.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Sync Jobs
55
=========
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
Sync jobs transfer data from your relational database to MongoDB. Sync
814
jobs use project-level :ref:`rm-mapping-rules` to distribute data to
915
your MongoDB database.

source/mapping-rules/mapping-rule-options/mapping-rule-options.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Mapping Rule Options
55
====================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
Mapping rule options are important options that help define the state
814
of your MongoDB collection after a migration.
915

0 commit comments

Comments
 (0)