Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.NET core / framework compat #310

Merged
merged 8 commits into from
Dec 12, 2023
Merged

Conversation

RichardSmedley
Copy link
Contributor

DOC-11619

@RichardSmedley
Copy link
Contributor Author

This is my best guess for a quick update - can be revisited again when .NET 8 support arrives.

@@ -1,4 +1,4 @@
The Couchbase .NET SDK is compatible with https://docs.microsoft.com/en-us/dotnet/standard/net-standard[.NET Standard] 2.0 and .NET Standard 2.1, which means that it's compatible with .NET Framework 4.6.2+, .NET 5.0, .NET 6.0, and .NET Core 3.1.
The Couchbase .NET SDK is compatible with https://docs.microsoft.com/en-us/dotnet/standard/net-standard[.NET Standard] 2.0 and .NET Standard 2.1, which means that it's compatible with .NET Framework 4.6.2+, .NET 5.0, .NET 6.0, and .NET Core 3.1 -- and supported so long as Couchbase supports the SDK release and Microsoft supports the .NET platform version.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll update this further for the 3.5 release.

…upported SDKs.

Per NCBC-3552, mention that Capella certificate must be installed locally for .NET Framework clients.
@@ -146,27 +142,15 @@ include::hello-world:partial$supported.adoc[]
| *✖*
| *✖*

| .NET Framework 4.6.2+
| .NET 8.0 (Long-Term Support)
| *✔*
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were the older releases (3.0 / 3.1 / 3.2) tested against .NET 8.0?

Copy link
Contributor

@jeffrymorris jeffrymorris Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, as .NET 8.0 is new as of Nov 14, 2023 - the earliest version tested on .NET 8.0 will likley be 3.4.14 due in Dec.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, will remove this column for now.

Copy link
Contributor Author

@RichardSmedley RichardSmedley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment, but otherwise LGTM - thanks for the additions @RiPont

The https://docs.microsoft.com/en-us/dotnet/standard/net-standard[.NET Standard documentation] and
https://dotnet.microsoft.com/platform/dotnet-standard#versions[.NET Standard version chart] may be useful to help understand other available options.

Couchbase strongly recommends using the latest version of .NET that's officially supported by both Microsoft and Couchbase.
Couchbase strongly recommends using the latest LTS version of .NET that's officially supported by both Microsoft and Couchbase.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we point to Versions of .NET ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - will add this, and we'll look to improve how we present the info in 3.5 👍

@@ -223,7 +223,8 @@ The .NET SDK bundles Capella’s standard root certificate by default.
This means you don’t need any additional configuration to enable TLS -- simply use `couchbases://` in your connection string.

NOTE: Capella's root certificate is *not* signed by a well known CA (Certificate Authority).
However, as the certificate is bundled with the SDK, it is trusted by default.
However, as the certificate is bundled with the SDK when using .NET 6.0 or later, it is trusted by default.
.NET Framework clients will have to add it to the Windows certificate store.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to more specific about what a ".NET Framework client" is? Meaning linking to .NET Framework and .NET 6?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe - but probably not from this page, rather from the compat page.

@jeffrymorris jeffrymorris self-requested a review November 29, 2023 04:19
@RichardSmedley RichardSmedley merged commit 1795158 into release/3.4 Dec 12, 2023
1 check passed
@RichardSmedley RichardSmedley deleted the RichardSmedley-patch-3 branch December 12, 2023 16:54
RichardSmedley added a commit that referenced this pull request Dec 12, 2023
RichardSmedley added a commit that referenced this pull request Dec 12, 2023
...ported forward from #310
RichardSmedley added a commit that referenced this pull request Dec 12, 2023
ported forward from #310
RichardSmedley added a commit that referenced this pull request Mar 6, 2024
* .NET core / framework compat (#310)

* .NET core / framework compat

DOC-11619

* Update supported.adoc

* Per NCBC-3511, update .NET SDK support matrix for LTS and currently-supported SDKs.

Per NCBC-3552, mention that Capella certificate must be installed locally for .NET Framework clients.

* Update "Managing Connections" to mention .NET Framework users must install the Capella certificate locally.

* https://versionsof.net/ link

* Awaiting 23.4.14

* table format / comments

* Get it right this time <sigh>

---------

Co-authored-by: Richard Ponton <[email protected]>

* Ubuntu 22.04

* Delete modules/howtos/pages/durability-error-handling-from-the-sdk.adoc

Ghost page removal

* typo fix

DOC-11739

* Dotnet 3.4.14 GA Release notes (#313)

* Dotnet 3.4.14 GA Release notes

* Gardening started but unfinished

---------

Co-authored-by: Richard Smedley <[email protected]>

* Remove protostellar ticket references (#315)

* Remove protostellar ticket references

* Gardening

---------

Co-authored-by: Richard Smedley <[email protected]>

* Release notes for CouchbaseNetClient 3.4.15 (#316)

* Release notes for CouchbaseNetClient 3.4.15

* Gardening

---------

Co-authored-by: Richard Smedley <[email protected]>

* Remove NCBC-3635 from 3.4.15

* Gardening2 (#319)

* NCBC-3653: Document that IGetResult.Dispose should be called

Motivation
----------
The documentation should explain why Dispose should be called, which
operations are effected and the example code should also do this.

* Gardening

* gardening part duex

---------

Co-authored-by: Richard Smedley <[email protected]>

* NCBC-3440: improve ClusterOptions documentation (#320)

* NCBC-3440: improve ClusterOptions documentation

* ventilated prose

---------

Co-authored-by: Richard Smedley <[email protected]>

* tweaks

---------

Co-authored-by: Richard Ponton <[email protected]>
Co-authored-by: Jeffry Morris <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants