(DOCSP-39500): Consolidate Install page #3326

dacharyc · 2024-07-18T14:30:17Z

Pull Request Info - SDK Docs Consolidation

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

Notes for Reviewer
Only five of the pages listed here should be considered to be in a "complete" state as of this PR:

Install
Apple Privacy Manifest
Build for tvOS
Install Atlas Device SDK for Flutter
Upgrade to Flutter SDK v2.0.0

I moved content off of existing install pages onto a bunch of other pages, but those pages will get more updates in the future to make them coherent pages. For now, you only need to confirm that the content got moved successfully and everything is still working.

Also, noting here that per conversations with the product and engineering teams, we are intentionally omitting the Java SDK (Java and Java-Kotlin) from the Install page.

Staged Page

Install
Build for Platforms
Build for Frameworks
- Install Atlas Device SDK for Flutter
Upgrade to Flutter v 2.0.0: I intentionally orphaned this one in a new hidden-pages directory. I don't think this is necessarily important enough to surface in the ToC, and we don't have a good pattern for doing that in the new consolidated world. It's available in the "Upgrade" section, and we could link to it elsewhere if we come up with a better pattern later.

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
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-07-18T14:31:38Z

Readability for Commit Hash: 889f315

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

Readability scores for changed documents:

source/sdk/install: Grade Level: 7.9, Reading Ease: 59.6

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.

krollins-mdb

LGTM! I only have some relatively minor suggestions and comments.

Nice work, @dacharyc!

krollins-mdb · 2024-07-30T18:48:16Z

...udes/api-details/objectivec/install/install-platform-specific-considerations-description.rst

+To include these manifests in a build target that uses ``Realm``, you must
+build ``Realm`` as a dynamic framework. For details, refer to the Swift


Double checking: do these instances of "Realm" refer to the realm package? If so, should we make that a bit clearer to help with the distinction between the package being called "realm" but the product being called "Atlas Device SDK"?

This comes up again in the "Supported Target Environments" section with Xcode compatibility info.

krollins-mdb · 2024-07-30T18:49:28Z

source/includes/api-details/objectivec/install/install-sdk-procedure-cocoapods.rst

+   .. step:: Update the CocoaPods repositories
+
+   On the command line, run ``pod repo update`` to ensure
+   CocoaPods can access the latest available Realm versions.


This "Realm" instance feels like it should be updated, but I'm not certain of the context.

krollins-mdb · 2024-07-30T18:55:01Z

source/sdk/install.txt

+
+.. tip:: Atlas Device SDK and Realm
+
+   The SDK uses Realm Core database for device data persistence. When you


Small suggestion to avoid making it seem like Realm Core persists data about the device itself. Would apply to the other note too.

Suggested change

The SDK uses Realm Core database for device data persistence. When you

The SDK uses Realm Core database for on-device data persistence. When you

krollins-mdb · 2024-07-30T18:58:48Z

...ce/includes/api-details/cpp/install/install-platform-specific-considerations-description.rst

@@ -0,0 +1 @@
+- :ref:`sdks-build-for-android`


Do people use the C++ SDK for Android projects? I thought it mostly IoT/embedded type stuff.

Yeah, we had customers running into issues related to this which is why we had to add the info about it. I'm not sure about the context - maybe in cross-platform projects?

krollins-mdb · 2024-07-30T19:09:57Z

...includes/api-details/csharp/install/install-platform-specific-considerations-description.rst

@@ -0,0 +1,15 @@
+- :ref:`sdks-unity`
+
+When building for Apple platforms, Apple requires any apps or third-party SDKs


I think we need the "Apple Privacy Manifest" heading here, like in the Swift and Objective-C details. Otherwise, this manifest content kinda comes out of nowhere. Looks like the heading is needed for Dart and Kotlin details too.

krollins-mdb · 2024-07-30T19:13:19Z

source/includes/api-details/dart/install/install-requirements-description.rst

+The latest version of the SDK requires Dart version {+dart-minimum-version+}
+or later.


I know you didn't write this, but it seems more important in the new context.

Minor update to make it clear we're talking about the Atlas Device SDK and not the Dart SDK (which is what the previous link calls the Dart language environment).

Suggested change

The latest version of the SDK requires Dart version {+dart-minimum-version+}

or later.

The latest version of the Atlas Device SDK requires Dart version {+dart-minimum-version+}

or later.

krollins-mdb · 2024-07-30T19:16:44Z

...ce/includes/api-details/javascript/install/install-supported-platforms-js-ts-description.rst

+- **Mobile App Development**: For cross-platform mobile app development, use
+  the :ref:`sdks-build-with-react-native`.


