DOCSP-35821: link to jar download #518

rustagir · 2024-01-26T20:31:57Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-35821
Staging - https://preview-mongodbrustagir.gatsbyjs.io/java/DOCSP-35821-link-jar-file/quick-start/#add-mongodb-as-a-dependency

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?

ccho-mongodb · 2024-01-26T20:42:53Z

source/quick-start.txt

+.. tip:: Download ``.jar`` File
+
+   You can directly download the ``.jar`` file for the {+driver-short+}


Suggestion:
I think JAR is usually not referenced by it's filename extension, but rather by the file format "JAR". See https://en.wikipedia.org/wiki/JAR_(file_format)

E.g.
tip:: Download the JAR File

ccho-mongodb

Thanks for picking up this ticket. I think this accomplishes the goal of the ticket, but I think the information might cause confusion without additional details.

I think the content might change after confirming with the DBX team, so requesting changes so I can look again after that.

ccho-mongodb · 2024-01-26T21:16:39Z

source/quick-start.txt

@@ -50,6 +50,12 @@ If you are using `Gradle <https://gradle.org/>`__, add the following to your

 .. include:: /includes/quick-start/gradle-versioned.rst

+.. tip:: Download the JAR File
+
+   You can directly download the JAR file for the {+driver-short+}


Suggestion:
I think "directly" could provide contrast when compared with another option, but I think omitting it when there isn't a comparison being made would be better.

"You can download..."

ccho-mongodb · 2024-01-26T21:23:05Z

source/quick-start.txt

+   You can directly download the JAR file for the {+driver-short+}
+   from the `Maven MongoDB Driver artifact entry
+   <https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/{+full-version+}>`__.
+


Suggestion:
I think this could use similar wording as this download mention:

"You can download the JAR file for the MongoDB Java Driver from the Maven repository."

ccho-mongodb · 2024-01-26T21:40:52Z

source/quick-start.txt

@@ -50,6 +50,12 @@ If you are using `Gradle <https://gradle.org/>`__, add the following to your

 .. include:: /includes/quick-start/gradle-versioned.rst

+.. tip:: Download the JAR File


Issue/Suggestion:

Could you confirm whether you might need to make the following changes in a technical review?

My guess is that the goal of the ticket is to provide a download location so that the user can download and add them to their app classpath so that they can perform MongoDB operations.

However, I think the mongodb-driver-sync JAR file has these dependencies which means it won't work without them. For context, there used to be another JAR file that contained all the dependencies (called the Uber JAR), but the DBX team no longer provides builds for that.

The current quick start instructions depend on Maven or Gradle to manage all the dependencies of the mongodb-driver-sync JAR.

I think one of the following solutions could improve the usefulness of this info:

Point the user to the Sonatype repository and mention that they'll need to download the dependencies https://central.sonatype.com/artifact/org.mongodb/mongodb-driver-sync/

Provide links to each of the dependency JAR files that they would need to download and add to their classpath to run the app.

I'll check what DBX and the ticket creator prefer!

…1-link-jar-file

ccho-mongodb

A couple suggestions, but do not need to review again unless requested.

ccho-mongodb · 2024-02-06T19:45:18Z

source/quick-start.txt

@@ -50,6 +50,13 @@ If you are using `Gradle <https://gradle.org/>`__, add the following to your

 .. include:: /includes/quick-start/gradle-versioned.rst

+.. note::
+
+   We recommend that you use a package manager to install the


Suggestion:
I think Maven and Gradle are more often described as "build tools" or "dependency managers" based on the specific part of the functionality that's being described.

For example:

Gradle Build Tool (newsletter page)

Apache Maven 3.x description

Maven is a project development management and comprehension tool. Based on the concept of a project object model: builds, dependency management, documentation creation, site publication, and distribution publication are all controlled from the pom.xml declarative file. Maven can be extended by plugins to utilise a number of other development tools for reporting or the build process.

