Skip to content

DOCSP-30419: manage search indexes #709

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
Merged
merged 5 commits into from
Jul 10, 2023
Merged

DOCSP-30419: manage search indexes #709

merged 5 commits into from
Jul 10, 2023

Conversation

rustagir
Copy link
Collaborator

@rustagir rustagir commented Jul 7, 2023 •
edited
Loading

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-30419
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-30419-searchindexes-api/fundamentals/indexes/#search-indexes

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working? API links wont work until source constnt is bumped to 5.7

@rustagir
Copy link
Collaborator Author

rustagir commented Jul 7, 2023

I'm unsure if these sections are necessary, or if we should link out to the Atlas documentation. Didn't want to delete Nick's work done on this page previously without asking the reviewer.

mongoKart
mongoKart requested changes Jul 10, 2023
View reviewed changes
Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

Nice job! Just a few small things.

source/fundamentals/indexes.txt Outdated

.. literalinclude:: /code-snippets/indexes/listIndexes.js
Starting in version 5.7 of the {+driver-short+}, you can manage your
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: I'm not sure if there's a rule about this, but I shy away from the "starting in version..." language. This should only be visible from the 5.7 docs and up anyway.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

removed

source/fundamentals/indexes.txt Outdated
Comment on lines 346 to 347
Starting in version 5.7 of the {+driver-short+}, you can manage your
Search indexes using the following methods:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I: using

S:

Suggested change
Starting in version 5.7 of the {+driver-short+}, you can manage your
Search indexes using the following methods:
Starting in version 5.7 of the {+driver-short+}, you can use the
following methods to manage your Search indexes:

source/fundamentals/indexes.txt Outdated
The following sections provide example code using each of the preceding
methods to manage Search indexes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The following sections provide example code using each of the preceding
methods to manage Search indexes.
The following sections provide code samples that use each of the preceding
methods to manage Search indexes.

source/fundamentals/indexes.txt Outdated
When connecting to {+mdb-server+} version 7.0 or later, you can use the new `listSearchIndexes()
<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__
You can use the `listSearchIndexes()
<{+api+}/classes/Collection.html#listSearchIndexes>`__
method to return a cursor that contains the search indexes of a given
Copy link
Collaborator

Choose a reason for hiding this comment

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

"search index" is capitalized everywhere else

source/fundamentals/indexes.txt Outdated
The following sections provide example code using each of the preceding
methods to manage Search indexes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: Maybe a minor thing, but there's no example for createSearchIndexes()

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

there should be -- investigating why the example isnt showing

source/fundamentals/indexes.txt Outdated
The following sections provide example code using each of the preceding
methods to manage Search indexes.

Create Search Indexes
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: Change each section title to match the method it's demonstrating. So this one would be "Create a Search Index". Applies to all these sections.

@rustagir rustagir force-pushed the DOCSP-30419-searchindexes-api branch from 6e838b2 to aa88277 Compare July 10, 2023 17:12
@rustagir rustagir force-pushed the DOCSP-30419-searchindexes-api branch from aa88277 to f6067cd Compare July 10, 2023 17:16
@rustagir rustagir requested a review from mongoKart July 10, 2023 17:20
mongoKart
mongoKart approved these changes Jul 10, 2023
View reviewed changes
Copy link
Collaborator

@mongoKart mongoKart left a comment

Choose a reason for hiding this comment

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

lgtm!

@rustagir rustagir merged commit 3cb535b into mongodb:master Jul 10, 2023
rustagir added a commit that referenced this pull request Jul 10, 2023
@rustagir
DOCSP-30419: manage search indexes (#709)
8debaa0 
* DOCSP-30419: manage search indexes

* fix literalinclude

* MW PR fixes 1

* include fix

* wn fix

(cherry picked from commit 3cb535b)
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
@rustagir @mongoKart
DOCSP-30419: manage search indexes (mongodb#709)
a61c877 
* DOCSP-30419: manage search indexes

* fix literalinclude

* MW PR fixes 1

* include fix

* wn fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mongoKart mongoKart mongoKart 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.
2 participants
@rustagir @mongoKart