Merge pull request MicrosoftDocs#3106 from MicrosoftDocs/user/mikehoffms/relnotes-pages

captainbrosset · web-flow · commit 9675ffc5432d · 2024-03-21T09:56:45.000+01:00
Break up Release Notes into 3 pages: About, latest 5 months, &amp; Archived
diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json
diff --git a/microsoft-edge/developer/index.yml b/microsoft-edge/developer/index.yml
@@ -168,7 +168,7 @@ landingContent:
       - linkListType: whats-new
         links:
           - text: Release Notes for the WebView2 SDK
-            url: ../webview2/release-notes.md
+            url: ../webview2/release-notes/index.md
       - linkListType: reference
         links:
           - text: WebView2 API Reference
diff --git a/microsoft-edge/devtools-guide-chromium/whats-new/whats-new-archive.md b/microsoft-edge/devtools-guide-chromium/whats-new/whats-new-archive.md
@@ -48,4 +48,4 @@ The following What's New entries cover older releases.
 * [What's New in DevTools (Microsoft Edge 80)](2019/12/devtools.md)
 
 See also:
-* [What's New in Microsoft Edge DevTools](whats-new.md)
+* [What's New in Microsoft Edge DevTools](./whats-new.md)
diff --git a/microsoft-edge/index.yml b/microsoft-edge/index.yml
@@ -292,7 +292,7 @@ conceptualContent:
               itemType: download
 
             - text: Release Notes for the WebView2 SDK
-              url: ./webview2/release-notes.md
+              url: ./webview2/release-notes/index.md
               itemType: whats-new
 
             - text: WebView2 API Reference
diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml
@@ -1434,11 +1434,25 @@
             - name: Publish a UWP WebView2 app to the Microsoft Store
               href: webview2/how-to/publish-uwp-app-store.md
               displayName: Partner Center, Microsoft Store
+# -----------------------------------------------------------------
+# relnotes
+        - name: Release Notes
+          items:
+            - name: About  # new page
+              href: webview2/release-notes/about.md
+              displayName: About Release Notes for the WebView2 SDK, what's new, announcements  # top-of-page title
+
+            - name: Release Notes
+              href: webview2/release-notes/index.md  # new location & file name, instead of at wv2 root
+              displayName: Release Notes for the WebView2 SDK, what's new, announcements  # top-of-page title
+
+            - name: Archived Release Notes  # new page
+              href: webview2/release-notes/archive.md
+              displayName: Archived Release Notes for the WebView2 SDK, what's new, announcements  # top-of-page title
 
-        - name: Release Notes for the WebView2 SDK
-          href: webview2/release-notes.md
-          displayName: what's new, announcements
 
+# end of relnotes
+# -----------------------------------------------------------------
         - name: WebView2 Roadmap
           href: webview2/roadmap.md
 
diff --git a/microsoft-edge/webview2/concepts/distribution.md b/microsoft-edge/webview2/concepts/distribution.md
@@ -144,7 +144,7 @@ The vast majority of Windows 10 devices have the WebView2 Runtime installed alre
 *  Redirect your end users to the Microsoft site: [Download Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/consumer/), and have end users download the Evergreen WebView2 Runtime installer from the site and install the Runtime themselves.
 
 See also:
-* [Understanding browser versions and WebView2](versioning.md).
+* [Understand the different WebView2 SDK versions](versioning.md).
 * [Delivering Microsoft Edge WebView2 Runtime to managed Windows 10 devices](https://blogs.windows.com/msedgedev/2022/12/14/delivering-microsoft-edge-webview2-runtime-to-managed-windows-10-devices/).
 
 
diff --git a/microsoft-edge/webview2/concepts/frames.md b/microsoft-edge/webview2/concepts/frames.md
@@ -302,7 +302,7 @@ For iframes, you can listen to network events and modify them, by using the `Web
 See also:
 * [Manage network requests in WebView2](./overview-features-apis.md#manage-network-requests-in-webview2) in _Overview of WebView2 features and APIs_.
 * [Custom management of network requests](../how-to/webresourcerequested.md)
-* [Experimental APIs for 1.0.1222-prerelease](../release-notes.md#experimental-apis-for-101222-prerelease) in _Release Notes for the WebView2 SDK_.
+* [Experimental APIs for 1.0.1222-prerelease](../release-notes/archive.md#experimental-apis-for-101222-prerelease) in _Archived Release Notes for the WebView2 SDK_.
 
 
 ##### [.NET/C#](#tab/dotnetcsharp)
diff --git a/microsoft-edge/webview2/concepts/overview-features-apis.md b/microsoft-edge/webview2/concepts/overview-features-apis.md
@@ -31,7 +31,7 @@ When hosting the WebView2 control, your app has access to the following features
 
 <!-- maintenance notes: add table rows for any new h2 sections -->
 
-This page only lists APIs that are in Release SDKs; it doesn't list Experimental APIs, or Stable APIs that are not yet available in Release SDKs.  For a comprehensive list of APIs including Experimental APIs, see [Release Notes for the WebView2 SDK](../release-notes.md).
+This page only lists APIs that are in Release SDKs; it doesn't list Experimental APIs, or Stable APIs that are not yet available in Release SDKs.  For a comprehensive list of APIs including Experimental APIs, see [Release Notes for the WebView2 SDK](../release-notes/index.md).
 
 
 <!-- ====================================================================== -->
diff --git a/microsoft-edge/webview2/concepts/versioning.md b/microsoft-edge/webview2/concepts/versioning.md
@@ -35,7 +35,7 @@ New APIs are introduced in phases as follows:
 | _Stable in a Release SDK_ | 3. Then the Stable API is promoted to be included in the Release SDK.  This typically happens 1 month after the API is promoted to Stable in a Prerelease SDK.  The API also remains in the Prerelease SDK. |
 
 ![Diagram of phases of introducing new APIs](./versioning-images/phases-of-adding-apis.png)
-<!-- .png is used by webview2/release-notes.md and webview2/concepts/versioning.md -->
+<!-- .png is used by webview2/release-notes/about.md and webview2/concepts/versioning.md -->
 
 <!-- terminology:
 APIs are Experimental or Stable
@@ -99,8 +99,7 @@ On a development machine, the client must have either the Microsoft Edge preview
 <!-- ====================================================================== -->
 ## Forward compatibility of APIs
 
-The WebView2 _release_ SDK has been forward-compatible ever since version 1 (that is, SDK version [1.0.622.22](../release-notes.md#1062222)).
-You can update your WebView2 app to use the latest APIs from the most recent Release version of the SDK.  Your app will continue to work on clients because clients automatically have the latest WebView2 Evergreen Runtime.
+The WebView2 _release_ SDK has been forward-compatible ever since version 1 (Release SDK [1.0.622.22](../release-notes/archive.md#1062222) in _Archived Release Notes for the WebView2 SDK_).  You can update your WebView2 app to use the latest APIs from the most recent Release version of the SDK.  Your app will continue to work on clients because clients automatically have the latest WebView2 Evergreen Runtime.
 
 The WebView2 APIs in a Release SDK package are stable and forward-compatible.  A WebView2 API works when using a WebView2 Runtime that has an equal or higher build number as the SDK build number in which the API was introduced.  The build number is the third part of the four-part version number for the Webview2 SDK, and of the four-part version number for Microsoft Edge and the WebView2 Runtime.
 
@@ -164,7 +163,7 @@ In the Evergreen distribution approach, the client's WebView2 Runtime automatica
 
 In case updating the WebView2 Runtime is prevented on the client, make sure that you know the minimum build number of the WebView2 Runtime that is required by your app.  To view or get the latest WebView2 Runtime versions, see [Download the WebView2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2/#download-section) in the _Microsoft Edge WebView2_ page at developer.microsoft.com.  The minimum required Runtime version to support the General Availability release of the SDK (build 616) is older than for the latest Runtime.  The latest Runtime supports all APIs that are in the latest Release SDK.
 
-To check the compatibility between specific build numbers of the SDK and the Runtime or Microsoft Edge preview channel, see [Release Notes for the WebView2 SDK](../release-notes.md).
+To check the compatibility between specific build numbers of the SDK and the Runtime or Microsoft Edge preview channel, see [Release Notes for the WebView2 SDK](../release-notes/index.md).
 
 
 <!-- ====================================================================== -->
diff --git a/microsoft-edge/webview2/how-to/webdriver.md b/microsoft-edge/webview2/how-to/webdriver.md
@@ -39,7 +39,7 @@ Follow the instructions to install [Microsoft Edge WebDriver](../../webdriver-ch
 
 Make sure the version of Microsoft Edge WebDriver matches the version of the WebView2 Runtime that your app uses.  For the WebView2API Sample to work, make sure your version of the WebView2 Runtime is greater than or equal to the supported version of the latest WebView2 SDK release.
 
-*  To locate the latest WebView2 SDK release, see [Release Notes for the WebView2 SDK](../release-notes.md).
+*  To locate the latest WebView2 SDK release, see [Release Notes for the WebView2 SDK](../release-notes/index.md).
 
 *  To find out which version of the WebView2 Runtime you currently have, go to `edge://settings/help`.
 
diff --git a/microsoft-edge/webview2/release-notes/about-images/phases-of-adding-apis.png b/microsoft-edge/webview2/release-notes/about-images/phases-of-adding-apis.png
diff --git a/microsoft-edge/webview2/release-notes/about.md b/microsoft-edge/webview2/release-notes/about.md
@@ -0,0 +1,102 @@
+---
+title: About Release Notes for the WebView2 SDK
+description: About Release Notes for Microsoft Edge WebView2, covering new features, APIs, and fixes for Win32, WPF, and WinForms.
+author: MSEdgeTeam
+ms.author: msedgedevrel
+ms.topic: conceptual
+ms.service: microsoft-edge
+ms.subservice: webview
+ms.date: 03/20/2024
+---
+# About Release Notes for the WebView2 SDK
+
+The WebView2 team updates the WebView2 Release SDK and the WebView2 Prerelease SDK on a four-week cadence.  These Release Notes contain the latest information on product announcements, additions, modifications, and breaking changes to the APIs.
+
+You can view the list of [Microsoft.Web.WebView2](https://www.nuget.org/packages/Microsoft.Web.WebView2) SDK packages at the NuGet site.
+
+Generally, release notes apply across the supported platforms, which are listed in [WebView2 API Reference](../webview2-api-reference.md).  For an outline of APIs that are in Release SDK packages, see [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md).
+
+Release Notes entries correspond to historical releases of WebView2, and are not updated over time.  References to "new features" and "experimental APIs" might become outdated as new versions of WebView2 are released.
+
+
+<!-- ====================================================================== -->
+## Phases of adding APIs
+
+New APIs are added in phases, as follows:
+1. APIs are initially introduced as Experimental APIs in a Prerelease SDK package.
+1. Then they become Stable APIs in a Prerelease SDK package.
+1. Soon after, they become Stable APIs in a Release SDK package.
+
+![Diagram of phases of introducing new APIs](./about-images/phases-of-adding-apis.png)
+<!-- .png is used by webview2/release-notes/about.md and webview2/concepts/versioning.md -->
+
+See also:
+* [Phases of introducing APIs](../concepts/versioning.md#phases-of-introducing-apis) in _Understand the different WebView2 SDK versions_.
+
+<!-- terminology:
+APIs are Experimental or Stable
+SDKs/packages are Prerelease or Release
+-->
+
+
+<!-- ====================================================================== -->
+## Updating the Runtime and SDK
+
+WebView2 changes may require an update to the Runtime, SDK, or both.  Most new APIs require both Runtime and SDK updates.  Starting with the February 2023 release, the update requirement for each bug fix is indicated as follows:
+
+| Indicator | Meaning |
+|---|---|
+| **Runtime and SDK**, or no indicator | Both the Runtime and the SDK need to be updated. |
+| **Runtime-only** | Only the Runtime needs to be updated. |
+| **SDK-only** | Only the SDK needs to be updated. |
+
+WebView2 shares code and binaries with the Microsoft Edge browser, and is released around the same time.  As a result, WebView2 Runtime releases generally also include Microsoft Edge updates.
+
+*  For Microsoft Edge updates, see [Release notes for Microsoft Edge Stable Channel](/deployedge/microsoft-edge-relnote-stable-channel) and [Release notes for Microsoft Edge Beta Channel](/deployedge/microsoft-edge-relnote-beta-channel).
+
+*  To update the WebView2 Runtime on your development machine and on user machines, see [Distribute your app and the WebView2 Runtime](../concepts/distribution.md).  To view or get the latest WebView2 Runtime versions, see [Download the WebView2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2/#download-section) in the _Microsoft Edge WebView2_ page at developer.microsoft.com.
+
+*  To install or update the WebView2 SDK, see [Install or update the WebView2 SDK](../how-to/machine-setup.md#install-or-update-the-webview2-sdk) in _Set up your Dev environment for WebView2_.
+
+
+<!-- ====================================================================== -->
+## Recommended browser channel and Runtime
+
+Make sure to re-compile your WebView2 app after updating the WebView2 SDK NuGet package.  The WebView2 team recommends the following:
+
+* Use the Canary preview channel of Microsoft Edge when you develop using a Prerelease version of the WebView2 SDK package.  Canary is the recommended preview channel, because it ships at the fastest cadence and has the newest APIs.
+
+* Use the Evergreen WebView2 Runtime when you use a release version of the WebView2 SDK package.
+
+For more information, see [Matching the Runtime version with the SDK version](../concepts/versioning.md#matching-the-runtime-version-with-the-sdk-version).
+
+
+<!-- ====================================================================== -->
+## Minimum version of the browser or Runtime to load WebView2
+
+To load WebView2, the minimum version of Microsoft Edge or the WebView2 Runtime is 86.0.616.0.  The minimum version to load WebView2 only changes when a breaking change occurs in the web platform.
+
+To use a Prerelease SDK along with a Microsoft Edge preview channel, see [Test upcoming APIs and features](../how-to/set-preview-channel.md).
+
+<!--
+Cross-framework API conventions
+
+Events:
+No EventHandler or CompletedHandler in .NET or WinRT.
+General event pattern:
+- Win32: add/remove_XYZ + XYZEventHandler
+- .NET/WinRT: XYZ event
+
+Async methods:
+- Win32: XYZ method + XYZCompletedHandler
+- .NET/WinRT: XYZAsync
+-->
+
+
+<!-- ====================================================================== -->
+## See also
+
+* [Release Notes for the WebView2 SDK](./index.md)
+* [Archived Release Notes for the WebView2 SDK](./archive.md)
+* [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md)
+* [Contacting the Microsoft Edge WebView2 team](../contact.md)
diff --git a/microsoft-edge/webview2/release-notes/archive.md b/microsoft-edge/webview2/release-notes/archive.md
diff --git a/microsoft-edge/webview2/release-notes/index.md b/microsoft-edge/webview2/release-notes/index.md
diff --git a/microsoft-edge/webview2/release-notes/template-prerelease.md b/microsoft-edge/webview2/release-notes/template-prerelease.md