ccho-mongodb · 2024-02-06T19:50:53Z

source/quick-start.txt

+   and dependency packages, you can find the JAR files in the `Maven
+   repository <https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/>`__.


Issue:

The current link only contains the mongodb-driver-sync JAR and not any of the dependencies.

Suggestion:
I think it could be more helpful to specify the group (which references all org.mongodb JARs) and which ones are necessary.

Suggested change

and dependency packages, you can find the JAR files in the `Maven

repository <https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/>`__.

and its dependencies, you can find the JAR files in the `MongoDB Group Maven

repository <https://mvnrepository.com/artifact/org.mongodb/>`__. The Java Sync

driver requires the ``mongodb-driver-core``, ``bson``, and ``mongodb-driver-sync``

JAR files.

* DOCSP-35821: link to jar download * remove trailing slash * change file fmt * CC PR fixes 1 * redo after discussion * small fixes * CC suggestions * small fixes * small fix * wording fix (cherry picked from commit 8a643e1)

rustagir added 2 commits January 26, 2024 15:28

DOCSP-35821: link to jar download

acb2c3f

remove trailing slash

589a136

ccho-mongodb reviewed Jan 26, 2024

View reviewed changes

change file fmt

92d3584

ccho-mongodb suggested changes Jan 26, 2024

View reviewed changes

rustagir added 4 commits January 30, 2024 09:32

CC PR fixes 1

6a4be19

Merge branch 'master' of github.com:mongodb/docs-java into DOCSP-3582…

10353e2

…1-link-jar-file

redo after discussion

0e48a92

small fixes

4126872

rustagir requested a review from ccho-mongodb February 6, 2024 19:27

ccho-mongodb approved these changes Feb 6, 2024

View reviewed changes

rustagir added 4 commits February 6, 2024 15:45

CC suggestions

8af8511

small fixes

2235cca

small fix

cbf5111

wording fix

9aa5e35

rustagir merged commit 8a643e1 into mongodb:master Feb 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-35821: link to jar download #518

DOCSP-35821: link to jar download #518

Uh oh!

rustagir commented Jan 26, 2024

Uh oh!

ccho-mongodb Jan 26, 2024

Uh oh!

ccho-mongodb left a comment

Uh oh!

ccho-mongodb Jan 26, 2024

Uh oh!

ccho-mongodb Jan 26, 2024

Uh oh!

ccho-mongodb Jan 26, 2024

Uh oh!

rustagir Jan 30, 2024

Uh oh!

ccho-mongodb left a comment

Uh oh!

ccho-mongodb Feb 6, 2024

Uh oh!

ccho-mongodb Feb 6, 2024

Uh oh!

Uh oh!

		.. tip:: Download ``.jar`` File

		You can directly download the ``.jar`` file for the {+driver-short+}

		@@ -50,6 +50,12 @@ If you are using `Gradle <https://gradle.org/>`__, add the following to your

		.. include:: /includes/quick-start/gradle-versioned.rst

		.. tip:: Download the JAR File

		and dependency packages, you can find the JAR files in the `Maven
		repository <https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/>`__.

-   and dependency packages, you can find the JAR files in the `Maven
-   repository <https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/>`__.
+   and its dependencies, you can find the JAR files in the `MongoDB Group Maven
+   repository <https://mvnrepository.com/artifact/org.mongodb/>`__. The Java Sync
+   driver requires the ``mongodb-driver-core``, ``bson``, and ``mongodb-driver-sync``
+   JAR files.

DOCSP-35821: link to jar download #518

DOCSP-35821: link to jar download #518

Uh oh!

Conversation

rustagir commented Jan 26, 2024

Pull Request Info

Self-Review Checklist

Uh oh!

ccho-mongodb Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb left a comment

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

rustagir Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb left a comment

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Feb 6, 2024

Choose a reason for hiding this comment

Uh oh!

ccho-mongodb Feb 6, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!