(DOCSP-39539): Consolidate Stream Data to Atlas page #3268

dacharyc · 2024-05-21T21:45:16Z

Pull Request Info - SDK Docs Consolidation

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

Staged Page

Stream Data to Atlas: Draft consolidated page

Page Source

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
Include .rst files comply with the naming guidelines

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

github-actions · 2024-05-21T21:46:31Z

Readability for Commit Hash: 178f5af

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

Readability scores for changed documents:

source/sdk/files/configure-and-open: Grade Level: 7.3, Reading Ease: 66.44
source/sdk/sync/stream-data-to-atlas: Grade Level: 9.9, Reading Ease: 48.91

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.

## Pull Request Info Jira ticket: https://jira.mongodb.org/browse/DOCSP-39161 - [Connect to App Services Backend](https://preview-mongodblindseymoore.gatsbyjs.io/realm/DOCSP-39161/sdk/dotnet/app-services/connect-to-app-services-backend/) - Note: Commented out failing tests. Fixing them will be a part of this ticket: https://jira.mongodb.org/browse/DOCSP-39638. ### Reminder Checklist Before merging your PR, make sure to check a few things. - [ ] Did you tag pages appropriately? - genre - meta.keywords - meta.description - [x] Describe your PR's changes in the Release Notes section - [ ] Create a Jira ticket for related docs-app-services work, if any ### Release Notes  - .NET SDK - Application Services/Connect to an App Services App: Add a section on updating the base URL during runtime. ### Review Guidelines [REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md) --------- Co-authored-by: MongoCaleb <caleb.thompson@mongodb.com>

cbullinger

Overall, looks good 👍

source/includes/api-details/cpp/sync/stream-data-define-asymmetric-object-description.rst

cbullinger · 2024-05-22T13:55:25Z

source/includes/api-details/cpp/sync/stream-data-open-database-description.rst

+database for Data Ingest, you *must* specify the ``asymmetric_object`` types
+you want to sync.
+
+.. tip:: Mixed Object and Asymmetric Object Types


this really doesn't seem like a tip to me. I'd argue it should be incorporated into the above copy.

I don't have a strong opinion about this. But I think it gets into subjective editorializing, which I don't think we necessarily have time to do as part of this project given the massive chunk of work that it represents. I think we should avoid rewriting/editing as much as possible, unless it's required to make the consolidated content work on the page.

source/includes/api-details/csharp/sync/stream-data-create-asymmetric-objects-description.rst

cbullinger · 2024-05-22T14:03:02Z

source/sdk/sync/stream-data-to-atlas.txt

+         .. tab::
+            :tabid: csharp
+
+            .. include:: /includes/dotnet-asymmetric-object.rst


if we're going for consistency: this include doesn't have "For more information on how to define an asymmetric object, refer to Define an Asymmetric Object." link, like all the others do.

That's because it's an include that is also used on the data modeling page relative to asymmetric objects.

I guess I can remove it from here and just put a link out to the "define" page similar to the other SDKs.

cbullinger · 2024-05-22T14:05:49Z

source/includes/sdk-examples/sync/stream-data-open-synced-database.rst

+     - id: dart
+       content: |
+
+         .. literalinclude:: /examples/generated/flutter/open_flexible_sync_realm_test.snippet.open-flexible-sync-realm.dart


this snippet references a Tricycle object in the schema instead of the WeatherSensor

This is the snippet that's currently live on the page. I would guess it got updated and we didn't realize it was used in more than one place. I'll make a ticket in the Flutter Gaps epic to address this. 👍

source/sdk/sync/stream-data-to-atlas.txt

cbullinger · 2024-05-22T14:53:01Z

source/includes/api-details/swift/sync/stream-data-open-synced-database-description.rst

@@ -0,0 +1,14 @@
+Specify the ``AsymmetricObject`` types you want to sync.
+
+.. note:: Mixed Synced and Non-Synced Databases in Projects


are there any other restrictions in other SDKs re. mixing non- and asymmetric objects? or synced and non-synced dbs?

When I talked to engineering about it, it seemed like this was an issue specific to Swift and its use of reflection to infer realm/object schemas.

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

docs-builder-bot · 2024-05-24T21:40:21Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/feature-consolidated-sdk-docs/

🪵 Logs

job log: a0659fc2accda5b4f9e33c6206f461d333f16ade

Draft Stream Data to Atlas page

87c5333

dacharyc added the merge to feature branch Unreleased feature - do not merge to Master label May 21, 2024

dacharyc and others added 7 commits May 21, 2024 17:49

Remove 'Realm' from .NET App ID placeholder

2600e18

Fix snooty build errors

9353a05

Fix snooty build error

7b6468d

Fix snooty build error

8182182

Fix incorrect code block and broken Kotlin API reference links

f28dc05

Update C++ tab ID to use new tab group ID

7c4b40d

cbullinger approved these changes May 22, 2024

View reviewed changes

dacharyc and others added 2 commits May 24, 2024 17:12

Apply suggestions from review

42c4ed1

Co-authored-by: cbullinger <115956901+cbullinger@users.noreply.github.com>

Incorporate review feedback

178f5af

dacharyc merged commit a0659fc into mongodb:feature-consolidated-sdk-docs May 24, 2024
6 checks passed

dacharyc deleted the DOCSP-39539 branch May 24, 2024 21:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(DOCSP-39539): Consolidate Stream Data to Atlas page #3268

(DOCSP-39539): Consolidate Stream Data to Atlas page #3268

dacharyc commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading

cbullinger left a comment

cbullinger May 22, 2024

dacharyc May 24, 2024

cbullinger May 22, 2024

dacharyc May 24, 2024

cbullinger May 22, 2024

dacharyc May 24, 2024

cbullinger May 22, 2024

dacharyc May 24, 2024

docs-builder-bot commented May 24, 2024

		@@ -0,0 +1,14 @@
		Specify the ``AsymmetricObject`` types you want to sync.

		.. note:: Mixed Synced and Non-Synced Databases in Projects

(DOCSP-39539): Consolidate Stream Data to Atlas page #3268

(DOCSP-39539): Consolidate Stream Data to Atlas page #3268

Conversation

dacharyc commented May 21, 2024 • edited Loading

Pull Request Info - SDK Docs Consolidation

PR Author Checklist

Naming

Links and Refs

Content

Reviewer Checklist

github-actions bot commented May 21, 2024 • edited Loading

cbullinger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

docs-builder-bot commented May 24, 2024

🪵 Logs

dacharyc commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024 •

edited

Loading