From b8a47bb3f36ba89697ba80e849fcfe89deaf1ef5 Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 13:27:03 -0500 Subject: [PATCH 1/9] add sections for connections --- source/getting-started.txt | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/source/getting-started.txt b/source/getting-started.txt index 0a16bee..2d68b67 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -45,6 +45,39 @@ Getting Started .. include:: /scala/api.rst +Integrations +------------ + +You can integrate the {+connector-long+} with third-party platforms to use the {+connector-short+} in various external platforms. + +Amazon EMR +~~~~~~~~~~ + +Amazon EMR is a managed cluster platform that you can run big data frameworks such as Spark on. To install Spark on an EMR cluster, see +`Getting Started with Amazon EMR `__ in the AWS documentation. + +Databricks +~~~~~~~~~~ + +Databricks is an analytics platform for building, deploying, and sharing enterprise-level data. To integrate the {+connector-long+} with Databricks, +see `MongoDB Atlas via Spark `__ in the Databricks documentation. + +Docker +~~~~~~ + +Docker is an open-source platform that helps developers build, share, and run applications in containers. The following steps guide you through the process of connecting to a Docker container +and integrating the {+connector-long+} in Docker. + +1. To start Spark in a Docker container, see `Apache Spark `__ in the Docker documentation and follow the steps provided. +2. See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. +3. Select the appropriate language in the tabs under :ref:`Getting Started and follow the steps provided. + +Kubernetes +~~~~~~~~~~ + +Kubernetes is an open-source platform for automating containerization management. To integrate run Spark on Kubernetes, +see `Running Spark on Kubernetes `__ in the Spark documentation. + Tutorials --------- From 1fa47490e3c99c7157d436744e78179a5800255f Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 13:35:45 -0500 Subject: [PATCH 2/9] fix vale --- .github/workflows/vale-tdbx.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/vale-tdbx.yml b/.github/workflows/vale-tdbx.yml index 8e4b6f4..d748e94 100644 --- a/.github/workflows/vale-tdbx.yml +++ b/.github/workflows/vale-tdbx.yml @@ -18,20 +18,20 @@ jobs: - id: files uses: masesgroup/retrieve-changed-files@v2 with: - format: 'csv' + format: "csv" - name: checkout-latest-rules uses: actions/checkout@master with: repository: mongodb/mongodb-vale-action - path: './tdbx-vale-rules' + 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/ + 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 From 7b3bcb37fefbf27f61e134020a910852d8fcc7f8 Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 13:39:29 -0500 Subject: [PATCH 3/9] fix vale flag --- source/getting-started.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index 2d68b67..ad17ecb 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -60,7 +60,7 @@ Databricks ~~~~~~~~~~ Databricks is an analytics platform for building, deploying, and sharing enterprise-level data. To integrate the {+connector-long+} with Databricks, -see `MongoDB Atlas via Spark `__ in the Databricks documentation. +see `MongoDB `__ in the Databricks documentation. Docker ~~~~~~ From 941667bad12ce30b9d337cbec8146d183d29c2f6 Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 13:44:12 -0500 Subject: [PATCH 4/9] fix ref --- source/getting-started.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index ad17ecb..0423737 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -70,7 +70,7 @@ and integrating the {+connector-long+} in Docker. 1. To start Spark in a Docker container, see `Apache Spark `__ in the Docker documentation and follow the steps provided. 2. See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. -3. Select the appropriate language in the tabs under :ref:`Getting Started and follow the steps provided. +3. Select the appropriate language in the tabs under :ref:`Getting Started ` and follow the steps provided. Kubernetes ~~~~~~~~~~ From c1f7de3a376b5164d1192dc4fedd2ed75fb5f974 Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 13:53:58 -0500 Subject: [PATCH 5/9] fix typos --- source/getting-started.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index 0423737..c36d990 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -48,7 +48,7 @@ Getting Started Integrations ------------ -You can integrate the {+connector-long+} with third-party platforms to use the {+connector-short+} in various external platforms. +You can integrate Spark with third-party platforms to use the {+connector-long+} in various external platforms. Amazon EMR ~~~~~~~~~~ @@ -75,7 +75,7 @@ and integrating the {+connector-long+} in Docker. Kubernetes ~~~~~~~~~~ -Kubernetes is an open-source platform for automating containerization management. To integrate run Spark on Kubernetes, +Kubernetes is an open-source platform for automating containerization management. To run Spark on Kubernetes, see `Running Spark on Kubernetes `__ in the Spark documentation. Tutorials From cdd461c87d63358ed86b950a853e3ebe1d5a6d1e Mon Sep 17 00:00:00 2001 From: Angela Date: Wed, 5 Mar 2025 15:09:50 -0500 Subject: [PATCH 6/9] change steps formatting --- source/getting-started.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index c36d990..6b3731a 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -69,8 +69,8 @@ Docker is an open-source platform that helps developers build, share, and run ap and integrating the {+connector-long+} in Docker. 1. To start Spark in a Docker container, see `Apache Spark `__ in the Docker documentation and follow the steps provided. -2. See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. -3. Select the appropriate language in the tabs under :ref:`Getting Started ` and follow the steps provided. +#. See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. +#. Select the appropriate language in the tabs under :ref:`Getting Started ` and follow the steps provided. Kubernetes ~~~~~~~~~~ From f0af22b5e5ebcb0eb271cba56f2e5652619ff91a Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 6 Mar 2025 10:02:51 -0500 Subject: [PATCH 7/9] change based on mikes feedback --- source/getting-started.txt | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index 6b3731a..251d906 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -48,12 +48,13 @@ Getting Started Integrations ------------ -You can integrate Spark with third-party platforms to use the {+connector-long+} in various external platforms. +The following sections describe some of the popular third-party platforms that you can +integrate Spark and the {+connector-long+} with. Amazon EMR ~~~~~~~~~~ -Amazon EMR is a managed cluster platform that you can run big data frameworks such as Spark on. To install Spark on an EMR cluster, see +Amazon EMR is a managed cluster platform that you can use to run big data frameworks like Spark. To install Spark on an EMR cluster, see `Getting Started with Amazon EMR `__ in the AWS documentation. Databricks @@ -65,12 +66,10 @@ see `MongoDB `__ in the Docker documentation and follow the steps provided. -#. See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. -#. Select the appropriate language in the tabs under :ref:`Getting Started ` and follow the steps provided. +- To start Spark in a Docker container, see `Apache Spark `__ in the Docker documentation and follow the steps provided. +- See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. Kubernetes ~~~~~~~~~~ From f692f7564163e2a753049c2fe43c311b5b3170fe Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 6 Mar 2025 10:07:35 -0500 Subject: [PATCH 8/9] fix vale error --- source/getting-started.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index 251d906..8844449 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -48,7 +48,7 @@ Getting Started Integrations ------------ -The following sections describe some of the popular third-party platforms that you can +The following sections describe some popular third-party platforms that you can integrate Spark and the {+connector-long+} with. Amazon EMR From 333242c45a4c85a41a86031315f62871f02321aa Mon Sep 17 00:00:00 2001 From: Angela Date: Thu, 6 Mar 2025 10:32:22 -0500 Subject: [PATCH 9/9] change based on feedback --- source/getting-started.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/getting-started.txt b/source/getting-started.txt index 8844449..e157df8 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -69,7 +69,7 @@ Docker Docker is an open-source platform that helps developers build, share, and run applications in containers. - To start Spark in a Docker container, see `Apache Spark `__ in the Docker documentation and follow the steps provided. -- See `Create a Local Atlas Deployment with Docker `__ to deploy Atlas on Docker. +- To learn how to deploy Atlas on Docker, see `Create a Local Atlas Deployment with Docker `__. Kubernetes ~~~~~~~~~~