Skip to content

DOCSP-34415: improve index #485

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.

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 2 commits into from
Nov 14, 2023

Conversation

rustagir
Copy link
Contributor

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-34415
Staging - https://preview-mongodbrustagir.gatsbyjs.io/java/DOCSP-34415-improve-index/#introduction

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?

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM, added a couple suggestions.

source/index.txt Outdated
Comment on lines 40 to 41
to install the driver by using `Maven <https://maven.apache.org/>`__ or
`Gradle <https://gradle.org/>`__ in your project and set up a runnable app.
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 "install the driver" could be interpreted as launching an installer and/or having it available for anything, so the following might be more precise:

"learn how to add the driver to your project by using Maven..."

To make the items joined by the conjunction parallel, I think it could be good to include the prepositional phrase:

"and [how] to set up a runnable app"

@rustagir rustagir merged commit c613862 into mongodb:master Nov 14, 2023
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
rustagir added a commit that referenced this pull request Nov 14, 2023
* DOCSP-34415: improve index

* CC suggestion

(cherry picked from commit c613862)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants