Skip to content

DOCSP-17260 Direct Text Search traffic to Atlas Search #5946

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.

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

Merged
merged 6 commits into from
Oct 19, 2021

Conversation

kanchana-mongodb
Copy link
Contributor

@kanchana-mongodb kanchana-mongodb commented Oct 7, 2021

@kanchana-mongodb kanchana-mongodb force-pushed the DOCSP-17260 branch 6 times, most recently from f7b279a to 0b04fa2 Compare October 7, 2021 15:45
Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo left a comment

Choose a reason for hiding this comment

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

Hey @kanchana-mongodb , left some suggestions. Mostly minor, but did have one refactoring idea to consider.

Jeff


Language Support
----------------
Users running MongoDB software locally can find information on the
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] Suggest removing "software".

Language Support
----------------
Users running MongoDB software locally can find information on the
legacy text search here:
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

Can we reword this to be a bit more active, as in:

"To learn more about legacy text search for self-managed deployments, see: "


.. code-block:: javascript

db.stores.insert(
Copy link
Collaborator

Choose a reason for hiding this comment

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

the "insert" method is deprecated. Please make this "insertMany".


For example you can run the following in :binary:`~bin.mongosh` to
allow text search over the ``name`` and ``description`` fields:
You can run the following in :binary:`~bin.mongosh` to allow text
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggest removing "You can" and being more direct. "Run the following command in...

@@ -39,6 +39,51 @@ operators, including restrictions and behavior, see:

- :expression:`$meta` projection operator

Exact Phrase
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm a little concerned about the discoverability of these examples. It seems slightly out of place to have them tucked under the "Query Framework" section. These seem like critical use cases we should be highlighting to users.

What if we:

  • Moved these examples to the Text Indexes page
  • Renamed the Text Indexes page to something like "[Perform|Configure] Text Search", to help avoid confusion with the other Text Indexes page.
  • Phrase these section titles more like tasks, so it's clearer what users can do. For example, make this first section "Search for an Exact Phrase"

Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo left a comment

Choose a reason for hiding this comment

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

Thanks @kanchana-mongodb ! I really like the new structure. Just some quick thoughts on the headings / organization and then I think this is all set.


.. default-domain:: mongodb

.. include:: /includes/fact-text-index.rst
Overview
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggest removing the "Overview" heading. I don't think it adds much here.


.. _text-index-eg:

Example
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe make this "Examples" since there are several examples in this section.

Copy link
Collaborator

@jeff-allen-mongo jeff-allen-mongo left a comment

Choose a reason for hiding this comment

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

LGTM

@andrewad
Copy link
Contributor

Text Search page LGTM

However on the "Text Indexes" / "Perform a Text Search" and "Text Search Operators" pages can we also update these with similar framing, namely that "MongoDB offers a premium full-text search solution, MongoDB Atlas Search, for MongoDB Atlas users and a legacy text search capability for self-managed deployments up top." and incorporate the word "Legacy" in the titles "Text Search Operators (Legacy)" and "Perform a Text Search (Legacy)" or similar?

@kanchana-mongodb
Copy link
Contributor Author

Text Search page LGTM

However on the "Text Indexes" / "Perform a Text Search" and "Text Search Operators" pages can we also update these with similar framing, namely that "MongoDB offers a premium full-text search solution, MongoDB Atlas Search, for MongoDB Atlas users and a legacy text search capability for self-managed deployments up top." and incorporate the word "Legacy" in the titles "Text Search Operators (Legacy)" and "Perform a Text Search (Legacy)" or similar?

@andrewad Updated. Can you please take a look and let me know if changes look ok? Thanks!

@andrewad
Copy link
Contributor

LGTM but one final comment for all three pages:
Can we have "MongoDB Atlas Search" link to https://docs.atlas.mongodb.com/atlas-search/

@jason-price-mongodb
Copy link
Contributor

Kanchana said Jeff was okay with all the changes, so will squash and merge.

@jason-price-mongodb jason-price-mongodb merged commit 7eb1e97 into mongodb:master Oct 19, 2021
mongo-cr-bot pushed a commit that referenced this pull request Jan 19, 2022
* DOCSP-17260 Direct Text Search traffic to Atlas Search (#5946)

* DOCSP-17260 Direct Text Search traffic to Atlas Search

* DOCSP-17260 updates for copy review feedback

* DOCSP-17260 2nd round of updates for copy review feedback

* DOCSP-17260 updates for review feedback

* DOCSP-17260 added link to search and intro to two more pages

* DOCSP-17260 addressing Jenny's feedback comments

* fix text search url

Co-authored-by: kanchana-mongodb <54281287+kanchana-mongodb@users.noreply.github.com>
mongo-cr-bot pushed a commit that referenced this pull request Jan 23, 2024
* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

* DOCSP-27736-sql-error

---------

Co-authored-by: jason-price-mongodb <jshfjghsdfgjsdjh@aolsdjfhkjsdhfkjsdf.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants