diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index f2b26602..97e9a5ef 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -4,38 +4,51 @@ Issues & Help ============= +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: kotlin coroutine, troubleshooting, feedback + .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol -We are lucky to have a vibrant MongoDB Kotlin community that includes users -with varying levels of experience using the Kotlin driver. We find the quickest -way to get support for general questions is through the `MongoDB Community Forums `_. - -Refer to our `support channels `__ -documentation for more information. +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 `. Bugs / Feature Requests ----------------------- -If you think you've found a bug or want to see a new feature in the Kotlin -driver, please open a case in our issue management tool, JIRA: +If you have feedback about the {+driver-short+}, visit the `MongoDB +Feedback Engine `__ 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. -* `Create an account and login `__. -* Navigate to `the JAVA project `__. -* Click :guilabel:`Create`. Please provide as much information as possible - about the issue and the steps to reproduce it. +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: -.. important:: Bug Reports Are Public +1. Visit the `MongoDB Jira issue tracker `__ and click the + `signup link. `__ + Create an account, and then log in to Jira. +#. Navigate to the `JAVA Jira project. `__ +#. Click :guilabel:`Create` to create a ticket. Please provide as much + information as possible about the issue or request in the ticket. - Bug reports in JIRA for the Kotlin driver and the Core Server (i.e. SERVER) - project are public. +.. note:: -If you've identified a security vulnerability in a driver or any other -MongoDB project, please report it according to the instructions found in the -:manual:`Create a Vulnerability Report page `. + 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. ` Pull Requests ------------- @@ -43,9 +56,9 @@ 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. +**gradle** checks. -To get started check out the source and work on a branch: +To get started, clone the source repository and work on a branch: .. code-block:: bash @@ -58,4 +71,3 @@ Finally, ensure that the code passes gradle checks. .. code-block:: bash $ ./gradlew check -