Merge docs-uplift feature branch into master (#246)

* DOCSP-47544 Update Relational Migrator ToC (#208)

* Initial ToC work and installation reorg

* Updates database connections section

* Revise Projects section

* Updates Data Modeling section

* Update Data Migration section

* Moves Kafka Deployment guide into prod installation guide

* Renames User Interface page

* Mark Containerized cluster as orphan page

* DOCSP-47550 updates docker installation instructions

* Revise warning wording

* Downgrades warning to note and revises wording

* DOCSP-48310 Fixes typos in oracle db configuration script (#220) (#221)

* DOCSP-47555 updates db connection pages (#209)

* DOCSP-47555 updates db connection pages

* Refactor mysql page

* Adds all UI locations for adding a connection

* Revisions based on feedback

* Moves some content to includes for reuse

* Try to replace a guilabel

* Try splitting procedure into reusable components

* Trying again

* Revise

* Fix chart rendering

* Move step 4 outside the include to fix rendering

* Update file location link for future IA

* Finalize format

* Revise intro

* Complete sentences

* Add scaffolding for all pages and init commit for oracle

* Add additional substitution to fix indef article in includes

* Adds postgres

* Adds sql server

* Fix sql server db preparation steps

* Adds db2

* Adds sybase

* Adds MongoDB

* Nest db configuration docs under connection pages

* Add about this task section

* Updates scenario and removes ambiguous ref targets

* Revert change to mysql setup permissions include

* Fixes bad refs

* Updates per modfac new joiner feedback

* Responds to internal review

* Fix c2c broken link

* DOCSP-47552 Updates the OS installation pages (#218)

* DOCSP-47552 initial commit

* Update deb install to incl changes in #216

* Update local installation version number formats

* Update debian server page

* Adds rhel server steps

* Update next steps to projects page

* Adds windows procedure

* Responds to internal feedback

* Update rhel bin sentence

* Expands RHEL to Red Hat Enterprise Linux

* DOCSP-47554 Update Connect to Databases landing page (#210)

* DOCSP-47554 update database connections landing page

* Revise page

* Fix typo

* Adds link to new additional options page

* Remove extra backtick

* Responds to internal review feedback

* Complete sentences

* Updates section heading and fixes punctuation

* Responds to ext feedback

* Updates toc label per best practices

* Rephrases migrator without db connection to emphasize visualize & model data

* Updates text for listed non-db options

* DOCSP-47547 update the getting started page (#211)

* DOCSP-47547 update the getting started page

* Small edit

* Update introductory text and ref labels

* Remove ambiguous ref labels

* Refactor migration scenarios

* Adds link to User Interface overview

* Responds to internal feedback

* Add missing space

* Fix continous migration section

* Updates compatiblity tables

* Updates feature order and wording per pmm feedback

* Adds jdbc dbs to supported migration types

* Remove link

* Updates destination to target

* commit

* remove

* commit

* active

* commit

* ref

* toml

* commit

* compatibility

* commit

* comma

* wow

* oops

* oops

* move section

* titles

* commit

* DOCSP-47559 updates the data modeling page (#215)

* DOCSP-47559 updates the data modeling page

* Re-order content for better flow

* Adds mention of refreshing rdb model

* Removes custom mapping heading

* Responds to internal feedback

* Moves mapping rules definition to page intro

* Responds to external feedback

* Fix link

* Fix link again

* DOCSP-47556 adds a page for using RM without a live connection (#232)

* DOCSP-47556 adds a page for using RM without a live connection

* Add new page to toc_landing_pages

* Revise wording

* Update DDL file ToC label

* Revise DDL page title

* removes comma

* DOCSP-47553 updates kafka install docs (#223)

* DOCSP-47553 updates kafka install docs

* Updates kafka user properties file instructions

* Updates user properties table widths

* Reverts changes to advanced settings

* Removes redundant paragraph

* Define what confluent cloud is

* Use Relational Migrator snooty constant

* DOCSP-47551 Update the Production Installation Guide (#228)

* Update tls language

* Updates the production install landing page to add detailed use cases

* Rephrase use case sentences from internal feedback

* Softens language based on ext feedback

* DOCSP-47549 updates developer installation guide (#229)

* ref

* commit

* vale

* edits

* feedback

* active

* feedback

* DOCSP-47557 Refactors projects section (#236)

* DOCSP-47557 Refactors projects section

* Revise landing page content

* Moves projects section based on PM feedback

* Remove plural

* Responds to comments

* Converts home guilabel to lg icon

* Update UL list spacing in application settings

* Small tweaks

* Responds to comments

* DOCSP-47566 Review Log In with Atlas (#238)

* refs

* DOCSP-48656 Updates Introduction page title to Overview (#240)

* DOCSP-47546 and DOCSP-47567 delete unused files and create redirects (#243)

* DOCSP-47546 and DOCSP-47567 delete unused files and create redirects

* Adds missed files from initial redirects

* Update references to pages that no longer exist

* Remove a missed file

* Fix bad link ref

* DOCSP-47548 Updates the installation page to include deployment considerations (#217)

* DOCSP-47548 Updates the installation page to include deployment considerations

* Updates recommendation table

* Update get started section to point to top level dev and prod install guides

* Combines description table and recommendations table

* Revise wording to be parallel and remove lists in tables

* Parallelism

* Revise intro para to match new table

* Remove intro para

* revise unattended server scenario

* Responds to internal feedback

* Update link text

* Revises deployment model table to include ext review feedback

* Test 4 column deployment model table

* Adds widths

* Fix confluent row

* Makes updates requested in review session

* Fixes vale errors

* Responds to RM eng team feedback

* Fixes vale error

* Small wording update

* Makes requested updates from internal re-review

* DOCSP-48624 documents oracle materialized view support in docs-uplift (#245)

* DOCSP-48624-uplift

* Revise tips

* Update source/mapping-rules/schema-mapping.txt

Co-authored-by: ltran-mdb2 <[email protected]>

* Update source/database-connections/oracle.txt

Co-authored-by: ltran-mdb2 <[email protected]>

---------

Co-authored-by: ltran-mdb2 <[email protected]>

* Fixes build errors

* Fixes database connection landing page issue

* Responds to comments pt1

* Fix db steps rendering

* Fix db steps rendering (again)

* Fix db steps rendering (again)

* Testing procedure rendering

* Testing procedure rendering

* mend

* revert db procedure changes

* Fix whitespace

* Responds to comments pt2

* Fixes build errors

* Responds to PM comments

---------

Co-authored-by: Maya Raman <[email protected]>
Co-authored-by: ltran-mdb2 <[email protected]>

Author: 3 people

config/redirects

@@ -54,3 +54,39 @@ define: versions master
 [*]: ${prefix}/prerequisites/postgres/ -> ${base}/jobs/prerequisites/postgres/
 [*]: ${prefix}/prerequisites/sql-server/ -> ${base}/jobs/prerequisites/sql-server/
 [*]: ${prefix}/prerequisites/sybase/ -> ${base}/jobs/prerequisites/sybase/
+
+# DOCSP-47567 redirect files deleted in the docs uplift project 
+## projects
+[*]: ${prefix}/projects/project-settings -> ${base}/installation/application-settings
+[*]: ${prefix}/projects/import-project -> ${base}/projects/manage-projects
+[*]: ${prefix}/projects/export-project -> ${base}/projects/manage-projects
+[*]: ${prefix}/projects/deleting-projects -> ${base}/projects/manage-projects
+[*]: ${prefix}/projects/renaming-project -> ${base}/projects/manage-projects
+## mapping rules
+[*]: ${prefix}/mapping-rules/new-rules-from-relational -> ${base}/mapping-rules/create-rules
+[*]: ${prefix}/mapping-rules/new-rules-to-mongodb -> ${base}/mapping-rules/create-rules
+## jobs
+[*]: ${prefix}/jobs/prerequisites -> ${base}/database-connections/database-connections
+## installation
+[*]: ${prefix}/installation/deployment-considerations -> ${base}/installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/debian-server-installation/debian-system-service -> ${base}/installation/install-on-an-unattended-server/debian-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/debian-server-installation/install-debian-server -> ${base}/installation/install-on-an-unattended-server/debian-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/rhel-centos-server-installation/install-rhel-server -> ${base}/installation/install-on-an-unattended-server/rhel-centos-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/rhel-centos-server-installation/rhel-system-service ->${base}/installation/install-on-an-unattended-server/rhel-centos-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/windows-server-installation/install-windows-server -> ${base}/installation/install-on-an-unattended-server/windows-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/windows-server-installation/windows-external-access -> ${base}/installation/install-on-an-unattended-server/windows-server-installation
+[*]: ${prefix}/installation/install-on-an-unattended-server/windows-server-installation/windows-system-service -> ${base}/installation/install-on-an-unattended-server/windows-server-installation
+## getting started
+[*]: ${prefix}/getting-started/migration-scenarios -> ${base}/getting-started
+[*]: ${prefix}/getting-started/supported-databases -> ${base}/getting-started
+## database connections
+[*]: ${prefix}/database-connections/save-mongodb-connection -> ${base}/database-connections/database-connections
+[*]: ${prefix}/database-connections/save-relational-connection -> ${base}/database-connections/database-connections
+## connection strings
+[*]: ${prefix}/connection-strings -> ${base}/database-connections/database-connections
+[*]: ${prefix}/connection-strings/mongodb-database-connection-strings -> ${base}/database-connections/database-connections
+[*]: ${prefix}/connection-strings/relational-database-connection-strings -> ${base}/database-connections/database-connections
+
+# DOCSP-48961 final review before merging docs-uplift into master
+[*]: ${prefix}/projects/create-project-sample-schema -> ${base}/database-connections/create-project-sample-schema
+[*]: ${prefix}/projects/create-project-loading-schema-files -> ${base}/database-connections/create-project-loading-schema-files

snooty.toml

@@ -13,17 +13,13 @@ toc_landing_pages = [
 "installation",
 "installation/install-on-a-local-machine",
 "installation/install-on-an-unattended-server",
-"installation/install-on-an-unattended-server/debian-server-installation",
-"installation/install-on-an-unattended-server/windows-server-installation",
-"installation/install-on-an-unattended-server/rhel-centos-server-installation",
 "installation/kafka-deployments/migrator-with-kafka",
-"installation/file-location",
-"database-connections/database-connections",
+"database-connections",
 "app-analysis",
 "projects",
 "mapping-rules/introduction",
 "mapping-rules/mapping-rule-options/introduction",
-"mapping-rules/fields/calculated-fields/calculated-fields",
+"mapping-rules/fields/calculated-fields",
 "mapping-rules/fields/field-customizations",
 "mapping-rules/synthetic-foreign-key/synthetic-foreign-keys",
 "table-filters",
@@ -38,16 +34,25 @@ toc_landing_pages = [
 "code-generation/query-converter",
 "diagrams/manage-diagrams",
 "getting-started",
-"jobs/prerequisites",
 "api-docs",
 "deployment-considerations",
 "code-generation/query-converter-test-queries",
-"code-generation/query-converter/query-management"
+"code-generation/query-converter/query-management",
+"database-connections/db2",
+"database-connections/mongodb",
+"database-connections/mysql",
+"database-connections/oracle",
+"database-connections/postgres",
+"database-connections/sql-server",
+"database-connections/sybase",
+"database-connections/migrator-without-live-connection"
 ]
 
 [constants]
 connector-version = "2.7.0"
 ddl = ":abbr:`DDL (Data Definition Language)`"
+mdb-rel-mig = "MongoDB Relational Migrator"
+rel-mig = "Relational Migrator"
 migrator-api = "REST API Documentation"
 migrator-api-endpoints = "Endpoints"
 

source/api-developer-reference.txt

@@ -0,0 +1,10 @@
+
+=========================
+API & Developer Reference
+=========================
+
+.. toctree::
+   :titlesonly:
+
+   {+migrator-api+} <api-docs>
+   File Locations <installation/file-location>

source/api-docs.txt

@@ -1,7 +1,7 @@
 .. _rm-rest-api:
 
 ============================
-Relational Migrator REST API
+{+rel-mig+} REST API
 ============================
 
 .. facet::
@@ -18,27 +18,27 @@ Relational Migrator REST API
    :depth: 1
    :class: singlecol
 
-The Relational Migrator REST API provides you with programmatic access 
+The {+rel-mig+} REST API provides you with programmatic access 
 to Relation Migrator with HTTPS endpoints. The REST API is a 
-Relational Migrator service between your application and your source and 
+{+rel-mig+} service between your application and your source and 
 destination databases that you can send requests to manage your migration jobs.
 
 You don't need to install any additional extensions or packages to use 
-the Relational Migrator REST API. The functionality is part of the 
-Relational Migrator product. The REST API runs on the same port that 
+the {+rel-mig+} REST API. The functionality is part of the 
+{+rel-mig+} product. The REST API runs on the same port that 
 you access the application on (either ``8278``, ``8080``, or ``443``).
 
 How the REST API Works
 ----------------------
 
-The Relational Migrator REST API runs on the client computer or server
-that has Relational Migrator installed. By default, Relational Migrator
+The {+rel-mig+} REST API runs on the client computer or server
+that has {+rel-mig+} installed. By default, {+rel-mig+}
 does not expose the API to any remote computers. If you use the default
 security settings, you must make all calls to the API on the same
-computer that you are running Relational Migrator on. 
+computer that you are running {+rel-mig+} on. 
 
 If you want to remotely access the REST API, configure the
-``unattended`` profile by :ref:`installing Relational Migrator on an
+``unattended`` profile by :ref:`installing {+rel-mig+} on an
 unattended server <unattended-server>`. 
 
 .. warning::
@@ -50,7 +50,7 @@ unattended server <unattended-server>`.
 When to Use REST API
 --------------------
 
-Use the Relational Migrator REST API when:
+Use the {+rel-mig+} REST API when:
 
 - You want to use a task scheduler such as 
   `CRON <https://en.wikipedia.org/wiki/Cron>`__ and define dynamic 
@@ -59,7 +59,7 @@ Use the Relational Migrator REST API when:
   ``WHERE DATEDIFF(CURDATE(), last_modified) <= 1`` to batch migrate 
   data on a cadence from your relational database to MongoDB. 
 
-- You want to programmatically create Relational Migrator migration jobs 
+- You want to programmatically create {+rel-mig+} migration jobs 
   dynamically. For example, using connection strings from 
   multiple databases without manually configuring them in the GUI.
 
@@ -68,7 +68,7 @@ Use the Relational Migrator REST API when:
 Learn More
 ----------
 
-For Relational Migrator REST API endpoints, example 
+For {+rel-mig+} REST API endpoints, example 
 requests, and responses, see :ref:`Endpoints <rm-api-resources-spec>`.
 
 .. toctree::

source/app-analysis.txt

@@ -43,7 +43,7 @@ For a list of all risks Relational Migrator reports on, see the
 Get Started
 -----------
 
-- :ref:`Connect to a Database <rm-save-relational-connection>`
+- :ref:`Connect to Databases <rm-database-connections>`
 - :ref:`Run Pre-Migration Analysis <rm-run-app-analysis>`
 
 .. toctree::

source/app-analysis/analysis-report.txt

@@ -128,8 +128,9 @@ Prerequisites
 
 The :guilabel:`Prerequisites` section lists necessary tasks to prepare your
 database for migration. This is a targeted list of recommendations based on the
-information gathered during Pre-Migration Analysis. For general information on
-database prerequisites, see :ref:`rm-prerequisites`.
+information gathered during Pre-Migration Analysis. For more information on
+prerequisites, see your database's specific documentation in the  
+:ref:`<rm-database-connections>` section.
 
 Resources
 ---------

source/code-generation.txt

@@ -10,8 +10,8 @@ Code Generation
    :depth: 1
    :class: singlecol
 
-Relational Migrator can help you convert your SQL and application code 
-to MongoDB. Use Relational Migrator's code generation features to 
+{+rel-mig+} can help you convert your SQL and application code 
+to MongoDB. Use {+rel-mig+}'s code generation features to 
 streamline the migration process.
 
 Use Cases

source/code-generation/generate-app-code.txt

@@ -11,7 +11,7 @@ Generate App Code
    :class: singlecol
 
 In a migration project, in addition to migrating data, you frequently 
-update or rewrite parts of your application code. Relational Migrator's 
+update or rewrite parts of your application code. {+rel-mig+}'s 
 Code Generation feature reduces the time and effort involved in this process.
 
 Relational Migration Code Generation analyzes MongoDB collections and 
@@ -35,7 +35,7 @@ Code Generation has the following options:
    * - Option
      - Description
    * - Language
-     - The programming language that Relational Migrator generates code files for.
+     - The programming language that {+rel-mig+} generates code files for.
    * - Template
      - Describes the types of artifacts that are generated in the chosen language.
 

source/code-generation/generate-app-code/download-all-code-files.txt

@@ -10,7 +10,7 @@ Download All Code Files
    :depth: 1
    :class: singlecol
 
-Code Generation is a feature built into Relational Migrator that helps
+Code Generation is a feature built into {+rel-mig+} that helps
 automatically generate code files for your applications connected 
 to MongoDB. This page details how to generate and download all code files into a zip file.
 

source/code-generation/generate-app-code/download-single-code-files.txt

@@ -10,7 +10,7 @@ Download Single Code Files
    :depth: 1
    :class: singlecol
 
-Code Generation is a feature built into Relational Migrator that helps
+Code Generation is a feature built into {+rel-mig+} that helps
 automatically generate code files for your applications connected 
 to MongoDB. This page details how to generate and download individual code files.
 

source/code-generation/query-converter-test-queries.txt

@@ -41,7 +41,7 @@ The :guilabel:`Test Queries` pane allows you to:
 Requirements
 ------------
 
-To test converted queries in Relational Migrator, 
+To test converted queries in {+rel-mig+}, 
 you must run the Query Runner Docker container. This 
 container can be run locally or hosted remotely. 
 For details, see :ref:`rm-install-query-runner`.

source/code-generation/query-converter.txt

@@ -11,7 +11,7 @@ Query Converter
    :class: singlecol
 
 Query Converter uses Generative AI to convert SQL statements, views, and stored
-procedures to MongoDB syntax. Relational Migrator considers the mapping 
+procedures to MongoDB syntax. {+rel-mig+} considers the mapping 
 rules and schema transformations defined in your project when converting
 your SQL code.
 

source/code-generation/query-converter/ai-and-data-usage-information.txt

@@ -75,7 +75,7 @@ MongoDB's backend and/or the third party AI provider:
   and data types.
 
 The information that is sent is not shared with any other third 
-parties or stored by the AI provider. Relational Migrator does not send 
+parties or stored by the AI provider. {+rel-mig+} does not send 
 database connection strings, credentials, or any raw data from your 
 databases.
 
@@ -92,4 +92,4 @@ Disable Query Converter
 Query Converter is only available if you :ref:`enable it <rm-enable-query-converter>`. 
 If you no longer want to use the feature, you can ignore it and no data 
 is sent to generative AI models. If needed, you can hide the 
-feature by clearing all browser data for the Relational Migrator host.
+feature by clearing all browser data for the {+rel-mig+} host.

source/code-generation/query-converter/convert-stored-procedures.txt

@@ -59,7 +59,8 @@ Steps
 
       a. Specify the connection details to your source database. 
 
-         For details, see :ref:`rm-relational-database-connection-strings`.
+         For details, see your database-specific connection page in :ref:`<rm-database-connections>`.
+         
       #. Click :guilabel:`Connect`.
 
    .. step:: Select stored procedures

source/code-generation/query-converter/convert-views.txt

@@ -52,7 +52,7 @@ Steps
 
      a. Specify the connection details to your source database. 
 
-        For details, see :ref:`rm-relational-database-connection-strings`.
+        For details, see your database-specific connection page in :ref:`<rm-database-connections>`.
 
      #. Click :guilabel:`Connect`.
 

source/code-generation/query-converter/enable-query-converter.txt

@@ -19,7 +19,7 @@ Before You Begin
 ----------------
 
 Before you can use Query Converter, you must sign in to your Atlas
-account in Relational Migrator. For details, see :ref:`rm-atlas-log-in`.
+account in {+rel-mig+}. For details, see :ref:`rm-atlas-log-in`.
 
 Steps
 -----

source/code-generation/query-converter/query-management.txt

@@ -10,7 +10,7 @@ Query Management
    :depth: 1
    :class: singlecol
 
-Relational Migrator provides various options for managing your 
+{+rel-mig+} provides various options for managing your 
 queries in Query Converter.
 
 Use Cases

source/code-generation/query-converter/refresh-database-objects.txt

@@ -35,7 +35,7 @@ Steps
 
       #. Specify the connection details to your source database. 
 
-         For details, see :ref:`rm-relational-database-connection-strings`.
+         For details, see your database-specific connection page in :ref:`<rm-database-connections>`.
 
          .. note::
 

source/code-generation/query-converter/test-converted-queries/compare-converted-queries.txt

@@ -12,7 +12,7 @@ Compare Converted Queries
 
 You can use the :guilabel:`Test Queries` pane to compare source 
 and destination queries, views, and stored procedure results 
-in Relational Migrator. The :guilabel:`Test Queries` can 
+in {+rel-mig+}. The :guilabel:`Test Queries` can 
 help you verify the accuracy of converted code and
 show the source and destination data after you run a migration job.
 
@@ -51,7 +51,7 @@ each user interface:
 Before you Begin
 ----------------
 
-- You must sign in to your Atlas account in Relational Migrator. 
+- You must sign in to your Atlas account in {+rel-mig+}. 
   For details, see :ref:`rm-atlas-log-in`.
 
 - For details on how to turn on Query Converter, see 

source/code-generation/query-converter/test-converted-queries/install-query-runner.txt

@@ -27,7 +27,7 @@ About this Task
 ---------------
 
 - If the version of Query Runner is different than the 
-  version of Relational Migrator, a warning banner displays.
+  version of {+rel-mig+}, a warning banner displays.
 
 - To update Query Runner to the latest version, run 
   the ``docker pull`` command from step number one.
@@ -79,7 +79,7 @@ Steps
                  For details on where the ``user.properties`` file is located, 
                  see :ref:`file-location`. 
 
-           #. After changing the ``user.properties`` file, restart Relational Migrator.
+           #. After changing the ``user.properties`` file, restart {+rel-mig+}.
 
            #. Launch the container from your remote server or container hosting service.