Skip to content

Commit ee3d30a

Browse files
authored
DOCSP-44292: improve i&h (#87)
1 parent eccc8e5 commit ee3d30a

File tree

1 file changed

+41
-23
lines changed

1 file changed

+41
-23
lines changed

source/issues-and-help.txt

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,72 @@
44
Issues & Help
55
=============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: java reactive streams, troubleshooting, feedback
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
1017
:depth: 1
1118
:class: singlecol
1219

13-
We are lucky to have a vibrant MongoDB {+java-rs+} community that includes users
14-
with varying levels of experience using the {+java-rs+} driver. We find the quickest
15-
way to get support for general questions is through the `MongoDB Community Forums <https://community.mongodb.com>`_.
16-
17-
Refer to our `support channels <https://www.mongodb.org/about/support>`_
18-
documentation for more information.
20+
We are lucky to have a vibrant MongoDB Java community that
21+
includes users with varying levels of experience using the
22+
{+driver-short+}. The quickest way to get support for general questions
23+
is through the :community-forum:`MongoDB Community Forums </tag/java>`.
1924

2025
Bugs / Feature Requests
2126
-----------------------
2227

23-
If you think you've found a bug or want to see a new feature in the Java
24-
Reactive Streams driver, please open a case in our issue management tool, Jira:
28+
If you have feedback about the {+driver-short+}, visit the `MongoDB
29+
Feedback Engine <https://feedback.mongodb.com/>`__ and select
30+
:guilabel:`Drivers` from the list of products on the right side of
31+
your screen. You can propose improvements, report issues, and provide
32+
other types of feedback by using this site.
33+
34+
You can also open a case in Jira, our issue management tool, to identify
35+
bugs or propose improvements. The following steps describe how to create
36+
a Jira issue:
37+
38+
1. Visit the `MongoDB Jira issue tracker <https://jira.mongodb.org/>`__ and click the
39+
`signup link. <https://account.mongodb.com/account/register>`__
40+
Create an account, and then log in to Jira.
41+
#. Navigate to the `JAVA Jira project. <https://jira.mongodb.org/browse/JAVA>`__
42+
#. Click :guilabel:`Create` to create a ticket. Please provide as much
43+
information as possible about the issue or request in the ticket.
2544

26-
* `Create an account and login <https://jira.mongodb.org>`_.
27-
* Navigate to `the JAVA project <https://jira.mongodb.org/browse/JAVA>`_.
28-
* Click :guilabel:`Create`. Please provide as much information as possible
29-
about the issue and the steps to reproduce it.
45+
.. note::
3046

31-
Bug reports in Jira for the Java project and the Core Server (SERVER) project are **public**.
47+
Bug reports in the JAVA Jira project are publicly viewable.
3248

33-
If you’ve identified a security vulnerability in a driver or any other
34-
MongoDB project, please report it according to the instructions found in the
35-
:manual:`Create a Vulnerability Report page </tutorial/create-a-vulnerability-report>`.
49+
If you’ve identified a security vulnerability in any official MongoDB
50+
product, please report it according to the instructions found in the
51+
:manual:`Create a Vulnerability Report page. </tutorial/create-a-vulnerability-report>`
3652

3753
Pull Requests
3854
-------------
3955

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

45-
To get started, check out the source and work on a branch:
61+
To get started, clone the source repository and work on a branch by
62+
running the following commands:
4663

4764
.. code-block:: bash
4865

49-
$ git clone https://github.com/mongodb/mongo-java-driver.git
50-
$ cd mongo-java-driver
51-
$ git checkout -b myNewFeature
66+
git clone https://github.com/mongodb/mongo-java-driver.git
67+
cd mongo-java-driver
68+
git checkout -b myNewFeature
5269

53-
Finally, ensure that the code passes gradle checks:
70+
Finally, ensure that the code passes gradle check by running the
71+
following command:
5472

5573
.. code-block:: bash
5674

57-
$ ./gradlew check
75+
./gradlew check

0 commit comments

Comments
 (0)