From 7da83c307fe3b65becae5ba901b76360b64dbba8 Mon Sep 17 00:00:00 2001 From: Laura Silva <91160746+silvalaura@users.noreply.github.com> Date: Tue, 22 Oct 2024 04:03:26 -0400 Subject: [PATCH] Deprecate schema-renderer and header patterns (#1505) --- .changeset/chore-deprecate-header.md | 5 +++++ .changeset/chore-deprecate-schema.md | 5 +++++ packages/schema-renderer/README.md | 2 +- patterns/header/README.md | 2 ++ website/react-magma-docs/src/pages/api/schema-renderer.mdx | 4 ++++ website/react-magma-docs/src/pages/patterns/header.mdx | 4 ++++ 6 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 .changeset/chore-deprecate-header.md create mode 100644 .changeset/chore-deprecate-schema.md diff --git a/.changeset/chore-deprecate-header.md b/.changeset/chore-deprecate-header.md new file mode 100644 index 0000000000..a45d294823 --- /dev/null +++ b/.changeset/chore-deprecate-header.md @@ -0,0 +1,5 @@ +--- +'@cengage-patterns/header': patch +--- + +Deprecate @cengage-patterns/header package. diff --git a/.changeset/chore-deprecate-schema.md b/.changeset/chore-deprecate-schema.md new file mode 100644 index 0000000000..0321ae47f3 --- /dev/null +++ b/.changeset/chore-deprecate-schema.md @@ -0,0 +1,5 @@ +--- +'@react-magma/schema-renderer': patch +--- + +Deprecate @react-magma/schema-renderer package. diff --git a/packages/schema-renderer/README.md b/packages/schema-renderer/README.md index b356764aec..d2c29bc631 100644 --- a/packages/schema-renderer/README.md +++ b/packages/schema-renderer/README.md @@ -1,6 +1,6 @@ # React Magma Schema Renderer -** THIS PACKAGE IS CURRENTLY A WORK IN PROGRESS AND EXTREMELY BETA. THERE MAY BE BREAKING CHANGES. ** +** THIS PACKAGE HAS BEEN DEPRECATED ** ```` import * as React from 'react'; diff --git a/patterns/header/README.md b/patterns/header/README.md index ddc5145d0d..57522e924a 100644 --- a/patterns/header/README.md +++ b/patterns/header/README.md @@ -1,3 +1,5 @@ # Header +** THIS PACKAGE HAS BEEN DEPRECATED ** + The Header pattern is a highly-opinionated, advanced component composed of smaller React Magma components. It includes options for a logo, a call to action, a search bar, and icon buttons. The Header pattern will handle the order and placement of these elements. diff --git a/website/react-magma-docs/src/pages/api/schema-renderer.mdx b/website/react-magma-docs/src/pages/api/schema-renderer.mdx index 0f3c155f60..0f60cb464e 100644 --- a/website/react-magma-docs/src/pages/api/schema-renderer.mdx +++ b/website/react-magma-docs/src/pages/api/schema-renderer.mdx @@ -7,6 +7,10 @@ import { LeadParagraph } from '../../components/LeadParagraph'; + + SchemaRenderer is deprecated. + + The SchemaRenderer is an advanced component which maps other React Magma components to a defined Schema. This allows developers to render data driven diff --git a/website/react-magma-docs/src/pages/patterns/header.mdx b/website/react-magma-docs/src/pages/patterns/header.mdx index 6dfd80436b..8a9931c094 100644 --- a/website/react-magma-docs/src/pages/patterns/header.mdx +++ b/website/react-magma-docs/src/pages/patterns/header.mdx @@ -7,6 +7,10 @@ import { LeadParagraph } from '../../components/LeadParagraph'; + + Header pattern is deprecated. + + The Header pattern is a highly-opinionated, advanced component composed of smaller React Magma components. It includes options for a logo, a call to