From 120418741196899a6981746a9665d51b76c51679 Mon Sep 17 00:00:00 2001 From: MongoCaleb Date: Fri, 2 Oct 2020 08:24:33 -0700 Subject: [PATCH 1/2] landing page, install, and quickstart --- source/dotnet.txt | 61 +++++++++++-------- source/dotnet/install.txt | 11 ++-- source/dotnet/quick-start.txt | 28 ++------- .../includes/steps-install-dotnet-vs-mac.yaml | 2 +- 4 files changed, 47 insertions(+), 55 deletions(-) diff --git a/source/dotnet.txt b/source/dotnet.txt index 1d49927ff5..f205a307d9 100644 --- a/source/dotnet.txt +++ b/source/dotnet.txt @@ -12,15 +12,30 @@ platforms to access data stored in local {+realms+} and interact with {+backend+} services like Functions, MongoDB Data Access, and authentication. -For more information about specific version support for .NET, UWP, and -Xamarin, see our :ref:`compatibility chart `. +.. _dotnet_supported-platforms: -.. note:: +Supported Platforms +------------------- +Realm supports the following platforms for developing Realm apps for iOS and +Android devices: - When building - for platforms with Xamarin, you can use either native UI or - `Xamarin Forms - `__. +- Xamarin.iOS for iOS 8 or later, using native UI or Xamarin Forms +- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms +- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms +- .NET Framework 4.6.1 or later for Windows 8.1 or later +- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update) +- .NET Core 2.0 or later on the following: + + - Ubuntu 16.04 or later + - Debian 8 or later + - RHEL 7.1 or later + - macOS 10.11 or later + - Windows 8.1 or later + +And supports the following development environments: + +- Visual Studio 2015 Update 2 or higher for Windows +- Visual Studio for Mac 7.0 or higher Installation ------------ @@ -29,38 +44,36 @@ To learn how to add the {+service+} .NET SDK library as a dependency to your application, see :ref:`Install Realm for .NET `. -The Realm Data Model --------------------- +Realm Data Models +----------------- You can store a wide variety of data within {+realms+} stored on your -device. With :term:`{+sync+}`, you can share updates to that data across -client devices and {+atlas+}. +device, and if you enable :term:`{+sync+}`, updates to that data are available +across multiple client devices. Data models are classes defined in your +code and in {+realm+} schemas. For information about the structure of data you can store in {+realms+}, see :ref:`Realms `, :ref:`Objects `, and :ref:`Relationships `. -To learn about the results returned from {+realm+} queries, see -:ref:`Collections `. - -Work with Realm Database ------------------------- +Work with a Realm Database +-------------------------- -Once you have defined a data model for your application, you -need to be able to :ref:`write ` and -:ref:`read ` pieces of data to and from +Once you have defined the data model(s) for your application, you +can :ref:`write ` and +:ref:`read ` data to and from your {+realm+}s. To learn how to query for data in local {+realms+}, see :ref:`Query Engine `. -For advice on how to safely interact with {+client-database+} across -threads in an application, see :ref:`Threading -`. +To learn about the results returned from {+realm+} queries, see +:ref:`Collections `. -For information about how to react to changes in {+realm+} data, see -:ref:`Notifications `. +Mobile application development can be complicated by threading. To learn +how to work with {+backend-short+} across threads in your application, +see :ref:`Threading `. Work with MongoDB Realm ----------------------- diff --git a/source/dotnet/install.txt b/source/dotnet/install.txt index 7b5fb66e25..c8eb13ce3a 100644 --- a/source/dotnet/install.txt +++ b/source/dotnet/install.txt @@ -19,18 +19,15 @@ Overview for the .NET, `UWP `__, and `Xamarin `__ -ecosystems. When building for platforms with Xamarin, you -can use either native UI or `Xamarin Forms -`__. +ecosystems. For more information about specific version support for .NET, UWP, and -Xamarin, see our :ref:`compatibility chart `. +Xamarin, see :ref:`Supported Platforms `. Prerequisites ------------- -Before getting started, ensure your development environment -meets the following prerequisites: +Before getting started, ensure you have installed Visual Studio: - `Visual Studio `__ 2015 Update 2 or later. - `Visual Studio for Mac `__ 7.0 or later. @@ -38,7 +35,7 @@ meets the following prerequisites: Installation ------------ -Follow these steps to add the {+service+}.NET SDK to your project. +Follow these steps to add the {+service+} .NET SDK to your project. .. tabs:: diff --git a/source/dotnet/quick-start.txt b/source/dotnet/quick-start.txt index 5728622d7e..dc207a3892 100644 --- a/source/dotnet/quick-start.txt +++ b/source/dotnet/quick-start.txt @@ -21,29 +21,11 @@ integrated into your .NET app. Before you begin, ensure you have: - :ref:`Created a {+app+} ` - :ref:`Enabled {+sync+} ` -Supported Platforms -------------------- -Realm supports the following platforms for developing Realm apps for iOS and -Android devices: - -- Visual Studio 2019 -- Xamarin.iOS for iOS 8 or later, using native UI or Xamarin Forms -- Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms -- Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms -- .NET Framework 4.6.1 or later for Windows 8.1 or later -- Universal Windows Platform applications using .NET Standard 2.0 or later (Fall Creators Update) -- .NET Core 2.0 or later on the following: - - - Ubuntu 16.04 or later - - Debian 8 or later - - RHEL 7.1 or later - - macOS 10.11 or later - - Windows 8.1 or later - -And supports the following development environments: - -- Visual Studio 2015 Update 2 or higher for Windows -- Visual Studio for Mac 7.0 or higher +.. note:: + + See :ref:`Supported Platforms ` for the list of + platforms that Realm supports. + Import Realm ------------ diff --git a/source/includes/steps-install-dotnet-vs-mac.yaml b/source/includes/steps-install-dotnet-vs-mac.yaml index c4a365d896..31fea3bff9 100644 --- a/source/includes/steps-install-dotnet-vs-mac.yaml +++ b/source/includes/steps-install-dotnet-vs-mac.yaml @@ -24,7 +24,7 @@ content: | :lightbox: --- -title: Add the Realm Weaver to FodyWeavers.xml +title: (Optional) Add the Realm Weaver to FodyWeavers.xml ref: add-realm-weaver content: | From 442bdac44b82da9ced9e01302d818412be63ff6d Mon Sep 17 00:00:00 2001 From: MongoCaleb Date: Fri, 2 Oct 2020 13:50:39 -0700 Subject: [PATCH 2/2] nits --- source/dotnet.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/dotnet.txt b/source/dotnet.txt index f205a307d9..bd824a1f05 100644 --- a/source/dotnet.txt +++ b/source/dotnet.txt @@ -19,7 +19,7 @@ Supported Platforms Realm supports the following platforms for developing Realm apps for iOS and Android devices: -- Xamarin.iOS for iOS 8 or later, using native UI or Xamarin Forms +- Xamarin.iOS for iOS 9 or later, using native UI or Xamarin Forms - Xamarin.Android for API level 16 or later, using native UI or Xamarin Forms - Xamarin.Mac for macOS 10.11 or later, using nativeUI or Xamarin Forms - .NET Framework 4.6.1 or later for Windows 8.1 or later @@ -32,7 +32,8 @@ Android devices: - macOS 10.11 or later - Windows 8.1 or later -And supports the following development environments: +You can use the following development environments to build Realm apps with +the .NET SDK: - Visual Studio 2015 Update 2 or higher for Windows - Visual Studio for Mac 7.0 or higher