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-39514): Consolidate Read page #3357

Merged
merged 38 commits into from
Aug 16, 2024

Conversation

dacharyc
Copy link
Collaborator

@dacharyc dacharyc commented Aug 5, 2024

Pull Request Info - SDK Docs Consolidation

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

Staged Page

  • Read
  • Read Properties
  • Fluent Interface (Java SDK): Port content, update Realm naming, and change to use the Drivers tab languages so it preserves a language selection when clicking into the page
  • LINQ (.NET SDK): Port LINQ content, update Realm naming, omit stuff about querying with RQL as that is generally surfaced in the C# API descriptions on the Read 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

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
  • Update any Kotlin API links to use the new Kotlin SDK roles

Content

  • Shared code boxes have snippets or placeholders for all 9 languages
  • API description sections have API details or a generic placeholder for all 9 languages
  • Check related pages for relevant content to include
  • Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic

Reviewer Checklist

As a reviewer, please check these items:

  • Shared code example boxes contain language-specific snippets or placeholders for every language
  • API reference details contain working API reference links or generic content
  • 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 Aug 5, 2024
Copy link

netlify bot commented Aug 5, 2024

Deploy Preview for device-sdk ready!

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

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

github-actions bot commented Aug 5, 2024

Readability for Commit Hash: e83ab6f

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

Readability scores for changed documents:

  • source/sdk/quick-start: Grade Level: 8.8, Reading Ease: 51.85
  • source/sdk/crud: Grade Level: 14.6, Reading Ease: 31.21
  • source/sdk/sync/manage-sync-subscriptions: Grade Level: 8.2, Reading Ease: 58.79
  • source/sdk/crud/read: Grade Level: 9.1, Reading Ease: 56.25
  • source/sdk/crud/query-engines: Grade Level: 20.1, Reading Ease: -15.5
  • source/sdk/crud/read/read-properties: Grade Level: 7.6, Reading Ease: 60.31
  • source/sdk/crud/query-engines/filter-data-java-sdk: Grade Level: 9.4, Reading Ease: 55.64
  • source/sdk/crud/query-engines/filter-data-swift-sdk: Grade Level: 10.0, Reading Ease: 48.5
  • source/sdk/crud/query-engines/realm-query-language: Grade Level: 9.7, Reading Ease: 49.41
  • source/sdk/crud/query-engines/filter-data-linq: Grade Level: 10.3, Reading Ease: 47.89
  • source/sdk/model-data/property-types: Grade Level: 8.9, Reading Ease: 40.72

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.

@dacharyc dacharyc marked this pull request as ready for review August 12, 2024 21:54
@dacharyc dacharyc merged commit ad32aa9 into mongodb:feature-consolidated-sdk-docs Aug 16, 2024
10 checks passed
@dacharyc dacharyc deleted the DOCSP-39514 branch August 16, 2024 19:12
@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.

2 participants