Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(DOCSP-39501): Consolidate Quick Start page (#3280)
## Pull Request Info - SDK Docs Consolidation Jira ticket: https://jira.mongodb.org/browse/DOCSP-39501 *Staged Page* - [Quick Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/sdk/quick-start/) - [SwiftUI Quick Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/frameworks/swiftui/quick-start/): Existing content ported over with Realm naming and ref updates - [Flutter Quick Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/frameworks/flutter/quick-start/): Move existing Flutter-specific content out of quick start to this relevant section - [Unity Quick Start](https://preview-mongodbdacharyc.gatsbyjs.io/realm/DOCSP-39501/platforms/unity/): Existing content ported over with Realm naming and ref updates Adding a note here to capture this in the PR record: - Product has made the call to remove Java SDK info from our "getting started" content (here and the Install page), so I've removed the Java and Kotlin (Java SDK) examples from the consolidated quick start page. - Based on relatively low usage of the Java SDK Quick Start with LiveData page, and the need to update it to show Kotlin SDK or at the very least not Partition-Based Sync, I've checked with engineering and product and am removing this page from the docs. It doesn't seem worthwhile to continue to incur the maintenance cost. *Page Source* Add links to every SDK's pages where you got the SDK-specific information: - [C++ Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/quick-start/) - [Flutter Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/quick-start/) - [Flutter Install Page](https://www.mongodb.com/docs/atlas/device-sdks/sdk/flutter/install/) - [Java Local Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/quick-start-local/) - [Java Sync Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/quick-start-sync/) - [Java Quick Start with Live Data](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/quick-starts/livedata/) - [Kotlin Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/kotlin/quick-start/) - [.NET Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/quick-start/) - [.NET SDK/Quick Start for Unity](https://www.mongodb.com/docs/atlas/device-sdks/sdk/dotnet/unity/) - [Node.js Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/node/quick-start/) - [Swift Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/quick-start/) - [SwiftUI Quick Start](https://www.mongodb.com/docs/atlas/device-sdks/sdk/swift/swiftui-tutorial/) ### 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 of `master` - [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](https://docs.google.com/document/d/126OczVxBWAwZ4P5ZsSM29WI3REvONEr1ald-mAwPtyQ/edit?usp=sharing) - [x] Include `.rst` files comply with [the naming guidelines](https://docs.google.com/document/d/1h8cr66zoEVeXytVfvDxlCSsUS5IZwvUQvfSCEXNMpek/edit#heading=h.ulh8b5f2hu9) #### 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](https://jira.mongodb.org/browse/DOCSP-32519) 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: - [ ] 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 --------- Co-authored-by: cbullinger <[email protected]>
- Loading branch information