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.

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

(DOCSP-39519): Port Swift Filter Data page for consolidated docs #3349

Merged

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Jul 31, 2024

Pull Request Info - SDK Docs Consolidation

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

This is a port of the existing Swift page - we decided to maintain these SDK-specific query engines as one-off pages because they are too dissimilar to consolidate. I have updated the Realm naming and refs to use the sdk ref targets.

I switched from the Realm languages tab group to the Drivers tab group, so if someone has selected "Swift" or "Objective-C" from another page, I believe the selection should carry over. There are some examples that don't exist or apply in the other language, so if you have selected "Swift" you will still see some Objective-C examples in the NSPredicate part of the page, and if you have selected Objective-C, you will still see the entire Swift Type-Safe Query API and some Swift examples in the NSPredicate part of the page. I don't plan to go back and address these or add "missing example" placeholders, because it's the same behavior as the existing page. But I could be convinced otherwise if a reviewer feels strongly.

Staged Page

Page Source

Add links to every SDK's pages where you got the SDK-specific information:

PR Author Checklist

Before requesting a review for your PR, please check these items:

  • Open the PR against the feature-consolidated-sdk-docs branch instead of master
  • Tag the consolidated page for:
    • genre
    • meta.keywords
    • meta.description

Naming

  • Update Realm naming and the language around persistence layer/local/device per this document

Links and Refs

  • Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
  • Remove or update any SDK-specific refs to use the new consolidated SDK ref targets

Reviewer Checklist

As a reviewer, please check these items:

  • Realm naming/language has been updated
  • All relevant content from individual SDK pages is present on the consolidated page

@dacharyc dacharyc added the merge to feature branch Unreleased feature - do not merge to Master label Jul 31, 2024
Copy link

netlify bot commented Jul 31, 2024

Deploy Preview for device-sdk ready!

Name Link
🔨 Latest commit 5ff97d7
🔍 Latest deploy log https://app.netlify.com/sites/device-sdk/deploys/66aa4a01fbd7d9000818244e
😎 Deploy Preview https://deploy-preview-3349--device-sdk.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 31 (🟢 up 6 from production)
Accessibility: 92 (🔴 down 1 from production)
Best Practices: 75 (no change from production)
SEO: 62 (🔴 down 7 from production)
PWA: -
View the detailed breakdown and full score reports

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

Copy link

github-actions bot commented Jul 31, 2024

Readability for Commit Hash: 5ff97d7

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

Readability scores for changed documents:

  • source/sdk/crud/read: Grade Level: 8.3, Reading Ease: 53.07
  • source/sdk/crud/query-engines/filter-data-swift-sdk: Grade Level: 10.0, Reading Ease: 48.5

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.

Copy link
Collaborator

@krollins-mdb krollins-mdb left a comment

Choose a reason for hiding this comment

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

I think you took the right approach with this page. No need to add missing example placeholders.

And no suggestions from me on this one! 🥇

@dacharyc dacharyc merged commit 08af422 into mongodb:feature-consolidated-sdk-docs Aug 8, 2024
10 checks passed
@dacharyc dacharyc deleted the DOCSP-39519 branch August 8, 2024 15:46
@docs-builder-bot
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge to feature branch Unreleased feature - do not merge to Master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants