From 4ffe12eaf2cd8f19e6ad7b665a7081d895181734 Mon Sep 17 00:00:00 2001 From: Richard Smedley Date: Tue, 18 Jun 2024 09:55:26 +0100 Subject: [PATCH] DOC-12286 latest install --- .../pages/migrating-sdk-code-to-3.n.adoc | 40 ++++--------------- 1 file changed, 8 insertions(+), 32 deletions(-) diff --git a/modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc b/modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc index b4c667f4..c6df3670 100644 --- a/modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc +++ b/modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc @@ -49,45 +49,21 @@ include::{version-common}@sdk:shared:partial$migration.adoc[tag=lang] == Installation and Configuration -The .NET SDK 3.x is available for download from the same resources as the previous generation 2.0 SDK: +The .NET SDK 3.x is available for download from the same resources as the previous generation 2.0 SDK. +For example, to get version {sdk_current_version}: -* From NuGet (the most popular choice): `Install-Package CouchbaseNetClient -Version 3.2.7` -* By downloading a https://packages.couchbase.com/clients/net/3.0/CouchbaseNetClient-3.2.7.zip[zip] file directly +* From NuGet (the most popular choice): `Install-Package CouchbaseNetClient -Version {sdk_current_version}` +* Or download a NuGet package directly from https://www.nuget.org/packages/CouchbaseNetClient/{sdk_current_version}[https://www.nuget.org/packages/CouchbaseNetClient/{sdk_current_version}] * (Not officially supported) By cloning and building the source code directly on https://github.com/couchbase/couchbase-net-client/tree/master[github] Please see the xref:sdk-release-notes.adoc[Release Notes] for up-to-date information. -Couchbase .NET SDK 3.2.7 build targets include .NET Standard 2.0, .NET Standard 2.1, .NET CoreApp 3.1, .NET 5 and .NET 6. -This was chosen so .NET Full Framework 4.8 can be supported along with .NET Core 3.x and earlier and follows the suggested path for library authors as well as the latest .NET Versions. -The goal is to use the latest and greatest .NET Core libraries available, but still allow fallback for developers still using .NET Full Framework as they progress towards .NET Standard compliance. - -While the older target Frameworks are still targeted, Couchbase suggests that users target .NET 6 as it provides the latest, most performant .NET version. +include::hello-world:partial$supported.adoc[] === Dependencies -There are few dependency changes from SDK 2.x. -SDK 3.0 and later no longer has any dependencies on .NET Framework 4.5.2. -It is based on .NET Standard 2.0 and .NET Standard 2.1. -One dependency addition is DnsClient, which was previously in SDK 2.x through a transitive dependency via the https://github.com/couchbaselabs/Couchbase.Extensions/blob/master/docs/dns-srv.md[Couchbase.Extensions.DnsDiscovery] project. - -Current dependencies (as of 3.2.7): - -* App.Metrics (>= 4.2.0) -* App.Metrics.Abstractions (>= 4.2.0) -* DnsClient (>= 1.3.2) -* Microsoft.CSharp (>= 4.7.0) -* Microsoft.Extensions.Logging.Abstractions (>= 3.1.21) -* Microsoft.Extensions.ObjectPool (>= 6.0.0) -* Newtonsoft.Json (>= 11.0.2) -* System.Diagnostics.DiagnosticSource (>= 5.0.1) -* System.IO.Pipelines (>= 5.0.1) -* System.Linq.Async (>= 4.1.1) -* System.Runtime.CompilerServices.Unsafe (>= 6.0.0) -* System.Text.Json (>= 6.0.0) -* System.Threading.Channels (>= 5.0.0) -* System.Threading.Tasks.Dataflow (>= 5.0.0) - -Note that if using the NuGet package these dependencies will all be handled for you by the NuGet Package Manager tool in Visual Studio or Visual Studio Code. +There are several dependency changes from SDK 2.x to {sdk_dot_minor}.x. +Use NuGet so that these dependencies will all be handled for you by the NuGet Package Manager tool in Visual Studio or Visual Studio Code. See the xref:hello-world:start-using-sdk.adoc[Start Using] document for information on adding it via NuGet. === Configuring the Environment @@ -110,7 +86,7 @@ You can perform the same custom K/V timeout in SDK 3.0, however, you will use th [source,csharp] ---- -// SDK 3.0 custom k/v timeout +// SDK 3.x custom k/v timeout var options = new ClusterOptions { KvTimeout = TimeSpan.FromMilliseconds(5)