Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
60 changes: 32 additions & 28 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
/compatibility
Validate Driver Artifact Signatures </validate-signatures>
/whats-new
/issues-and-help
View the Source <https://github.com/mongodb/mongo-java-driver/tree/master/driver-kotlin-sync>
API Documentation <{+api+}/com.mongodb.kotlin.client/index.html>

Expand Down Expand Up @@ -59,12 +60,6 @@ Connect to MongoDB
Learn how to create and configure a connection to a MongoDB deployment
in the :ref:`kotlin-sync-connect` section.

What's New
----------

For a list of new features and changes in each version, see the :ref:`What's New <kotlin-sync-whats-new>`
section.

Write Data to MongoDB
---------------------

Expand Down Expand Up @@ -107,38 +102,32 @@ In-Use Encryption
Learn how to use in-use encryption to encrypt your MongoDB data in the
:ref:`In-Use Encryption <kotlin-sync-fle>` section.

.. TODO: Uncomment when pages are created
.. FAQ
.. ---

.. For answers to commonly asked questions about the {+driver-short+}, see the
.. :ref:`FAQ <kotlin-sync-faq>` section.

.. Connection Troubleshooting
.. --------------------------

.. For solutions to some issues you might experience when connecting to a MongoDB
.. deployment while using the {+driver-short+}, see the
.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.

.. Issues & Help
.. -------------

.. Learn how to report bugs, contribute to the driver, and find more resources for
.. asking questions and receiving help in the :ref:`Issues & Help <kotlin-sync-issues-and-help>` section.

Compatibility
-------------

For the compatibility charts that show the recommended {+driver-short+} version for each
MongoDB Server version, see the :ref:`Compatibility <kotlin-sync-compatibility>` section.
MongoDB Server version, see the :ref:`Compatibility
<kotlin-sync-compatibility>` section.

Validate Driver Artifact Signatures
-----------------------------------

Learn about how to validate signatures of {+driver-short+} artifacts
published on Maven in the :ref:`Validate Driver Artifact Signatures <kotlin-sync-validate-signatures>` section.

What's New
----------

For a list of new features and changes in each version, see the
:ref:`What's New <kotlin-sync-whats-new>` section.

Issues & Help
-------------

Learn how to report bugs, contribute to the driver, and find more resources for
asking questions and receiving help in the :ref:`Issues & Help
<kotlin-sync-issues-and-help>` section.

Learn
------

Expand All @@ -154,4 +143,19 @@ To learn how to use MongoDB features with the {+driver-short+}, see the
`How-Tos and Articles page <https://www.mongodb.com/developer/languages/kotlin/>`__.

To ask questions and engage in discussions with fellow developers who
use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/kotlin>`__.
use the {+driver-short+}, see the `forums page.
<https://www.mongodb.com/community/forums/tag/kotlin>`__

.. TODO: Uncomment when pages are created
.. FAQ
.. ---

.. For answers to commonly asked questions about the {+driver-short+}, see the
.. :ref:`FAQ <kotlin-sync-faq>` section.

.. Connection Troubleshooting
.. --------------------------

.. For solutions to some issues you might experience when connecting to a MongoDB
.. deployment while using the {+driver-short+}, see the
.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.
73 changes: 73 additions & 0 deletions source/issues-and-help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
.. _kotlin-sync-issues-and-help:

=============
Issues & Help
=============

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: kotlin sync, troubleshooting, feedback

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

We are lucky to have a vibrant MongoDB {+language+} community that includes users
with varying levels of experience using the {+driver-short+}. The
quickest way to get support for general questions is through the
:community-forum:`MongoDB Community Forums </tag/kotlin>`.

Bugs / Feature Requests
-----------------------

If you have feedback about the {+driver-short+}, visit the `MongoDB
Feedback Engine <https://feedback.mongodb.com/>`__ and select
:guilabel:`Drivers` from the list of products on the right side of
your screen. You can propose improvements, report issues, and provide
other types of feedback by using this site.

You can also open a case in Jira, our issue management tool, to identify
bugs or propose improvements. The following steps describe how to create
a Jira issue:

1. Visit the `MongoDB Jira issue tracker <https://jira.mongodb.org/>`__ and click the
`signup link. <https://account.mongodb.com/account/register>`__
Create an account, and then log in to Jira.
#. Navigate to the `JAVA Jira project. <https://jira.mongodb.org/browse/JAVA>`__
#. Click :guilabel:`Create` to create a ticket. Please provide as much
information as possible about the issue or request in the ticket.

.. note::

Bug reports in the JAVA Jira project are publicly viewable.

If you’ve identified a security vulnerability in any official MongoDB
product, please report it according to the instructions found in the
:manual:`Create a Vulnerability Report page. </tutorial/create-a-vulnerability-report>`

Pull Requests
-------------

We are happy to accept contributions to help improve the driver. We will guide
user contributions to ensure they meet the standards of the codebase. Please
ensure that any pull requests include documentation, tests, and pass the
**gradle** checks.

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


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

Loading