DOCSP-37545 Atlas Search Page #222
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-pymongo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jordan-smith721
requested changes
Mar 14, 2025
source/atlas-search.txt
Outdated
| Overview | ||
| -------- | ||
|
|
||
| In this guide, you can learn how to query an Atlas Search index and use advanced search functionality for your applications. To query the seach index, use a ``$search`` aggregation pipeline stage with {+driver-short+}. |
There was a problem hiding this comment.
S: Restructure this to specify the driver earlier
Suggested change
| In this guide, you can learn how to query an Atlas Search index and use advanced search functionality for your applications. To query the seach index, use a ``$search`` aggregation pipeline stage with {+driver-short+}. | |
| In this guide, you can learn how to query an Atlas Search index and use advanced search functionality for your {+driver-short+} applications. You can query a search index, by using a ``$search`` aggregation pipeline stage. |
source/atlas-search.txt
Outdated
Comment on lines
25
to
26
| To learn more about the ``$search`` pipeline stage, see :manual:`$search | ||
| </reference/operator/aggregation/search/>`. |
There was a problem hiding this comment.
Suggested change
| To learn more about the ``$search`` pipeline stage, see :manual:`$search | |
| </reference/operator/aggregation/search/>`. | |
| To learn more about the ``$search`` pipeline stage, see the :manual:`$search | |
| </reference/operator/aggregation/search/>` guide in the {+mdb-server+} manual. |
source/atlas-search.txt
Outdated
| Before you can perform a search on an Atlas collection, you must first create an **Atlas | ||
| Search index** on the collection. An Atlas Search index is a data structure that | ||
| categorizes data in a searchable format. To learn how to create an Atlas Search Index | ||
| see the :ref:`pymongo-atlas-search-index` documentation. |
There was a problem hiding this comment.
nit: "documentation" here made me think I was getting link to a different set of docs rather than a page in the pymongo docs.
source/atlas-search.txt
Outdated
| Search Your Data | ||
| ---------------- | ||
|
|
||
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. |
There was a problem hiding this comment.
Suggested change
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. | |
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you want to run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. |
source/atlas-search.txt
Outdated
|
|
||
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. | ||
|
|
||
| The following example uses the ``phrase`` operator, which performs search for documents containing an ordered sequence of terms. To learn more about the ``phrase`` operator, see :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. |
There was a problem hiding this comment.
Suggested change
| The following example uses the ``phrase`` operator, which performs search for documents containing an ordered sequence of terms. To learn more about the ``phrase`` operator, see :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. | |
| The following example uses the ``phrase`` operator, which performs a search for documents that contain an ordered sequence of terms. To learn more about the ``phrase`` operator, see :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. |
source/atlas-search.txt
Outdated
|
|
||
| The following example uses the ``phrase`` operator, which performs search for documents containing an ordered sequence of terms. To learn more about the ``phrase`` operator, see :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. | ||
|
|
||
| The example performs a basic search of the ``title`` field for the query string ``new york``. |
There was a problem hiding this comment.
Suggested change
| The example performs a basic search of the ``title`` field for the query string ``new york``. | |
| The example performs a basic search of the ``title`` field for the query string ``"new york"``. |
source/atlas-search.txt
Outdated
Comment on lines
60
to
64
| The query also includes a: | ||
|
|
||
| - :pipeline:`$limit` stage to limit the output to 10 results. | ||
| - :pipeline:`$project` stage to exclude all fields except | ||
| ``title`` and add a field named ``score``. |
There was a problem hiding this comment.
Style guide: Introduce lists with a full sentence
Suggested change
| The query also includes a: | |
| - :pipeline:`$limit` stage to limit the output to 10 results. | |
| - :pipeline:`$project` stage to exclude all fields except | |
| ``title`` and add a field named ``score``. | |
| The query also includes the following stages: | |
| - :pipeline:`$limit`, to limit the output to 10 results. | |
| - :pipeline:`$project`, to exclude all fields except | |
| ``title`` and add a field named ``score``. |
source/atlas-search.txt
Outdated
Comment on lines
111
to
112
| Next Steps | ||
| ---------- |
There was a problem hiding this comment.
We typically use "Next Steps" in tutorial-style pages. Since this is a reference page, I would suggest converting this to an "Additional Information" section (and converting the following paragraph into a bulleted list of resources)
There was a problem hiding this comment.
I did not convert into a bulleted list, but I did change it to an addl. info section. Looking at the other pymongo pages, some of the addl. info sections are in prose and I think in this case, prose works better because the information isn't linking out to functions in the api docs or less prose-based information
source/atlas-search.txt
Outdated
Comment on lines
116
to
118
| </atlas-search/operators-and-collectors>` and other queries you can run. More query examples using | ||
| MongoDB Query Language (MQL) are available througout the Atlas :atlas:`documentation | ||
| </atlas-search>`. |
There was a problem hiding this comment.
We don't refer to it as MQL in external docs anymore. It's now called the "MongoDB Query API", but I think we can get away without mentioning either one here
Suggested change
| </atlas-search/operators-and-collectors>` and other queries you can run. More query examples using | |
| MongoDB Query Language (MQL) are available througout the Atlas :atlas:`documentation | |
| </atlas-search>`. | |
| </atlas-search/operators-and-collectors>` and other queries you can run. You can view more query examples in the :atlas:`Atlas Search documentation | |
| </atlas-search>`. |
source/atlas-search.txt
Outdated
| Search Your Data | ||
| ---------------- | ||
|
|
||
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. |
There was a problem hiding this comment.
S: I think "specify" might work better than "select" here since select seems like you are doing it through some kind of select stage or selection process within atlas search
Suggested change
| To use the ``$search`` aggregation pipeline stage, you must select an Atlas Search query operator that specifies the type of query you run. You can also optionally select a collector that groups results by values or ranges. To see a table of all the operators and collectors available in Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. | |
| To use the ``$search`` aggregation pipeline stage, you must specify an Atlas Search query operator that indicates the type of query you run. You can also optionally specify a collector that groups results by values or ranges. To view a table of all the operators and collectors available with Atlas Search, see :atlas:`Use Operators and Collectors in Atlas Search Queries </atlas-search/operators-and-collectors>`. |
jordan-smith721
approved these changes
Mar 14, 2025
source/atlas-search.txt
Outdated
| -------- | ||
|
|
||
| In this guide, you can learn how to query an Atlas Search index and use advanced search | ||
| functionality for your {+driver-short+} applications. You can query a search index by |
There was a problem hiding this comment.
Suggested change
| functionality for your {+driver-short+} applications. You can query a search index by | |
| functionality in your {+driver-short+} applications. You can query a search index by |
source/atlas-search.txt
Outdated
Comment on lines
51
to
52
| categorizes data in a searchable format. To learn how to create an Atlas Search Index | ||
| see :ref:`pymongo-atlas-search-index`. |
There was a problem hiding this comment.
Suggested change
| categorizes data in a searchable format. To learn how to create an Atlas Search Index | |
| see :ref:`pymongo-atlas-search-index`. | |
| categorizes data in a searchable format. To learn how to create an Atlas Search Index, | |
| see :ref:`pymongo-atlas-search-index`. |
source/atlas-search.txt
Outdated
Comment on lines
64
to
65
| that contain an ordered sequence of terms. To learn more about the ``phrase`` operator, see | ||
| :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. |
There was a problem hiding this comment.
Suggested change
| that contain an ordered sequence of terms. To learn more about the ``phrase`` operator, see | |
| :atlas:`Phrase </atlas-search/phrase>` in the Atlas guide. | |
| that contain an ordered sequence of terms. To learn more about the ``phrase`` operator, see the | |
| :atlas:`Phrase </atlas-search/phrase>` guide in the MongoDB Atlas documentation. |
source/atlas-search.txt
Outdated
Comment on lines
122
to
127
| To learn more about the different Atlas Search :atlas:`operators | ||
| </atlas-search/operators-and-collectors>` and other queries you can run, see the | ||
| Atlas Search :atlas:`documentation </atlas-search>`. | ||
|
|
||
| You can view more query examples througout the Atlas :atlas:`documentation | ||
| </atlas-search>`. |
There was a problem hiding this comment.
S: It's not entirely clear where each of these links will take you until you click on them. Also this section links to the same page twice, so I think we can eliminate the first link to the general Atlas Search docs.
Suggested change
| To learn more about the different Atlas Search :atlas:`operators | |
| </atlas-search/operators-and-collectors>` and other queries you can run, see the | |
| Atlas Search :atlas:`documentation </atlas-search>`. | |
| You can view more query examples througout the Atlas :atlas:`documentation | |
| </atlas-search>`. | |
| To learn more about the available Atlas Search operators, see the :atlas:`Operators and Collectors </atlas-search/operators-and-collectors>` guide in the MongoDB Atlas documentation. | |
| For more information about Atlas Search, and to view more query examples, see the | |
| :atlas:`Atlas Search documentation </atlas-search>`. |
|
|
caseyclements
suggested changes
Mar 17, 2025
source/atlas-search.txt
Outdated
| Overview | ||
| -------- | ||
|
|
||
| In this guide, you can learn how to query an Atlas Search index and use advanced search |
There was a problem hiding this comment.
and use advanced full-text search..
Hey @caseyclements, I changed the code example to use compound but I'm not 100% sure what you meant about the closing brace. Since the code example was changed, hopefully the brace works now (I ran the code and it returns the expected result) but please let me know if any of the closing braces look incorrect still! |
mcmorisi
pushed a commit
that referenced
this pull request
Apr 1, 2025
(cherry picked from commit 40bf3de)
mcmorisi
pushed a commit
that referenced
this pull request
Apr 1, 2025
(cherry picked from commit 40bf3de)
mcmorisi
pushed a commit
that referenced
this pull request
Apr 1, 2025
(cherry picked from commit 40bf3de)
mcmorisi
pushed a commit
that referenced
this pull request
Apr 1, 2025
(cherry picked from commit 40bf3de)
mcmorisi
pushed a commit
that referenced
this pull request
Apr 1, 2025
(cherry picked from commit 40bf3de)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-37545
Staging Links
Self-Review Checklist