DOCSP-31186 Add sections for connections #243

shuangela · 2025-03-05T18:27:42Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-31186

Staging Links

getting-started

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2025-03-05T18:28:01Z

✅ Deploy Preview for docs-spark-connector ready!

Name	Link
🔨 Latest commit	`333242c`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spark-connector/deploys/67c9c00b74eca500099622e8
😎 Deploy Preview	https://deploy-preview-243--docs-spark-connector.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mongoKart

nice work! just a few small changes.

mongoKart · 2025-03-05T21:07:13Z

source/getting-started.txt

+Integrations
+------------
+
+You can integrate Spark with third-party platforms to use the {+connector-long+} in various external platforms.


i: repetitive use of 'platforms'

Suggested change

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.

mongoKart · 2025-03-05T21:09:29Z

source/getting-started.txt

+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


i: such as

Suggested change

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

mongoKart · 2025-03-05T21:12:31Z

source/getting-started.txt

+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 <https://hub.docker.com/r/apache/spark#!>`__ in the Docker documentation and follow the steps provided. 
+#. See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker. 
+#. Select the appropriate language in the tabs under :ref:`Getting Started <pyspark-shell>` and follow the steps provided. 


i: 'The following steps' suggest this is going to be a procedure, which feels out of place with the rest of these sections. I would probably just break it into separate links (and the last step is hopefully already understood, so I would leave it out):

Suggested change

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 <https://hub.docker.com/r/apache/spark#!>`__ in the Docker documentation and follow the steps provided.

#. See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker.

#. Select the appropriate language in the tabs under :ref:`Getting Started <pyspark-shell>` and follow the steps provided.

Docker is an open-source platform that helps developers build, share, and run applications in containers.

- To learn how to start Spark in a Docker container, see `Apache Spark <https://hub.docker.com/r/apache/spark#!>`__ in the Docker documentation.

- To learn how to deploy Atlas on Docker, see `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__.

That's a great suggestion! I agree steps felt odd but I wasn't sure how to break out the instructions without having a long paragraph. The bullet points are a good idea 😄

mongoKart

1 SG fix, then LGTM!

mongoKart · 2025-03-06T15:31:22Z

source/getting-started.txt

-#. See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker. 
-#. Select the appropriate language in the tabs under :ref:`Getting Started <pyspark-shell>` and follow the steps provided. 
+- To start Spark in a Docker container, see `Apache Spark <https://hub.docker.com/r/apache/spark#!>`__ in the Docker documentation and follow the steps provided. 
+- See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker. 


SG: 'Link text should begin with the purpose of the cross-reference'

Suggested change

- See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker.

