Announce the deprecation of .NET Hyper API (#53)

tableau · Sep 6, 2023 · 03c1245 · 03c1245
1 parent 1a45fbf
commit 03c1245
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 9 deletions.
diff --git a/website/docs/installation.md b/website/docs/installation.md
@@ -72,6 +72,13 @@ Using at least C++17 is recommended, as the API uses C++17 classes, such as `std
   <TabItem value="dotnet" label=".NET">
 ```
 
+:::warning Deprecation Warning
+
+The .NET version of Hyper API is deprecated.
+Older versions of Hyper API will still be available via NuGET. In the future, .Net will not receive any new features or updates. The old packages will stay available on NuGET indefinitely, so you can keep using older versions in .Net. The other languages (Python, Java, C++) are not impacted by this in any way. In case this is causing issues for you, please reach out via [Slack](https://join.slack.com/t/tableau-datadev/shared_invite/zt-1q4rrimsh-lHHKzrhid1MR4aMOkrnAFQ).
+
+:::
+
 * The Hyper API supports `x86-64` platforms.
 * **[.NET Core 2.2 SDK](https://dotnet.microsoft.com/download)** (or newer) or **[.NET Framework 4.6.1](https://dotnet.microsoft.com/en-us/download/dotnet-framework)** (or newer) is required.
   * The examples use the .NET Core SDK.
@@ -212,6 +219,13 @@ If your security requirements require you to run Java applications with the syst
   <TabItem value="dotnet" label=".NET">
 ```
 
+:::warning Deprecation Warning
+
+The .NET version of Hyper API is deprecated.
+Older versions of Hyper API will still be available via NuGET. In the future, .Net will not receive any new features or updates. The old packages will stay available on NuGET indefinitely, so you can keep using older versions in .Net. The other languages (Python, Java, C++) are not impacted by this in any way. In case this is causing issues for you, please reach out via [Slack](https://join.slack.com/t/tableau-datadev/shared_invite/zt-1q4rrimsh-lHHKzrhid1MR4aMOkrnAFQ).
+
+:::
+
 You can install the Hyper API for .NET in two ways. You can either download the `.zip` file that contains the library and example code, or you can install the NuGet package for the library, either directly, or by adding a reference to your project.
 
 ### Using the Hyper API NuGet package {#using-the-hyper-api-nuget-package}

diff --git a/website/docs/releases.md b/website/docs/releases.md
@@ -24,11 +24,9 @@ In case you are wondering why all our releases start with `0.0`, read [this FAQ
 ### 0.0.17782 [September 6nd, 2023]
 
 * Sharing a Hyper process between multiple programs is now supported. This allows for better resource management and performance if multiple programs that interact with Hyper run at the same time. See [HyperProcess: Performance Best Practices](/docs/hyper-api/hyper_process#performance).
-* The HyperAPI Python zip package is now removed since we have the package available on the Python Package Index (PyPI). You can install the Tableau Hyper API using the package installer `pip`.
+* The HyperAPI Python zip package was removed from our download page. The package is available on the Python Package Index (PyPI) and we recommend installation through `pip install tableauhyperapi` instead.
+* .Net Deprecation: The .NET version of Hyper API is deprecated. This release will be the last update for .NET. In the future, .NET will not receive any new features or updates. The old packages will stay available on NuGET indefinitely, so you can keep using older versions in .NET. The other languages (Python, Java, C++) are not impacted by this in any way. In case this is causing issues for you, please reach out via [Slack](https://join.slack.com/t/tableau-datadev/shared_invite/zt-1q4rrimsh-lHHKzrhid1MR4aMOkrnAFQ).
 
-    ```
-    pip install tableauhyperapi
-    ```
 
 ### 0.0.17537 [August 2nd, 2023]
 

diff --git a/website/src/components/DownloadPicker/index.tsx b/website/src/components/DownloadPicker/index.tsx
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
 import { config } from '@site/src/config';
 import { detectOS } from '@site/src/os_detection';
 import Tabs from '@theme/Tabs';
@@ -8,9 +8,34 @@ import styles from './styles.module.css';
 import LinuxIcon from '@site/static/img/devicon-linux.svg';
 import WindowsIcon from '@site/static/img/devicon-windows.svg';
 import MacosIcon from '@site/static/img/devicon-macos.svg';
-import Link from '@docusaurus/Link';
+
+type DotNetWarningProps = {
+    url: string;
+};
+
+function DotNetWarning({ url }: DotNetWarningProps) {
+    return (
+        <div style={{ 'margin-top': '1em' }}>
+            <Admonition type="danger" title="Deprecation Warning">
+                The .NET version of Hyper API is deprecated. Older versions of Hyper API will still be available via
+                NuGET. In the future, .Net will not receive any new features or updates. The old packages will stay
+                available on NuGET indefinitely, so you can keep using older versions in .Net. The other languages
+                (Python, Java, C++) are not impacted by this in any way. In case this is causing issues for you, please
+                reach out via{' '}
+                <a href="https://join.slack.com/t/tableau-datadev/shared_invite/zt-1q4rrimsh-lHHKzrhid1MR4aMOkrnAFQ">
+                    Slack
+                </a>
+                .
+                <br />
+                <br />
+                <a href={url}>Download the .Net Hyper API</a>
+            </Admonition>
+        </div>
+    );
+}
 
 export function DownloadPicker() {
+    const [displayDotnet, setDisplayDotnet] = useState(false);
     return (
         <Tabs defaultValue={detectOS()}>
             <TabItem
@@ -32,7 +57,10 @@ export function DownloadPicker() {
                         <a href={config.download.windows_java}>Java (Windows)</a>
                     </li>
                     <li>
-                        <a href={config.download.windows_dotnet}>.Net (Windows)</a>
+                        <a href="#" onClick={() => setDisplayDotnet(true)}>
+                            .Net (Windows)
+                        </a>
+                        {displayDotnet ? <DotNetWarning url={config.download.windows_dotnet} /> : <></>}
                     </li>
                 </ul>
             </TabItem>
@@ -55,7 +83,10 @@ export function DownloadPicker() {
                         <a href={config.download.macos_java}>Java (macOS)</a>
                     </li>
                     <li>
-                        <a href={config.download.macos_dotnet}>.Net (macOS)</a>
+                        <a href="#" onClick={() => setDisplayDotnet(true)}>
+                            .Net (macOS)
+                        </a>
+                        {displayDotnet ? <DotNetWarning url={config.download.macos_dotnet} /> : <></>}
                     </li>
                 </ul>
             </TabItem>
@@ -78,7 +109,10 @@ export function DownloadPicker() {
                         <a href={config.download.linux_java}>Java (Linux)</a>
                     </li>
                     <li>
-                        <a href={config.download.linux_dotnet}>.Net (Linux)</a>
+                        <a href="#" onClick={() => setDisplayDotnet(true)}>
+                            .Net (Linux)
+                        </a>
+                        {displayDotnet ? <DotNetWarning url={config.download.linux_dotnet} /> : <></>}
                     </li>
                 </ul>
             </TabItem>