From 39352917d81553f35a6d4bf96e72a051abf64d7c Mon Sep 17 00:00:00 2001 From: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> Date: Thu, 19 Sep 2024 15:26:16 -0400 Subject: [PATCH] docs(components): Adds and expands on deprecation. (#4226) * docs(components): Adds and expands on deprecation. * Update packages/documentation-framework/templates/mdx.js * List change. --- .../documentation-framework/templates/mdx.js | 4 ++-- .../content/get-started/about-patternfly.md | 17 +++++++++++++++++ .../get-started/img/deprecated-component.png | Bin 0 -> 121066 bytes .../components/components-data.json | 2 +- 4 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 packages/documentation-site/patternfly-docs/content/get-started/img/deprecated-component.png diff --git a/packages/documentation-framework/templates/mdx.js b/packages/documentation-framework/templates/mdx.js index efe0d07f8f..af8c4b1e6a 100644 --- a/packages/documentation-framework/templates/mdx.js +++ b/packages/documentation-framework/templates/mdx.js @@ -69,13 +69,13 @@ const MDXChildTemplate = ({ )} {(deprecated || source === 'react-deprecated' || source === 'html-deprecated') && ( - This implementation has been deprecated in favor of a newer implementation, and is no longer getting maintained or enhanced. + This component implementation has been deprecated in favor of a newer solution, and is no longer being maintained or enhanced. {newImplementationLink && ( You can find the updated implementation here. )} - {' '}To learn more about the process, visit our about page. + {' '}To learn more about deprecated components, visit about PatternFly. )} {(template || source === 'react-template') && ( diff --git a/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md b/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md index 12d7addb43..0836e02e9b 100644 --- a/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md +++ b/packages/documentation-site/patternfly-docs/content/get-started/about-patternfly.md @@ -313,6 +313,23 @@ If you are considering using a beta component, make sure to: 1. Check [the PatternFly Issues GitHub Project board](https://github.com/orgs/patternfly/projects/7/views/5) where we have created a view to categorize most issues by component. Browse any open issues for the beta component to determine how much more the beta component could evolve in the near future. +## Deprecated components + +Deprecated components are components that are no longer recommended for use in PatternFly, either due to significant design or code changes. Once deprecated, a component is replaced with a newer implementation, and the previous implementation is no longer maintained or enhanced. + +Deprecated components will typically be available to use until the next major release, after which no documentation will be included on the current release website. + +![Onsite deprecated component messages](./img/deprecated-component.png) + +Deprecation includes: + +1. Components that are removed completely, in favor of a different component. + - The newly recommended component will be mentioned and linked on the deprecated component's page. +1. Components that still exist, but have significant implementation changes. + - The new implementation will populate the "React tab," while documentation for the deprecated implementation will be placed under a "React deprecated" tab. You will see an alert on both the React and React deprecated pages. + +Deprecated components can be imported from @patternfly/react-core/deprecated. +