docs(cyclebutton): setup for deprecation (#2536)

* docs(deprecation): update link example from html to markdown * docs(cyclebutton): setup for deprecation
adobe · Feb 16, 2024 · fa56444 · fa56444
1 parent ab72d5d
commit fa56444
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 12 deletions.
diff --git a/.storybook/guides/deprecation.mdx b/.storybook/guides/deprecation.mdx
@@ -47,7 +47,7 @@ Before removing the component from the codebase, we need to flag the component a
     ```yaml
     name: Quick actions
     status: Deprecated
-    deprecationNotice: Use an <a href="actionbar.html">action bar</a> to allow users to perform actions on either a single or multiple items at the same time, instead.
+    deprecationNotice: Use an [action bar](actionbar.html) to allow users to perform actions on either a single or multiple items at the same time, instead.
     ```
 4. Commit these changes and open a pull request to the main branch. i.e., `git commit -m "chore(quickaction): prepare for deprecation"`.
 5. Once the pull request is approved, merge the changes into the main branch and publish the update to the package registry.

diff --git a/components/cyclebutton/metadata/cyclebutton.yml b/components/cyclebutton/metadata/cyclebutton.yml
@@ -1,9 +1,6 @@
 name: Cycle button
-sections:
-  - name: Migration Guide
-    description: |
-      ### Change workflow icon size to medium
-      Replace `.spectrum-Icon--sizeS` with `.spectrum-Icon--sizeM`.
+status: Deprecated
+deprecationNotice: Use the [quiet variant of action button](actionbutton.html#quiet) with the appropriate icon(s) instead. Any icon swapping that happens on-click/on-key should be handled by the implementation.
 examples:
   - id: cyclebutton
     name: Standard

diff --git a/components/cyclebutton/stories/cyclebutton.stories.js b/components/cyclebutton/stories/cyclebutton.stories.js
@@ -1,11 +1,11 @@
 // Import the component markup template
-import { Template } from "./template";
+import { Template } from "@spectrum-css/cyclebutton/stories/template";
 
-import { default as IconStories } from "@spectrum-css/icon/stories/icon.stories.js";
 import { default as ActionButtonStories } from "@spectrum-css/actionbutton/stories/actionbutton.stories.js";
+import { default as IconStories } from "@spectrum-css/icon/stories/icon.stories.js";
 
 export default {
-	title: "Components/Cycle button",
+	title: "Deprecated/Cycle button",
 	description:
 		"The Cycle button component is an action button that cycles through two different icons, a play that then changes to a pause, for example.",
 	component: "CycleButton",
@@ -35,10 +35,9 @@ export default {
 		actions: {
 			handles: [...(ActionButtonStories?.parameters?.actions?.handles ?? [])],
 		},
+		chromatic: { disable: true },
 		status: {
-			type: process.env.MIGRATED_PACKAGES.includes("cyclebutton")
-				? "migrated"
-				: undefined,
+			type: "deprecated"
 		},
 	},
 };