Merge branch 'feature-consolidated-sdk-docs' into DOCSP-39503

Author: dacharyc

.github/pull_request_template-base.md

@@ -0,0 +1,26 @@
+## Pull Request Info
+
+Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
+
+### Staged Pages
+
+- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): description of changes
+
+### Reminder Checklist
+
+Before merging your PR, did you:
+
+- [ ] Describe your PR's changes in the Release Notes section
+- [ ] Create a Jira ticket for related docs-app-services work, if any
+
+### Release Notes
+
+<!--
+- **Kotlin** SDK
+  - Realm/Manage Realm Files/Encrypt a Realm: Add information on encryption for
+    local and synced realms.
+-->
+
+### Review Guidelines
+
+[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)

.github/pull_request_template.md

@@ -1,28 +1,47 @@
-## Pull Request Info
+## Pull Request Info - SDK Docs Consolidation
 
 Jira ticket: https://jira.mongodb.org/browse/DOCSP-NNNNN
 
-- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/): description of changes
+*Staged Page*
 
-### Reminder Checklist
+- [PAGE_NAME](https://docs-mongodbcom-staging.corp.mongodb.com/realm/docsworker-xlarge/BRANCH_NAME/)
 
-Before merging your PR, make sure to check a few things.
+*Page Source*
 
-- [ ] Did you tag pages appropriately?
+Add links to every SDK's pages where you got the SDK-specific information:
+
+- [PAGE_NAME](https://www.mongodb.com/docs/atlas/device-sdks/LIVE-DOCS-LINK)
+
+### 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
-- [ ] Describe your PR's changes in the Release Notes section
-- [ ] Create a Jira ticket for related docs-app-services work, if any
 
-### Release Notes
+#### Naming
+- [ ] Update Realm naming and the language around persistence layer/local/device per [this document](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing)
+- [ ] Include `.rst` files comply with [the naming guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9)
+
+#### 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](https://jira.mongodb.org/browse/DOCSP-32519) 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
 
-<!--
-- **Kotlin** SDK
-  - Realm/Manage Realm Files/Encrypt a Realm: Add information on encryption for
-    local and synced realms.
--->
+### Reviewer Checklist
 
-### Review Guidelines
+As a reviewer, please check these items:
 
-[REVIEWING.md](https://github.com/mongodb/docs-realm/blob/master/REVIEWING.md)
+- [ ] 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/workflows/bluehawk.yml

@@ -10,5 +10,5 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v1
         with:
-          node-version: 15.x
+          node-version: 18.x
       - run: npx bluehawk check -i "*.md" -i "*.properties" -i "*.lock" examples tutorial

.github/workflows/check-links.yml

@@ -1,9 +1,9 @@
 name: Check All Links for Errors
 
 on:
-  push:
-    paths:
-      - "source/**"
+  pull_request:
+      paths:
+        - "source/**"
 
 jobs:
   check:

.github/workflows/check-redirects.yml

@@ -1,10 +1,10 @@
-name: Check All Links for Errors
+name: Check For Bad Redirects
 
 on:
     pull_request:
         paths:
         - "source/**"
-  
+
 jobs:
     check:
         runs-on: ubuntu-latest

.github/workflows/readability.yml

@@ -14,7 +14,7 @@ jobs:
         uses: actions/checkout@v3
       - name: Get changed files.
         id: changed-files
-        uses: tj-actions/changed-files@v40
+        uses: tj-actions/changed-files@v44
         with:
           files: source/sdk/**
       - name: List changed files (debugging log statement).

build.sh

@@ -0,0 +1,2 @@
+curl https://raw.githubusercontent.com/mongodb/docs-worker-pool/netlify-poc/scripts/build-site.sh -o build-site.sh 
+sh build-site.sh

docs-release-notes.md

@@ -1,3 +1,90 @@
+# June 21, 2024
+
+## Kotlin SDK
+
+- Realm/Model Data
+  - Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
+  - Supported Data Types: Update "RealmAny" section to indicate support for holding lists and dictionaries. Add a new "Collections as Mixed" section with details about modeling unstructured or variable data.
+
+## .NET SDK
+
+- Model Data
+  - Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
+  - Supported Data Types > RealmValue: Update page to indicate support for holding lists and dictionaries. Add a new "Collections as Mixed" section with details about modeling unstructured or variable data.
+
+## Node.js SDK
+
+- Model Data
+  - Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
+  - Supported Data Types/Mixed: Update page to indicate support for holding lists and dictionaries. Add a new "Collections as Mixed" section with details about modeling unstructured or variable data.
+
+## React Native SDK
+
+- Model Data
+  - Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
+  - Supported Data Types/Mixed: Update page to indicate support for holding lists and dictionaries. Add a new "Collections as Mixed" section with details about modeling unstructured or variable data.
+
+## Swift SDK
+
+- Model Data
+  - Define an Object Model: Add new "Define Unstructured Data" section outlining support for Collections as Mixed feature.
+  - Supported Types: Update "AnyRealmValue" section to indicate support for holding lists and dictionaries. Add a new "Collections as Mixed" section with details about modeling unstructured or variable data.
+
+# June 14, 2024
+
+## .NET SDK
+
+- Compatibility: Add note with minimum framework requirements when using the new source model generator.
+
+## React Native SDK
+
+- Atlas App Services: Fix a monospace formatting typo for an instance of the word "App".
+
+## Swift SDK
+
+- Install: Remove outdated information. Rename "Static Framework" install instructions to "Dynamic Framework."
+
+# June 7, 2024
+
+## Kotlin SDK
+
+- Realm/Read & Write Data/Read: Fix typo.
+
+## Other
+
+- Internal: Update Node version to 18.x for compatibility with Bluehawk. 
+
+# May 31, 2024
+
+## Other
+
+- Internal: Update test suite dependencies to resolve security vulnerability alerts.
+
+# May 24, 2024
+
+## Java SDK
+
+- Throughout the SDK: Note that new App Services Apps cannot use `RealmAny` with the Java SDK due to an incompatible protocol version.
+
+## .NET SDK
+
+- Application Services/Connect to an App Services App: Add a section on updating the `baseURL` during runtime.
+
+# May 17, 2024
+
+## C++ SDK
+
+- Landing Page: Add "Learning Paths" section with links to the C++ quick start, template app, and tutorial.
+
+## Swift SDK
+
+- SwiftUI/Handle Sync Errors: New page demonstrating how to set and use a sync error handler in SwiftUI.
+
+## Other
+
+- Example Projects: Add the C++ template app to the SDK template app list.
+- Internal: Update test suite dependencies to resolve security vulnerability alerts.
+
 # May 10, 2024
 
 ## C++ SDK
@@ -165,7 +252,7 @@ Throughout Device SDK docs:
 
 ## Kotlin SDK
 
-- Realm/Configure & Open a Realm: Fix a broken hyperlink. 
+- Realm/Configure & Open a Realm: Fix a broken hyperlink.
 
 # February 16, 2024
 
@@ -197,9 +284,9 @@ Throughout Device SDK docs:
 
 - Atlas App Services/Connect to an App Services App: Note that, starting in v12.6.0, you can update the `baseUrl` in the `AppConfiguration` because the App client no longer caches it.
 
-## React Native SDK 
+## React Native SDK
 
-- Atlas App Services/Connect to an App Services App: 
+- Atlas App Services/Connect to an App Services App:
   - Note that, starting in v12.6.0, you can update the `baseUrl` in the  `AppConfiguration` because the App client no longer caches it.
   - Update examples to use new auth hooks.
 - API Reference/App Provider: Update `useApp` example to remove old auth pattern.
@@ -1540,7 +1627,7 @@ Prepare docs for C++ GA release, including:
 - Model Data
   - Define an Object Model: Update info for C# nullable reference types and nullable-aware context, add a Bluehawked code example
   - Data Binding: Move a section about data binding and MVVM from Define an Object Model to Data Binding page
-- React to Changes: Add a callout with info about binding data to the UI and a link to the the Data Binding page
+- React to Changes: Add a callout with info about binding data to the UI and a link to the Data Binding page
 
 ## Node.js SDK
 

examples/dart/bin/models/car.realm.dart

@@ -315,6 +315,30 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.8.1"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.4"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.3"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.1"
   lints:
     dependency: transitive
     description:
@@ -335,26 +359,26 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136"
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.12.0"
   mime:
     dependency: transitive
     description:
@@ -383,10 +407,10 @@ packages:
     dependency: transitive
     description:
       name: path
-      sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
       url: "https://pub.dev"
     source: hosted
-    version: "1.8.3"
+    version: "1.9.0"
   pool:
     dependency: transitive
     description:
@@ -532,10 +556,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
+      sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f"
       url: "https://pub.dev"
     source: hosted
-    version: "0.6.1"
+    version: "0.7.0"
   timing:
     dependency: transitive
     description:
@@ -560,22 +584,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.4"
-  watcher:
+  vm_service:
     dependency: transitive
     description:
-      name: watcher
-      sha256: "3d2ad6751b3c16cf07c7fca317a1413b3f26530319181b37e3b9039b84fc01d8"
+      name: vm_service
+      sha256: "3923c89304b715fb1eb6423f017651664a03bf5f4b29983627c4da791f74a4ec"
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.0"
-  web:
+    version: "14.2.1"
+  watcher:
     dependency: transitive
     description:
-      name: web
-      sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
+      name: watcher
+      sha256: "3d2ad6751b3c16cf07c7fca317a1413b3f26530319181b37e3b9039b84fc01d8"
       url: "https://pub.dev"
     source: hosted
-    version: "0.3.0"
+    version: "1.1.0"
   web_socket_channel:
     dependency: transitive
     description:
@@ -593,5 +617,5 @@ packages:
     source: hosted
     version: "3.1.2"
 sdks:
-  dart: ">=3.2.0-194.0.dev <4.0.0"
-  flutter: ">=3.10.2"
+  dart: ">=3.3.0 <4.0.0"
+  flutter: ">=3.18.0-18.0.pre.54"