docs-realm
docs-realm copied to clipboard
(DOCSP-39500): Consolidate Install page
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
-
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:
- C++: Install
- .NET: Install
- Flutter: Install
- Flutter: Troubleshooting
- Upgrade to SDK v2.0.0
- Kotlin: Install
- Node.js: Install
- Swift: Install
- Swift: Build for tvOS
PR Author Checklist
Before requesting a review for your PR, please check these items:
- [x] Open the PR against the
feature-consolidated-sdk-docs
branch instead ofmaster
- [x] Tag the consolidated page for:
- genre
- meta.keywords
- meta.description
Naming
- [x] Update Realm naming and the language around persistence layer/local/device per this document
- [x] Include
.rst
files comply with the naming guidelines
Links and Refs
- [x] Create new consolidated SDK ref targets starting with "_sdks-" for relevant sections
- [x] Remove or update any SDK-specific refs to use the new consolidated SDK ref targets
- [x] Update any Kotlin API links to use the new Kotlin SDK roles
Content
- [x] Shared code boxes have snippets or placeholders for all 9 languages
- [x] API description sections have API details or a generic placeholder for all 9 languages
- [x] Check related pages for relevant content to include
- [x] Create a ticket for missing examples in each relevant SDK: Consolidation Gaps epic
Reviewer Checklist
As a reviewer, please check these items:
- [x] Shared code example boxes contain language-specific snippets or placeholders for every language
- [x] API reference details contain working API reference links or generic content
- [x] Realm naming/language has been updated
- [x] All relevant content from individual SDK pages is present on the consolidated page