Skip to content

DOCSP-44292: improve i&h #51

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 3 commits into from
Oct 15, 2024
Merged

Conversation

rustagir
Copy link
Contributor

@rustagir rustagir commented Oct 15, 2024

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44292
Staging - https://deploy-preview-51--docs-kotlin-sync.netlify.app/issues-and-help/

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

netlify bot commented Oct 15, 2024

Deploy Preview for docs-kotlin-sync ready!

Name Link
🔨 Latest commit 87c2240
🔍 Latest deploy log https://app.netlify.com/sites/docs-kotlin-sync/deploys/670ead4e589a090008fe1a5e
😎 Deploy Preview https://deploy-preview-51--docs-kotlin-sync.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Collaborator

@norareidy norareidy left a comment

Choose a reason for hiding this comment

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

LGTM + some small things

Comment on lines 61 to 67
To get started check out the source and work on a branch:

.. code-block:: bash

$ git clone https://github.com/mongodb/mongo-java-driver.git
$ cd mongo-java-driver
$ git checkout -b myNewFeature
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: I think you can reword this code intro slightly; also, you can remove the $ from the code example

Suggested change
To get started check out the source and work on a branch:
.. code-block:: bash
$ git clone https://github.com/mongodb/mongo-java-driver.git
$ cd mongo-java-driver
$ git checkout -b myNewFeature
To get started, clone the source repository and work on a branch by running the following commands:
.. code-block:: bash
git clone https://github.com/mongodb/mongo-java-driver.git
cd mongo-java-driver
git checkout -b myNewFeature

$ cd mongo-java-driver
$ git checkout -b myNewFeature

Finally, ensure that the code passes gradle checks.
Copy link
Collaborator

Choose a reason for hiding this comment

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

S:

Suggested change
Finally, ensure that the code passes gradle checks.
Finally, ensure that the code passes gradle checks by running the following command:


.. code-block:: bash

$ ./gradlew check
Copy link
Collaborator

Choose a reason for hiding this comment

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

S:

Suggested change
$ ./gradlew check
./gradlew check

@rustagir rustagir merged commit 8756e14 into mongodb:master Oct 15, 2024
4 of 5 checks passed
rustagir added a commit that referenced this pull request Oct 15, 2024
* DOCSP-44292: improve i&h

* NR PR fixes 1

* avs changes (just while im in the pr)

(cherry picked from commit 8756e14)
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