Skip to content

Commit 9bfc4a3

Browse files
committed
DOCSP-44292: improve i&h (#51)
* DOCSP-44292: improve i&h * NR PR fixes 1 * avs changes (just while im in the pr) (cherry picked from commit 8756e14)
1 parent cc74457 commit 9bfc4a3

File tree

3 files changed

+118
-36
lines changed

3 files changed

+118
-36
lines changed

source/index.txt

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
/compatibility
2727
Validate Driver Artifact Signatures </validate-signatures>
2828
/whats-new
29+
/issues-and-help
2930
View the Source <https://github.com/mongodb/mongo-java-driver/tree/master/driver-kotlin-sync>
3031
API Documentation <{+api+}/com.mongodb.kotlin.client/index.html>
3132

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

62-
What's New
63-
----------
64-
65-
For a list of new features and changes in each version, see the :ref:`What's New <kotlin-sync-whats-new>`
66-
section.
67-
6863
Write Data to MongoDB
6964
---------------------
7065

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

110-
.. TODO: Uncomment when pages are created
111-
.. FAQ
112-
.. ---
113-
114-
.. For answers to commonly asked questions about the {+driver-short+}, see the
115-
.. :ref:`FAQ <kotlin-sync-faq>` section.
116-
117-
.. Connection Troubleshooting
118-
.. --------------------------
119-
120-
.. For solutions to some issues you might experience when connecting to a MongoDB
121-
.. deployment while using the {+driver-short+}, see the
122-
.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.
123-
124-
.. Issues & Help
125-
.. -------------
126-
127-
.. Learn how to report bugs, contribute to the driver, and find more resources for
128-
.. asking questions and receiving help in the :ref:`Issues & Help <kotlin-sync-issues-and-help>` section.
129-
130105
Compatibility
131106
-------------
132107

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

136112
Validate Driver Artifact Signatures
137113
-----------------------------------
138114

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

118+
What's New
119+
----------
120+
121+
For a list of new features and changes in each version, see the
122+
:ref:`What's New <kotlin-sync-whats-new>` section.
123+
124+
Issues & Help
125+
-------------
126+
127+
Learn how to report bugs, contribute to the driver, and find more resources for
128+
asking questions and receiving help in the :ref:`Issues & Help
129+
<kotlin-sync-issues-and-help>` section.
130+
142131
Learn
143132
------
144133

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

156145
To ask questions and engage in discussions with fellow developers who
157-
use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/kotlin>`__.
146+
use the {+driver-short+}, see the `forums page.
147+
<https://www.mongodb.com/community/forums/tag/kotlin>`__
148+
149+
.. TODO: Uncomment when pages are created
150+
.. FAQ
151+
.. ---
152+
153+
.. For answers to commonly asked questions about the {+driver-short+}, see the
154+
.. :ref:`FAQ <kotlin-sync-faq>` section.
155+
156+
.. Connection Troubleshooting
157+
.. --------------------------
158+
159+
.. For solutions to some issues you might experience when connecting to a MongoDB
160+
.. deployment while using the {+driver-short+}, see the
161+
.. :ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.

source/indexes/atlas-search-index.txt

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pre-filter your data.
3939
You can call the following methods on a collection to manage your Atlas
4040
Search and Vector Search indexes:
4141

42-
- ``createSearchIndex()``
42+
- ``createSearchIndex()`` *(valid for Atlas Search indexes only)*
4343
- ``createSearchIndexes()``
4444
- ``listSearchIndexes()``
4545
- ``updateSearchIndex()``
@@ -63,8 +63,16 @@ Create a Search Index
6363

6464
You can use the `createSearchIndex()
6565
<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-index.html>`__
66-
and the `createSearchIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__
67-
methods to create one or more Atlas Search or Vector Search indexes.
66+
method to create a single Atlas Search index. You *cannot* use this method to
67+
create a Vector Search index.
68+
69+
You can use the `createSearchIndexes()
70+
<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__
71+
method to create multiple Atlas Search or Vector Search
72+
indexes. You must create a `SearchIndexModel
73+
<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__
74+
instance for each index, then pass a list of ``SearchIndexModel``
75+
instances to the ``createSearchIndexes()`` method.
6876

6977
The following code example shows how to create an Atlas Search index:
7078

@@ -74,11 +82,6 @@ The following code example shows how to create an Atlas Search index:
7482
:end-before: end-create-search-index
7583
:dedent:
7684

77-
To create multiple Search or Vector Search indexes, you must create a
78-
`SearchIndexModel
79-
<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__
80-
instance for each index.
81-
8285
The following code example shows how to create Atlas Search and
8386
Vector Search indexes in one call:
8487

source/issues-and-help.txt

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
.. _kotlin-sync-issues-and-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: kotlin sync, troubleshooting, feedback
13+
14+
.. contents:: On this page
15+
:local:
16+
:backlinks: none
17+
:depth: 1
18+
:class: singlecol
19+
20+
We are lucky to have a vibrant MongoDB {+language+} community that includes users
21+
with varying levels of experience using the {+driver-short+}. The
22+
quickest way to get support for general questions is through the
23+
:community-forum:`MongoDB Community Forums </tag/kotlin>`.
24+
25+
Bugs / Feature Requests
26+
-----------------------
27+
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.
44+
45+
.. note::
46+
47+
Bug reports in the JAVA Jira project are publicly viewable.
48+
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>`
52+
53+
Pull Requests
54+
-------------
55+
56+
We are happy to accept contributions to help improve the driver. We will guide
57+
user contributions to ensure they meet the standards of the codebase. Please
58+
ensure that any pull requests include documentation, tests, and pass the
59+
**gradle** checks.
60+
61+
To get started, clone the source repository and work on a branch by
62+
running the following commands:
63+
64+
.. code-block:: bash
65+
66+
git clone https://github.com/mongodb/mongo-java-driver.git
67+
cd mongo-java-driver
68+
git checkout -b myNewFeature
69+
70+
Finally, ensure that the code passes gradle check by running the
71+
following command:
72+
73+
.. code-block:: bash
74+
75+
./gradlew check

0 commit comments

Comments
 (0)