Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOCSP-45930 Atlas Search Query Prep #705

Merged
merged 10 commits into from
Dec 20, 2024
Merged

DOCSP-45930 Atlas Search Query Prep #705

merged 10 commits into from
Dec 20, 2024

Conversation

ajhuh-mdb
Copy link
Collaborator

@ajhuh-mdb ajhuh-mdb commented Dec 12, 2024 •
edited
Loading

DESCRIPTION

  • Edit Compass Atlas Search Query page to:
    • Have more neutral wording that works for both Data Explorer & Compass
    • Add Before You Begin section
    • Clean up procedures.

Other fixes to resolve some final build errors in https://github.com/10gen/cloud-docs/pull/6554:

  • Updated some copy & screenshots on schema page, so they are easily reproducible for Data Explorer and reflect current terminology (e.g. number is referred to int32)
  • Changed a manual link to the transactions page since it seems to conflict with another Atlas page.
  • Marked the export-agg-builder-results page as Compass-only

STAGING

https://deploy-preview-705--docs-compass.netlify.app/query/atlas-search/

JIRA

https://jira.mongodb.org/browse/DOCSP-45930

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Is this free of spelling errors?
  • Is this free of grammatical errors?
  • Is this free of staging / rendering issues?
  • Are all the links working?

External Review Requirements

What's expected of an external reviewer?

@netlify Netlify
Copy link

netlify bot commented Dec 12, 2024 •
edited
Loading

✅ Deploy Preview for docs-compass ready!

Name Link
🔨 Latest commit 4d2b195
🔍 Latest deploy log https://app.netlify.com/sites/docs-compass/deploys/6765b464917d74000804afb2
😎 Deploy Preview https://deploy-preview-705--docs-compass.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ajhuh-mdb
ajhuh-mdb commented Dec 12, 2024
View reviewed changes
source/indexes.txt
@@ -97,8 +95,6 @@ Atlas Vector Search indexes enable you to index vector data *and* other data
types, which facilitates semantic searches on the indexed fields. For more
information, see :ref:`compass-create-vector-search`.
Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Dec 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Atlas docs, this ref and the ref above will link to the corresponding Atlas Search & Vector Search Index creation pages.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Atlas Vector Search page link: https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-type/#create-an-atlas-vector-search-index

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this link will be swapped out in https://github.com/10gen/cloud-docs/pull/6554 since the change will only pertain to Data Explorer

ajhuh-mdb
ajhuh-mdb commented Dec 12, 2024
View reviewed changes
source/indexes.txt
@@ -81,8 +81,6 @@ Create an Index

.. include:: /includes/shared/steps/create-index.rst

.. BEGIN-COMPASS-ONLY

Create an Atlas Search Index
Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Dec 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're restoring this information here, so users on Data Explorer are directed to the correct place to create Search/Vector Search indexes.

Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Dec 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a Search Index Page for Atlas: https://www.mongodb.com/docs/atlas/atlas-search/create-index/

Copy link
Collaborator Author

@ajhuh-mdb ajhuh-mdb Dec 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this link will be swapped out in https://github.com/10gen/cloud-docs/pull/6554 since the change will only pertain to Data Explorer

sarah-olson-mongodb
sarah-olson-mongodb approved these changes Dec 12, 2024
View reviewed changes
Copy link
Collaborator

@sarah-olson-mongodb sarah-olson-mongodb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @ajhuh-mdb. These LGTM with a couple minor suggestions!

source/query/atlas-search.txt Outdated Show resolved Hide resolved
source/query/atlas-search.txt Outdated Show resolved Hide resolved
source/query/atlas-search.txt Outdated Show resolved Hide resolved
betsybutton
betsybutton reviewed Dec 17, 2024
View reviewed changes
Copy link

@betsybutton betsybutton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Ali! Just a few comments

source/query/atlas-search.txt Outdated Show resolved Hide resolved
source/query/atlas-search.txt Outdated Show resolved Hide resolved
betsybutton
betsybutton reviewed Dec 20, 2024
View reviewed changes
source/query/atlas-search.txt Outdated Show resolved Hide resolved
source/query/atlas-search.txt
Comment on lines +60 to +61
If you use the ``$search``, ``$searchMeta``, or ``$vectorSearch``
stage, it must be the first stage in your aggregation pipeline.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is mostly true, but hybrid search is an exception when both vector and full-text search are used in the same pipeline: https://www.mongodb.com/docs/atlas/atlas-search/tutorial/hybrid-search/

Is this worth calling out here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted in Slack that this will be addressed in a follow-up ticket!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Filed a followup: https://jira.mongodb.org/browse/DOCSP-46151

betsybutton
betsybutton approved these changes Dec 20, 2024
View reviewed changes
Copy link

@betsybutton betsybutton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ajhuh-mdb ajhuh-mdb merged commit 3e81f2c into mongodb:master Dec 20, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@betsybutton betsybutton betsybutton approved these changes

@sarah-olson-mongodb sarah-olson-mongodb sarah-olson-mongodb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ajhuh-mdb @betsybutton @sarah-olson-mongodb