Skip to content

DOCSP-19125 Direct Regex Search traffic to Atlas Search #6038

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 3 commits into from
Nov 5, 2021

Conversation

kanchana-mongodb
Copy link
Contributor

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

@eshwer
Copy link

eshwer commented Oct 26, 2021

LGTM

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. This largely looks good. I've left some comments for your consideration. Let me know if you want to discuss anything.

Thanks!
Jeff

ref: fact-regex-search-legacy-atlas
content: |

MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Copy link
Collaborator

Choose a reason for hiding this comment

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

[question]

Is using the word "premium" a requirement? If possible, I'd like to drop it to bring the marketing tone down a bit.

ref: fact-regex-search-legacy-atlas
content: |

MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

I'd suggest only having the linked text be "MongoDB Atlas Search", rather than including "premium full-text search solution" in the link. I think reducing the amount of blue text will make this a bit more readable.

Comment on lines 17 to 18
use the :pipeline:`$search` aggregation pipeline stage. :atlas:`Atlas
Search queries </reference/atlas-search/searching/>` significiantly
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't love starting the page with a dense block of copy. Maybe we should break this up a bit.

Suggested change
use the :pipeline:`$search` aggregation pipeline stage. :atlas:`Atlas
Search queries </reference/atlas-search/searching/>` significiantly
use the :pipeline:`$search` aggregation pipeline stage.
:atlas:`Atlas Search queries </reference/atlas-search/searching/>` significiantly

MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Atlas Search </atlas-search/>`, for data hosted on :atlas:`MongoDB
Atlas </>`. If you frequently run case-insensitive regex queries
(utilizing the ``i`` option), we recommend Atlas Search queries that
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should avoid "we" because it can be a little unclear who is implied by "we". As in, is it "we as writers", "we the MongoDB company" ?

Suggested change
(utilizing the ``i`` option), we recommend Atlas Search queries that
(utilizing the ``i`` option), consider using Atlas Search queries that

content: |

MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Atlas Search </atlas-search/>`, for data hosted on :atlas:`MongoDB
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider flipping the order of these phrases so users know immediately whether this is relevant to them.

"For data hosed on MongoDB Atlas, MongoDB offers..."

Search queries </reference/atlas-search/searching/>` significiantly
improve the performance of text queries and offer more options for
customizing query parameters. To learn more, see :atlas:`MongoDB
Atlas Search </atlas-search/>`. For self-managed deployments, you
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider separating this out with bullets, one for Atlas-managed deployments and one for self-managed deployments.

- For data hosed on MongoDB Atlas, MongoDB offers...

- For self-managed deployments, you can...

Comment on lines 4 to 7
MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Atlas Search </atlas-search/>`, for data hosted on :atlas:`MongoDB
Atlas </>`. A legacy text search capability is available for users
self-managing MongoDB deployments.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we consider a similar parallelized bulleted approach here?

- For data hosed on MongoDB Atlas, MongoDB offers...

- For self-managed deployments,  MongoDB offers legacy text search capability.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't want to start the page with bullet points. So, created separate paragraphs. Hope this looks ok.

Copy link
Collaborator

Choose a reason for hiding this comment

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

That makes sense!

ref: fact-text-search-legacy-atlas
content: |

MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Copy link
Collaborator

Choose a reason for hiding this comment

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

[minor] Can we drop "premium" here as well?

Comment on lines 4 to 7
MongoDB offers a :atlas:`premium full-text search solution, MongoDB
Atlas Search </atlas-search/>`, for data hosted on :atlas:`MongoDB
Atlas </>`. A legacy text search capability is available for users
self-managing MongoDB deployments.
Copy link
Collaborator

Choose a reason for hiding this comment

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

That makes sense!

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 with minor suggestions.

ref: fact-regex-search-legacy-atlas
content: |

**For data hosted on** :atlas:`MongoDB Atlas </>`, MongoDB offers a
Copy link
Collaborator

Choose a reason for hiding this comment

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

[suggestion]

This was a little visually jarring when I first loaded the page. I think we'd be better off dropping the link to the Atlas docs and bolding the entire "For data hosted on MongoDB Atlas".

Suggested change
**For data hosted on** :atlas:`MongoDB Atlas </>`, MongoDB offers a
**For data hosted on MongoDB Atlas**, MongoDB offers a

@jeff-allen-mongo jeff-allen-mongo merged commit 0076157 into mongodb:master Nov 5, 2021
mongo-cr-bot pushed a commit that referenced this pull request Jan 30, 2024
…5927) (#6038)

* DOCSP-35753-serverStatus-metric-stepDown-moved-to-stateTransaction

* DOCSP-35753: Adding stateTransition object for replication stepDown info. Deprecating stepDown metric and linking to new object.

* Empty-Commit

* DOCSP-35753: Removing references to unsupported previous behavior. Added missing heading for lasteStateTransaction. Modified language per style guide.

* DOCSP-35753: Fixing monospace issue.

* DOCSP-35753: Typo fix

* DOCSP-35753: Small editorial changes per feedback.
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.

3 participants