Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-9311

Improve .NET Compatibility Statement

    XMLWordPrintable

Details

    • DOC-2021-Nov07-S22, DOC-2021-Nov21-S23
    • 1

    Description

      After getting several questions about our support for various .NET versions, we have agreed to refactor the documentation in the getting started intro section and the compatibility section to help make it more clear.

      1. Refactoring the Intro Section: Installing the SDK.

      Current Paragraph:

      The Couchbase .NET SDK targets and is tested with .NET Standard 2.0 and 2.1, which in turn supports .NET Framework 4.6.2+ and .NET Core (e.g. netcoreapp) 2.1. A full list of supported platforms can be found in the .NET Standard documentation. The SDK also may use some dependencies that have not yet made it into .NET Standard; these can be enabled by targeting .netcoreapp2.1 or .netcoreapp3.0. Eventually as they are added to the standard, these platform targets will be removed. Other .NET implementations might work but are not tested and are outside of the scope of our technical support organization.

      New Paragraph:

      The Couchbase .NET SDK is compatible with .NET Standard 2.0 and .NET Standard 2.1, which means that it is compatible with .NET Framework 4.6.2+, .NET 5.0, .NET 6.0, and .NET Core 3.1. The .NET Standard documentation and .NET Standard version chart may be useful to help understand other available options. We strongly recommend using the latest version of .NET that is officially supported by Microsoft. Other .NET implementations might work but are not tested and are outside of the scope for technical support.

      2. Refactoring the Compatibility Section

      Perhaps we restate the new comments above and then include a compatibility chart (similar to what we have seen with other vendors) to help make it abundantly clear. We just need to use caution to make sure we don't state explicit support of some of the less common implementations (which should work but we don't currently have the bandwidth to test).

       

      NOTE: In the intro section, it may be useful to provide a link to our compatibility section as well.

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          (Moving to Doc sprint - hope that's OK Ray Cardillo, means it shows up on my TODO for the morning...)

          hakim.cassimally Hakim Cassimally added a comment - (Moving to Doc sprint - hope that's OK Ray Cardillo , means it shows up on my TODO for the morning...)

          draft https://github.com/couchbase/docs-sdk-dotnet/pull/223

          Currently missing these parts from part 2:

          • compatibility chart (similar to what we have seen with other vendors) to help make it abundantly clear.
          • link to compat from intro section
          hakim.cassimally Hakim Cassimally added a comment - draft https://github.com/couchbase/docs-sdk-dotnet/pull/223 Currently missing these parts from part 2: compatibility chart (similar to what we have seen with other vendors) to help make it abundantly clear. link to compat from intro section

          Attached screenshot of draft table for comment

          hakim.cassimally Hakim Cassimally added a comment - Attached screenshot of draft table for comment
          hakim.cassimally Hakim Cassimally added a comment - https://github.com/couchbase/docs-sdk-dotnet/pull/223  in review

          People

            hakim.cassimally Hakim Cassimally
            ray.cardillo Ray Cardillo
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty