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-33414 Add section on FTS to RQL reference #3188

Merged
merged 8 commits into from
Mar 1, 2024
Merged

DOCSP-33414 Add section on FTS to RQL reference #3188

merged 8 commits into from
Mar 1, 2024

Conversation

lindseymoore
Copy link
Collaborator

@lindseymoore lindseymoore commented Feb 28, 2024 •
edited
Loading

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-33414

  • Realm Query Language: Update overall code examples with FTS annotation on Item.name property. Add section on FTS. Behind the scenes, started a new RQL test file to reflect new JSv12 standards.

Reminder Checklist

Before merging your PR, make sure to check a few things.

  • Did you tag pages appropriately?
    • genre
    • meta.keywords
    • meta.description
  • Describe your PR's changes in the Release Notes section
  • Create a Jira ticket for related docs-app-services work, if any

Release Notes

Other

  • Realm Query Language: Update RQL reference with information on querying with full-text search.

Review Guidelines

REVIEWING.md

cbullinger
cbullinger requested changes Feb 29, 2024
View reviewed changes
Copy link
Collaborator

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

Some corrections needed

source/realm-query-language.txt Outdated Show resolved Hide resolved
source/realm-query-language.txt Outdated Show resolved Hide resolved
source/realm-query-language.txt
@@ -905,7 +943,7 @@ To query geospatial data:

1. Create an object with a property containing the embedded geospatial data.
2. Define the geospatial shape to set the boundary for the query.
3. Query using the GEOWITHIN RQL operator.
3. Query using the ``geoWithin`` RQL operator.
Copy link
Collaborator

Choose a reason for hiding this comment

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

is RQL case-sensitive? I used all caps in the Kotlin examples...I guess that should be updated for consistency?

Copy link
Collaborator Author

@lindseymoore lindseymoore Mar 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

According to this design doc, seems to be camel case? https://docs.google.com/document/d/1Z7CK79CqebEtVllVHTNEq8neKhoMWeFCDjKBrn_pq1Y/edit#heading=h.2s9zdv6a57gn
Perhaps I can create a quick win ticket to update these examples?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Created!: https://jira.mongodb.org/browse/DOCSP-37318

source/realm-query-language.txt Outdated Show resolved Hide resolved
source/realm-query-language.txt Outdated Show resolved Hide resolved
source/realm-query-language.txt Outdated Show resolved Hide resolved
source/realm-query-language.txt Show resolved Hide resolved
examples/node/v12/__tests__/realm-query-language.test.js Outdated Show resolved Hide resolved
examples/dart/test/task_project_models_test.dart Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 1, 2024 •
edited
Loading

Readability for Commit Hash: 0d3dd32

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

  • source/sdk/dotnet/model-data/define-object-model: Grade Level: 9.3, Reading Ease: 55.95
  • source/sdk/dotnet/crud/filter: Grade Level: 8.5, Reading Ease: 57.87

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score Difficulty
90-100 Very Easy
80-89 Easy
70-79 Fairly Easy
60-69 Medium
50-59 Fairly Hard
30-49 Hard
0-29 Very Hard

For help improving readability, try Hemingway App.

cbullinger
cbullinger approved these changes Mar 1, 2024
View reviewed changes
Copy link
Collaborator

@cbullinger cbullinger left a comment

Choose a reason for hiding this comment

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

a few suggestions, but lgtm! Also, should we plan to eventually get all of the RQL examples in the new v12 file(s)?

source/realm-query-language.txt Show resolved Hide resolved
source/realm-query-language.txt Outdated Show resolved Hide resolved
source/sdk/dotnet/model-data/define-object-model.txt Show resolved Hide resolved
source/realm-query-language.txt Show resolved Hide resolved
source/realm-query-language.txt
@@ -919,8 +961,8 @@ see the geospatial documentation for your SDK:
- :ref:`Flutter SDK <flutter-data-types-geospatial>`
- :ref:`Kotlin SDK <kotlin-geospatial>`
Copy link
Collaborator

Choose a reason for hiding this comment

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

I updated the Read page with info on querying geo data. it's probably a more appropriate link here ... but I'm realizing that I didn't add a ref anchor to the section so nm 🤷

@lindseymoore
Copy link
Collaborator Author

lindseymoore commented Mar 1, 2024 •
edited
Loading

Have a ticket here to update the rest of the RQL examples @cbullinger : https://jira.mongodb.org/browse/DOCSP-36298.
I would consider it low priority since the examples still work, but definitely would be nice to migrate them over to the new file eventually. Will include a comment in legacy file that tests for new RQL operators should be added to the new test file in v12 folder.

@lindseymoore lindseymoore merged commit fcf5752 into mongodb:master Mar 1, 2024
10 checks passed
@docs-builder-bot
Copy link

docs-builder-bot commented Mar 1, 2024 •
edited
Loading

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

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

@cbullinger cbullinger cbullinger 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
@lindseymoore @docs-builder-bot @cbullinger