- To learn how to deploy Atlas on Docker, see `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__.

* add sections for connections * fix vale * fix vale flag * fix ref * fix typos * change steps formatting * change based on mikes feedback * fix vale error * change based on feedback (cherry picked from commit 75df8c4)

shuangela · 2025-03-06T21:13:51Z

💔 Some backports could not be created

Status	Branch	Result
✅	v10.4
✅	v10.3
❌	v10.2	Conflict resolution was aborted by the user
❌	v10.1	Conflict resolution was aborted by the user
❌	v10.0	Conflict resolution was aborted by the user

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 243

Questions ?

Please refer to the Backport tool documentation

* add sections for connections * fix vale * fix vale flag * fix ref * fix typos * change steps formatting * change based on mikes feedback * fix vale error * change based on feedback (cherry picked from commit 75df8c4)

* DOCSP-29861: Cleanup unused files (#200) (cherry picked from commit 05f3125) * DOCSP-40130 - Note on Sharded Partitioner (#201) Co-authored-by: Nora Reidy <[email protected]> (cherry picked from commit e25e13f) * Add Netlify config files via upload * DOCSP-42969 - remove nested admonitions (#204) (#208) (cherry picked from commit b37226e) Co-authored-by: Mike Woofter <[email protected]> * DOCSP-44953 TOC Relabel (#214) (#217) * DOCSP-44953 TOC Relabel * edit * Mike's Suggestions * keep configure tls (cherry picked from commit 987747d) Co-authored-by: lindseymoore <[email protected]> * (DOCSP-45749) Denests last phase 1 nested component for spark connector (#220) (#222) * Add dependency installation to vale rule (cherry picked from commit 989f378) * [Spark] Remove autobuilder (#227) (#230) (cherry picked from commit ca7f722) Co-authored-by: Rachel Mackintosh <[email protected]> * DOCSP-46719 Spark Guide 404 (#235) (#239) (cherry picked from commit 671e355) Co-authored-by: lindseymoore <[email protected]> * DOCSP-31186 Add sections for connections (#243) (#248) * add sections for connections * fix vale * fix vale flag * fix ref * fix typos * change steps formatting * change based on mikes feedback * fix vale error * change based on feedback (cherry picked from commit 75df8c4) --------- Co-authored-by: Michael Morisi <[email protected]> Co-authored-by: Mike Woofter <[email protected]> Co-authored-by: anabellabuckvar <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: lindseymoore <[email protected]> Co-authored-by: Sarah Simpers <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> Co-authored-by: Rachel Mackintosh <[email protected]>

add sections for connections

b8a47bb

shuangela added 5 commits March 5, 2025 13:35

fix vale

1fa4749

fix vale flag

7b3bcb3

fix ref

941667b

fix typos

c1f7de3

change steps formatting

cdd461c

mongoKart requested changes Mar 5, 2025

View reviewed changes

shuangela added 2 commits March 6, 2025 10:02

change based on mikes feedback

f0af22b

fix vale error

f692f75

shuangela requested a review from mongoKart March 6, 2025 15:14

mongoKart approved these changes Mar 6, 2025

View reviewed changes

change based on feedback

333242c

shuangela merged commit 75df8c4 into mongodb:master Mar 6, 2025
6 checks passed

shuangela mentioned this pull request Mar 6, 2025

[v10.4] DOCSP-31186 Add sections for connections (#243) #247

Merged

shuangela mentioned this pull request Mar 6, 2025

[v10.3] DOCSP-31186 Add sections for connections (#243) #248

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-31186 Add sections for connections #243

DOCSP-31186 Add sections for connections #243

shuangela commented Mar 5, 2025 •

edited by github-actions bot

Loading

netlify bot commented Mar 5, 2025 •

edited

Loading

mongoKart left a comment

mongoKart Mar 5, 2025

mongoKart Mar 5, 2025

mongoKart Mar 5, 2025

shuangela Mar 6, 2025

mongoKart left a comment

mongoKart Mar 6, 2025

shuangela commented Mar 6, 2025

	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 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

	- See `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__ to deploy Atlas on Docker.
	- To learn how to deploy Atlas on Docker, see `Create a Local Atlas Deployment with Docker <https://www.mongodb.com/docs/atlas/cli/current/atlas-cli-deploy-docker/>`__.

DOCSP-31186 Add sections for connections #243

DOCSP-31186 Add sections for connections #243

Conversation

shuangela commented Mar 5, 2025 • edited by github-actions bot Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented Mar 5, 2025 • edited Loading

✅ Deploy Preview for docs-spark-connector ready!

mongoKart left a comment

Choose a reason for hiding this comment

mongoKart Mar 5, 2025

Choose a reason for hiding this comment

mongoKart Mar 5, 2025

Choose a reason for hiding this comment

mongoKart Mar 5, 2025

Choose a reason for hiding this comment

shuangela Mar 6, 2025

Choose a reason for hiding this comment

mongoKart left a comment

Choose a reason for hiding this comment

mongoKart Mar 6, 2025

Choose a reason for hiding this comment

shuangela commented Mar 6, 2025

💔 Some backports could not be created

Manual backport

Questions ?

shuangela commented Mar 5, 2025 •

edited by github-actions bot

Loading

netlify bot commented Mar 5, 2025 •

edited

Loading