Add 'content/relational-migrator/' from commit '65a9ebfdfd4c8164503082f0f24785dad9f78381'

git-subtree-dir: content/relational-migrator
git-subtree-mainline: 7e01892
git-subtree-split: 65a9ebf

Author: anabellabuckvar

content/relational-migrator/.github/pull_request_template.md

@@ -0,0 +1,23 @@
+## DESCRIPTION
+
+
+## STAGING
+
+
+## JIRA
+
+
+## BUILD LOG
+
+
+## Self-Review Checklist
+
+- [ ] Is this free of any warnings or errors in the RST?
+- [ ] Is this free of spelling errors?
+- [ ] Is this free of grammatical errors?
+- [ ] Is this free of staging / rendering issues?
+- [ ] Are all the links working?
+
+## External Review Requirements
+
+[What's expected of an external reviewer?](https://wiki.corp.mongodb.com/display/DE/Reviewing+Guidelines+for+the+MongoDB+Server+Documentation)

content/relational-migrator/.github/workflows/generate-bump-pages.yml

@@ -0,0 +1,52 @@
+name: Check & deploy API documentation
+
+on:
+  # For deployments
+  workflow_dispatch: # Allow manual trigger in case of quick fix
+  push:
+    branches:
+      - master
+    paths:
+      - 'source/rm-openapi-latest.json'
+
+  # For previews
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'source/rm-openapi-latest.json'
+
+permissions:
+  contents: read
+
+jobs:
+  deploy-doc:
+    if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
+    name: Deploy API documentation on Bump.sh
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Deploy API documentation
+        uses: bump-sh/github-action@59eaae922e81ac8d127bd2b2ac6dc4804bda8a4c
+        with:
+          doc: ${{vars.RM_DOC_ID}}
+          token: ${{secrets.BUMP_TOKEN}}
+          file: source/rm-openapi-latest.json
+          branch: main
+  
+  api-preview:
+    if: ${{ github.event_name == 'pull_request' }}
+    name: Create API preview on Bump.sh
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Create API preview
+        uses: bump-sh/github-action@59eaae922e81ac8d127bd2b2ac6dc4804bda8a4c
+        with:
+          doc: ${{vars.RM_DOC_ID}}
+          token: ${{secrets.BUMP_TOKEN}}
+          file: source/rm-openapi-latest.json
+          branch: main
+          command: preview

content/relational-migrator/.github/workflows/vale-tdbx.yml

@@ -0,0 +1,45 @@
+name: vale-checks
+on:
+  pull_request:
+    paths:
+      - "source/**"
+
+jobs:
+  vale:
+    name: TDBX Vale rules
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: checkout
+        uses: actions/checkout@master
+
+      - name: Install docutils
+        run: sudo apt-get install -y docutils
+
+      - id: files
+        uses: masesgroup/retrieve-changed-files@v2
+        with:
+          format: 'csv'
+
+      - name: checkout-latest-rules
+        uses: actions/checkout@master
+        with:
+          repository: mongodb/mongodb-vale-action
+          path: './tdbx-vale-rules'
+          token: ${{secrets.GITHUB_TOKEN}}
+
+      - name: move-files-for-vale-action
+        run: |
+            cp tdbx-vale-rules/.vale.ini .vale.ini
+            mkdir -p .github/styles/
+            cp -rf tdbx-vale-rules/.github/styles/ .github/
+
+      - name: run-vale
+        uses: errata-ai/vale-action@reviewdog
+        with:
+          reporter: github-pr-check
+          files: ${{steps.files.outputs.added_modified}}
+          fail_on_error: true
+          token: ${{secrets.GITHUB_TOKEN}}

content/relational-migrator/.gitignore

@@ -0,0 +1 @@
+.DS_Store

content/relational-migrator/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "esbonio.sphinx.confDir": ""
+}

content/relational-migrator/README.md

