From 7803fc37a81377484f32fd4d6d62c035bcbaf994 Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 15 Oct 2024 11:30:06 -0400 Subject: [PATCH 1/3] DOCSP-44292: improve i&h --- source/index.txt | 60 ++++++++++++++++--------------- source/issues-and-help.txt | 73 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 105 insertions(+), 28 deletions(-) create mode 100644 source/issues-and-help.txt diff --git a/source/index.txt b/source/index.txt index 0933850d..ffdb6b9d 100644 --- a/source/index.txt +++ b/source/index.txt @@ -26,6 +26,7 @@ /compatibility Validate Driver Artifact Signatures /whats-new + /issues-and-help View the Source API Documentation <{+api+}/com.mongodb.kotlin.client/index.html> @@ -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 ` -section. - Write Data to MongoDB --------------------- @@ -107,31 +102,12 @@ In-Use Encryption Learn how to use in-use encryption to encrypt your MongoDB data in the :ref:`In-Use Encryption ` section. -.. TODO: Uncomment when pages are created -.. FAQ -.. --- - -.. For answers to commonly asked questions about the {+driver-short+}, see the -.. :ref:`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 ` 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 ` section. - Compatibility ------------- For the compatibility charts that show the recommended {+driver-short+} version for each -MongoDB Server version, see the :ref:`Compatibility ` section. +MongoDB Server version, see the :ref:`Compatibility +` section. Validate Driver Artifact Signatures ----------------------------------- @@ -139,6 +115,19 @@ Validate Driver Artifact Signatures Learn about how to validate signatures of {+driver-short+} artifacts published on Maven in the :ref:`Validate Driver Artifact Signatures ` section. +What's New +---------- + +For a list of new features and changes in each version, see the +:ref:`What's 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 +` section. + Learn ------ @@ -154,4 +143,19 @@ To learn how to use MongoDB features with the {+driver-short+}, see the `How-Tos and Articles page `__. To ask questions and engage in discussions with fellow developers who -use the {+driver-short+}, see the `forums page `__. +use the {+driver-short+}, see the `forums page. +`__ + +.. TODO: Uncomment when pages are created +.. FAQ +.. --- + +.. For answers to commonly asked questions about the {+driver-short+}, see the +.. :ref:`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 ` section. diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt new file mode 100644 index 00000000..02221680 --- /dev/null +++ b/source/issues-and-help.txt @@ -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 `. + +Bugs / Feature Requests +----------------------- + +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. + +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 `__ 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. + +.. 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. ` + +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 + +Finally, ensure that the code passes gradle checks. + +.. code-block:: bash + + $ ./gradlew check From 3121a015f074ce432369a4d49e91e328c4c89211 Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 15 Oct 2024 13:55:36 -0400 Subject: [PATCH 2/3] NR PR fixes 1 --- source/issues-and-help.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/source/issues-and-help.txt b/source/issues-and-help.txt index 02221680..6f360e9d 100644 --- a/source/issues-and-help.txt +++ b/source/issues-and-help.txt @@ -58,16 +58,18 @@ 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: +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 + 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. +Finally, ensure that the code passes gradle check by running the +following command: .. code-block:: bash - $ ./gradlew check + ./gradlew check From 87c2240920aee0a294a07d25268a96e5ff6307fc Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 15 Oct 2024 13:58:33 -0400 Subject: [PATCH 3/3] avs changes (just while im in the pr) --- source/indexes/atlas-search-index.txt | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/source/indexes/atlas-search-index.txt b/source/indexes/atlas-search-index.txt index 652eecd0..23bd5260 100644 --- a/source/indexes/atlas-search-index.txt +++ b/source/indexes/atlas-search-index.txt @@ -39,7 +39,7 @@ pre-filter your data. You can call the following methods on a collection to manage your Atlas Search and Vector Search indexes: -- ``createSearchIndex()`` +- ``createSearchIndex()`` *(valid for Atlas Search indexes only)* - ``createSearchIndexes()`` - ``listSearchIndexes()`` - ``updateSearchIndex()`` @@ -63,8 +63,16 @@ Create a Search Index You can use the `createSearchIndex() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-index.html>`__ -and the `createSearchIndexes() <{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__ -methods to create one or more Atlas Search or Vector Search indexes. +method to create a single Atlas Search index. You *cannot* use this method to +create a Vector Search index. + +You can use the `createSearchIndexes() +<{+api+}/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__ +method to create multiple Atlas Search or Vector Search +indexes. You must create a `SearchIndexModel +<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__ +instance for each index, then pass a list of ``SearchIndexModel`` +instances to the ``createSearchIndexes()`` method. The following code example shows how to create an Atlas Search index: @@ -74,11 +82,6 @@ The following code example shows how to create an Atlas Search index: :end-before: end-create-search-index :dedent: -To create multiple Search or Vector Search indexes, you must create a -`SearchIndexModel -<{+core-api+}/com/mongodb/client/model/SearchIndexModel.html>`__ -instance for each index. - The following code example shows how to create Atlas Search and Vector Search indexes in one call: