Skip to content

Commit

Permalink
Add documentation to repo about which platforms this SDK supports
Browse files Browse the repository at this point in the history
fixes #2032
  • Loading branch information
timtay-microsoft committed Jun 21, 2021
1 parent 464d395 commit a3406eb
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 24 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Please follow the instructions and template below to save us time requesting add

Below is a generic bug report format. We recommend you use it as a template and replace the information below each header with your own.

Note that bugs that only affect unsupported platforms will likely be treated as feature requests, and may be closed as "won't fix" if we have no plans to support that platform. See [this document](../../supported_platforms.md) for details on which platforms are officially supported.

------------------------------- delete above -------------------------------


Expand Down
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Thank you for raising a feature request! To get started, here's a few things to

As an open source project, we welcome PRs for new features, and we don't want to reject any hard work you've done to contribute. **So propose your solution through an issue first** so we can discuss the changes, and if things look good we will ask you submit a PR to implement the changes.

Note that feature requests that only affect unsupported platforms may be closed as "won't fix" if we have no plans to support that platform. See [this document](../../supported_platforms.md) for details on which platforms are officially supported.

------------------------------- delete above -------------------------------

**Is your feature request related to a problem? Please describe.**
Expand Down
24 changes: 0 additions & 24 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,30 +61,6 @@ It shows how to connect a device, handle disconnect events, cases to handle when

If you would like to build or change the SDK source code, please follow the [devguide](doc/devguide.md).

## OS platforms and hardware compatibility

> .NET Standard 1.3 (IoT Hub SDKs only) is last supported in the [2020-02-27](https://github.com/Azure/azure-iot-sdk-csharp/releases/tag/2020-2-27) and in the [2020-1-31 LTS](https://github.com/Azure/azure-iot-sdk-csharp/releases/tag/lts_2020-1-31) releases.
The IoT Hub device SDK for .NET can be used with a broad range of device platforms and is officially supported on the following Operating Systems:

* Windows versions officially supported by Microsoft.
* [Linux distributions](https://docs.microsoft.com/en-us/dotnet/core/install/linux) supported by .NET core.

> Note: For Linux, we test our clients against Ubuntu 16.04.7 LTS.
The NuGet packages provide support for the following .NET flavors:
- .NET Standard 2.1
- .NET Standard 2.0
- .NET Framework 4.7.2 (IoT Hub SDKs only)
- .NET Framework 4.5.1 (IoT Hub SDKs only)

For details on .NET support see the [.NET Standard documentation](https://docs.microsoft.com/dotnet/standard/net-standard).
For details on OS support see the following resources:

- [.NET Core Runtime ID Catalog](https://docs.microsoft.com/dotnet/core/rid-catalog)
- [.NET Framework System Requirements](https://docs.microsoft.com/dotnet/framework/get-started/system-requirements)
- [Configure TLS Protocol Version and Ciphers](./configure_tls_protocol_version_and_ciphers.md)

## Key features and roadmap

### IoT Hub Device SDK
Expand Down
45 changes: 45 additions & 0 deletions supported_platforms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Microsoft Azure IoT SDKs for .NET

This SDK is tested nightly on a mix of .NET frameworks on both Windows 10 and on Ubuntu 1604. For additional details
for each tested platform, see the respective sections below.

## Supported .NET versions

The NuGet packages provide support for the following .NET versions:
- .NET Standard 2.1
- .NET Standard 2.0
- .NET Framework 4.7.2 (IoT Hub SDKs only)
- .NET Framework 4.5.1 (IoT Hub SDKs only)

This SDK _may_ work with other versions of .NET, but there are no guarantees that they will _always_ work for those
versions nor are there guarantees that we will fix bugs that are only present on those versions.

## Windows 10

Note that, while we only directly test on Windows 10, we do support other Windows versions as well.

Nightly test platform details:

.NET versions: .NET Framework 4.5.1, .NET Framework 4.7.2, .NET Core 2.1.18, .NET Core 3.1

Default locale: en_US, platform encoding: Cp1252

OS name: "windows server 2016", version: "10.0", arch: "amd64", family: "windows"

## Ubuntu 1604

Note that, while we only directly test on Ubuntu 1604, we do generally support other popular linux distributions.

Nightly test platform details:

.NET versions: .NET Core 2.1.18, .NET Core 3.1

Default locale: en_US, platform encoding: UTF-8

OS name: "linux", version: "4.15.0-1113-azure", arch: "amd64", family: "unix"

## Miscellaneous support notes

- This library does not officially support being run on MacOS.
- This library does not officially support being run in Xamarin applications.
- .NET Standard 1.3 (IoT Hub SDKs only) is last supported in the [2020-02-27](https://github.com/Azure/azure-iot-sdk-csharp/releases/tag/2020-2-27) and in the [2020-1-31 LTS](https://github.com/Azure/azure-iot-sdk-csharp/releases/tag/lts_2020-1-31) releases.

0 comments on commit a3406eb

Please sign in to comment.