Wording is a bit odd when this gets expanded to the page title.

Suggested change

- **Mobile App Development**: For cross-platform mobile app development, use

the :ref:`sdks-build-with-react-native`.

- **Mobile App Development**: For cross-platform mobile app development, refer

to :ref:`sdks-build-with-react-native`.

krollins-mdb · 2024-07-30T19:20:07Z

source/includes/api-details/kotlin/install/install-requirements-description.rst

+  `Kotlin Multiplatform documentation
+  <https://kotlinlang.org/docs/mobile/create-first-app.html>`__.
+
+For more details on setting up your KMP environment, refer to the `official Kotlin


Suggested change

For more details on setting up your KMP environment, refer to the `official Kotlin

For more details on setting up your KMP environment, refer to the `official

netlify · 2024-07-31T13:08:46Z

✅ Deploy Preview for device-sdk ready!

Name	Link
🔨 Latest commit	`889f315`
🔍 Latest deploy log	https://app.netlify.com/sites/device-sdk/deploys/66aa374ff816e70008f52455
😎 Deploy Preview	https://deploy-preview-3326--device-sdk.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 32 (🔴 down 3 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.

Scaffold Install page structure

08eed11

dacharyc added the merge to feature branch Unreleased feature - do not merge to Master label Jul 18, 2024

dacharyc added 20 commits July 18, 2024 10:40

Experiment with different include structure

8a50da1

Tweak code blocks

3dcb430

Add C# install details

76150c5

Add Dart install details, kinda

03a0892

Fix build errors

812bc9b

Add platform landing pages to snooty.toml

308869b

Omit Java SDK

20a9007

Add Kotlin library details

ed9fe04

Refactor supported environments into mutually-exclusive tabs

e9e6a62

Add JS SDK details

7383184

Fix build error

419a785

Fix build error

a885631

Add Swift and Objective-C install details

7ecfe22

Fix build errors

5121783

Fix build errors

766ed5b

Objective-C doesn't have actor support

130f00a

Add details about upgrading Flutter package version

3bfe0fa

Add the Flutter upgrade page as a 'hidden page'

8c28984

Remove languages from code blocks on Install page, fix build errors

1abb860

Apparently it can't be yaml either

138c738

dacharyc marked this pull request as ready for review July 19, 2024 15:55

krollins-mdb approved these changes Jul 30, 2024

View reviewed changes

Apply review feedback

889f315

dacharyc merged commit 7f294fe into mongodb:feature-consolidated-sdk-docs Jul 31, 2024
10 checks passed

dacharyc deleted the DOCSP-39500 branch July 31, 2024 13:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(DOCSP-39500): Consolidate Install page #3326

(DOCSP-39500): Consolidate Install page #3326

Uh oh!

dacharyc commented Jul 18, 2024 •

edited by krollins-mdb

Loading

Uh oh!

github-actions bot commented Jul 18, 2024 •

edited

Loading

Uh oh!

krollins-mdb left a comment

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

dacharyc Jul 31, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

krollins-mdb Jul 30, 2024

Uh oh!

netlify bot commented Jul 31, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

		To include these manifests in a build target that uses ``Realm``, you must
		build ``Realm`` as a dynamic framework. For details, refer to the Swift


		.. tip:: Atlas Device SDK and Realm

		The SDK uses Realm Core database for device data persistence. When you

	The SDK uses Realm Core database for device data persistence. When you
	The SDK uses Realm Core database for on-device data persistence. When you

		@@ -0,0 +1,15 @@
		- :ref:`sdks-unity`

		When building for Apple platforms, Apple requires any apps or third-party SDKs

		The latest version of the SDK requires Dart version {+dart-minimum-version+}
		or later.

		- Mobile App Development: For cross-platform mobile app development, use
		the :ref:`sdks-build-with-react-native`.

	For more details on setting up your KMP environment, refer to the `official Kotlin
	For more details on setting up your KMP environment, refer to the `official

(DOCSP-39500): Consolidate Install page #3326

(DOCSP-39500): Consolidate Install page #3326

Uh oh!

Conversation

dacharyc commented Jul 18, 2024 • edited by krollins-mdb Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info - SDK Docs Consolidation

PR Author Checklist

Naming

Links and Refs

Content

Reviewer Checklist

Uh oh!

github-actions bot commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krollins-mdb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for device-sdk ready!

Uh oh!

Uh oh!

Uh oh!

dacharyc commented Jul 18, 2024 •

edited by krollins-mdb

Loading

github-actions bot commented Jul 18, 2024 •

edited

Loading

netlify bot commented Jul 31, 2024 •

edited

Loading