@@ -0,0 +1,18 @@
+# docs-app-services
+
+[Your words here].
+
+## Report Issues
+
+To file issues or requests regarding the documentation, go to the
+`Documentation Jira Project <https://jira.mongodb.org/browse/DOCS>`_.
+
+## License
+
+All documentation is available under the terms of a `Creative Commons
+License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
+
+If you have any questions, please contact `[email protected]
+<mailto:[email protected]>`_.
+
+-- The MongoDB Documentation Team

content/relational-migrator/build.sh

@@ -0,0 +1,7 @@
+# ensures that we always use the latest version of the script
+if [ -f build-site.sh ]; then
+  rm build-site.sh
+fi 
+
+curl https://raw.githubusercontent.com/mongodb/docs-worker-pool/netlify-poc/scripts/build-site.sh -o build-site.sh 
+sh build-site.sh

content/relational-migrator/config/redirects

@@ -0,0 +1,92 @@
+define: prefix docs/relational-migrator
+define: base https://www.mongodb.com/docs/relational-migrator
+define: versions master
+
+# raw: <source file> -> ${base}/<destination>
+
+# DOCSP-32370 - Field Customizations moved under new drawer page
+[*]: ${prefix}/mapping-rules/calculated-fields/calculated-fields -> ${base}/mapping-rules/fields/calculated-fields/calculated-fields/
+[*]: ${prefix}/mapping-rules/calculated-fields/calculated-fields/add-calculated-fields -> ${base}/mapping-rules/fields/calculated-fields/calculated-fields/add-calculated-fields
+[*]: ${prefix}/mapping-rules/calculated-fields/calculated-fields/view-calculated-fields -> ${base}/mapping-rules/fields/calculated-fields/calculated-fields/view-calculated-fields
+[*]: ${prefix}/mapping-rules/calculated-fields/calculated-fields/edit-calculated-fields -> ${base}/mapping-rules/fields/calculated-fields/calculated-fields/edit-calculated-fields
+[*]: ${prefix}/mapping-rules/calculated-fields/calculated-fields/delete-calculated-fields -> ${base}/mapping-rules/fields/calculated-fields/calculated-fields/delete-calculated-fields
+
+# DOCSP-33055 - Prep Code Generation
+[*]: ${prefix}/code-generation/code-generation/ -> ${base}/code-generation/
+
+# DOCS-16498 Getting Started page
+[*]: ${prefix}/migration-scenarios/ -> ${base}/getting-started/migration-scenarios/
+[*]: ${prefix}/supported-databases/ -> ${base}/getting-started/supported-databases/
+
+# DOCSP-46660 repetitive paths
+[*]: ${prefix}/diagrams/diagrams/ -> ${base}/diagrams/
+[*]: ${prefix}/diagrams/navigate-diagrams/navigate-diagrams/ -> ${base}/diagrams/navigate-diagrams/
+[*]: ${prefix}/connection-strings/connection-strings/ -> ${base}/connection-strings/
+
+# DOCSP-46661 repetitive paths
+[*]: ${prefix}/diagrams/navigate-diagrams/working-with-entities/working-with-entities/ -> ${base}/diagrams/navigate-diagrams/working-with-entities/
+[*]: ${prefix}/installation/install-on-a-local-machine/install-on-a-local-machine/ -> ${base}/installation/install-on-a-local-machine/
+
+# DOCSP-46662 repetitive paths
+[*]: ${prefix}/installation/install-on-an-unattended-server/debian-server-installation/debian-server-installation/ -> ${base}/installation/install-on-an-unattended-server/debian-server-installation/
+[*]: ${prefix}/installation/install-on-an-unattended-server/install-on-an-unattended-server/ -> ${base}/installation/install-on-an-unattended-server/
+
+# DOCSP-46663 repetitive paths
+[*]: ${prefix}/installation/install-on-an-unattended-server/rhel-centos-server-installation/rhel-centos-server-installation/ -> ${base}/installation/install-on-an-unattended-server/rhel-centos-server-installation/
+[*]: ${prefix}/installation/install-on-an-unattended-server/windows-server-installation/windows-server-installation/ -> ${base}/installation/install-on-an-unattended-server/windows-server-installation/
+
+# DOCSP-46664 repetitive paths
+[*]: ${prefix}/jobs/data-verification/data-verification/ -> ${base}/jobs/data-verification/
+[*]: ${prefix}/mapping-rules/fields/calculated-fields/calculated-fields/ -> ${base}/mapping-rules/fields/calculated-fields/
+
+# DOCSP-46665 repetitive paths
+[*]: ${prefix}/mapping-rules/mapping-rule-options/mapping-rule-options/ -> ${base}/mapping-rules/mapping-rule-options/introduction/
+[*]: ${prefix}/mapping-rules/mapping-rules/ -> ${base}/mapping-rules/introduction/
+
+# DOCSP-46666 repetitive paths
+[*]: ${prefix}/projects/projects/ -> ${base}/projects/
+[*]: ${prefix}/table-filters/table-filters/ -> ${base}/table-filters/
+
+# DOCSP-47252 redirect pre-requisites pages moved in PR#104
+[*]: ${prefix}/prerequisites/ -> ${base}/jobs/prerequisites/
+[*]: ${prefix}/prerequisites/my-sql/ -> ${base}/jobs/prerequisites/my-sql/
+[*]: ${prefix}/prerequisites/oracle/ -> ${base}/jobs/prerequisites/oracle/
+[*]: ${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
+## 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
+[*]: ${prefix}/database-connections/save-relational-connection -> ${base}/database-connections
+## connection strings
+[*]: ${prefix}/connection-strings -> ${base}/database-connections
+[*]: ${prefix}/connection-strings/mongodb-database-connection-strings -> ${base}/database-connections
+[*]: ${prefix}/connection-strings/relational-database-connection-strings -> ${base}/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

content/relational-migrator/netlify.toml

@@ -0,0 +1,27 @@
+[[integrations]]
+name = "snooty-cache-plugin"
+
+[build]
+publish = "snooty/public"
+command = ". ./build.sh"
+
+# Redirect calculated fields to new drawer introduced in DOCSP-32370 - Field Customizations
+# Field Customization
+[[redirects]]
+from = "/mapping-rules/calculated-fields/*"
+to = "/mapping-rules/fields/calculated-fields/:splat"
+
+# Redirect for previous Code Generation Page DOCSP-33055 - Prep Code Generation
+[[redirects]]
+from = "/code-generation/code-generation"
+to = "/code-generation"
+
+# DOCS-16498 Getting Started Page Start
+[[redirects]]
+from = "/migration-scenarios"
+to = "/getting-started/migration-scenarios"
+
+[[redirects]]
+from = "/supported-databases"
+to = "/getting-started/supported-databases"
+

content/relational-migrator/snooty.toml

@@ -0,0 +1,75 @@
+name = "docs-relational-migrator"
+title = "Relational Migrator"
+
+intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
+                "https://www.mongodb.com/docs/atlas/objects.inv",
+                "https://www.mongodb.com/docs/atlas/app-services/objects.inv"
+              ]
+
+# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]
+
+toc_landing_pages = [
+"supported-databases",
+"installation",
+"installation/install-on-a-local-machine",
+"installation/install-on-an-unattended-server",
+"installation/kafka-deployments/migrator-with-kafka",
+"database-connections",
+"app-analysis",
+"projects",
+"mapping-rules/introduction",
+"mapping-rules/mapping-rule-options/introduction",
+"mapping-rules/fields/calculated-fields",
+"mapping-rules/fields/field-customizations",
+"mapping-rules/synthetic-foreign-key/synthetic-foreign-keys",
+"table-filters",
+"diagrams",
+"diagrams/navigate-diagrams",
+"diagrams/navigate-diagrams/working-with-entities",
+"jobs/sync-jobs",
+"jobs/data-verification",
+"/connection-strings",
+"code-generation",
+"code-generation/generate-app-code",
+"code-generation/query-converter",
+"diagrams/manage-diagrams",
+"getting-started",
+"api-docs",
+"deployment-considerations",
+"code-generation/query-converter-test-queries",
+"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"
+
+[[banners]]
+targets = [
+        "jobs/prerequisites/db2.txt",
+        ]
+variant = "warning"
+value = """\
+        DB2 database support is currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation. 
+        """
+
+[[banners]]
+targets = [
+        "app-analysis.txt",
+        ]
+variant = "warning"
+value = """\
+        Pre-Migration Analysis is new in Relational Migrator 1.13 and currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation. 
+        """

content/relational-migrator/source/api-developer-reference.txt

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