comments

Author: pranav300

packages/terra-overlay/CHANGELOG.md

@@ -3,7 +3,7 @@
 ## Unreleased
 
 * Added
-  * Added a deprecated notice.
+  * Added a deprecation notice.
 
 ## 3.62.0 - (February 2, 2021)
 

packages/terra-overlay/README.md

@@ -13,7 +13,7 @@ Any apps that currently use terra-overlay will continue to work as-is.
 However, the terra-overlay package will no longer continue to be supported / developed.
 
 ## Why?
-Terra Overlay design is a bad pattern and hence it is being deprecated.
+The reason behind Terra-Overlay deprecation is to integrate the presentation of overlays with the overall application framework to ensure better accessibility. 
 
 ## How to replace this package?
 This package can be replaced with [terra-application-loading-overlay](https://engineering.cerner.com/terra-ui/application/terra-application/components/application-loading-overlay)

packages/terra-overlay/src/terra-dev-site/doc/overlay/ChangeLog.3.doc.mdx packages/terra-overlay/src/terra-dev-site/doc/overlay/ChangeLog.4.doc.mdx

@@ -0,0 +1,13 @@
+## Deprecation Notice
+
+The terra-overlay npm package is deprecated as of `3.62.0`. terra-overlay will be removed from the repo in a future version, but the package will remain on npm.
+
+### What deprecation means
+Any apps that currently use terra-overlay will continue to work as-is.
+However, the terra-overlay package will no longer continue to be supported / developed.
+
+## Why?
+The reason behind Terra-Overlay deprecation is to integrate the presentation of overlays with the overall application framework to ensure better accessibility. 
+
+## How to replace this package?
+This package can be replaced with [terra-application-loading-overlay](https://engineering.cerner.com/terra-ui/application/terra-application/components/application-loading-overlay)

packages/terra-overlay/src/terra-dev-site/doc/overlay/DeprecationGuide.2.doc.mdx

@@ -1,4 +1,5 @@
 import { Badge } from 'terra-overlay/package.json?dev-site-package';
+import { Notice } from '@cerner/terra-docs';
 
 import OverlayExample from '../example/OverlayExample?dev-site-example';
 import LoadingOverlayExample from '../example/LoadingOverlayExample?dev-site-example';
@@ -10,6 +11,16 @@ import LoadingOverlayPropsTable from 'terra-overlay/src/LoadingOverlay?dev-site-
 <Badge />
 
 # Terra Overlay
+<Notice variant='maintenance'>
+
+This component has been moved to [terra-application](/application/terra-application/components/application-loading-overlay) and should be imported from that package. While this is the final major version of this component we will release, this component will continue to receive minor updates until terra adopts react 17.
+
+```diff
+- import Overlay from 'terra-overlay';
++ import ApplicationLoadingOverlay from 'terra-application/lib/application-loading-overlay';
+```
+
+</Notice>
 The Overlay component is a component that creates an semi-transparent overlay screen that blocks interactions with the elements underneath the display. There are two types of overlays: fullscreen and relative to its container.
 
 When creating as an overlay relative to its container, place the overlay component within the overlay wrapper and the element(s) which should be hidden by overlay within the content(children) wrapper of Overlay Container subcomponent.