Skip to content

DOCSP-35821: link to jar download #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Feb 6, 2024
Merged

DOCSP-35821: link to jar download #518

Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
acb2c3f
DOCSP-35821: link to jar download
rustagir Jan 26, 2024
589a136
remove trailing slash
rustagir Jan 26, 2024
92d3584
change file fmt
rustagir Jan 26, 2024
6a4be19
CC PR fixes 1
rustagir Jan 30, 2024
10353e2
Merge branch 'master' of github.com:mongodb/docs-java into DOCSP-3582…
rustagir Feb 6, 2024
0e48a92
redo after discussion
rustagir Feb 6, 2024
4126872
small fixes
rustagir Feb 6, 2024
8af8511
CC suggestions
rustagir Feb 6, 2024
2235cca
small fixes
rustagir Feb 6, 2024
cbf5111
small fix
rustagir Feb 6, 2024
9aa5e35
wording fix
rustagir Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/quick-start.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


You can directly download the JAR file for the {+driver-short+}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

from the `Maven MongoDB Driver artifact entry
<https://mvnrepository.com/artifact/org.mongodb/mongodb-driver-sync/{+full-version+}>`__.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Once you configure your dependencies, ensure they are available to your
project which may require running your dependency manager and refreshing
the project in your IDE.
Expand Down