Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: adding a migration guide for the old security package components #4437

Merged
merged 32 commits into from
May 23, 2024
Merged

feat: adding a migration guide for the old security package components #4437

merged 32 commits into from
May 23, 2024

Conversation

jlongshore
Copy link
Contributor

@jlongshore jlongshore commented Feb 26, 2024 •
edited
Loading

Contributes to 4436

Migration guide for components being ported from the Security package to Carbon for IBM Products v2.

What did you change?

Adding a migration guide

How did you test and verify your work?

  • Initial technical review (Alan Coffey)
  • Design review (Cameron Calder)
  • Ensure all props changes are documented - including required to non-required

@jlongshore jlongshore added type: docs 📖 Improvements or additions to documentation package: security area: migration ➡️ Migration of Security package to IBM Products labels Feb 26, 2024
@netlify Netlify
Copy link

netlify bot commented Feb 26, 2024 •
edited
Loading

✅ Deploy Preview for carbon-for-ibm-products ready!

Name Link
🔨 Latest commit 1ab430b
🔍 Latest deploy log https://app.netlify.com/sites/carbon-for-ibm-products/deploys/65dcefcf6f7f2400089d5cc1
😎 Deploy Preview https://deploy-preview-4437--carbon-for-ibm-products.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify Netlify
Copy link

netlify bot commented Feb 26, 2024 •
edited
Loading

✅ Deploy Preview for carbon-for-ibm-products ready!

Name Link
🔨 Latest commit 1ad48cb
🔍 Latest deploy log https://app.netlify.com/sites/carbon-for-ibm-products/deploys/664d14419f7e5c00075e0dbc
😎 Deploy Preview https://deploy-preview-4437--carbon-for-ibm-products.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jlongshore and others added 20 commits February 26, 2024 14:29
@jlongshore
Wordsmithed a bit of the opening paragraph
776ce91
@jlongshore
Merge branch 'carbon-design-system:main' into longshorejeff/security_…
30eb458 
…component_migration_guide
@jlongshore
WIP
29d76eb
@jlongshore
WIP
6d2f3a0
@jlongshore
Updated a few of the migrated components.
7b28139
@paul-balchin-ibm
fix
790ff1d
@matassp @paul-balchin-ibm
refactor: convert ToolbarButton to typescript (#4440)
9daeca9 
* refactor: convert ToolbarButton to typescript

* docs: update url

* chore: format
@davidmenendez @paul-balchin-ibm
fix: add repository config to community package json (#4444)
fb3cbdd
@matthewgallo @paul-balchin-ibm
fix: add missing support for shouldDisableMenuItem (#4443)
dfa993d
@amal-k-joy @paul-balchin-ibm
fix(DataSpreadsheet): Reduce redundancy in handleKeyPress #4187 (#4217)
5354cbb 
* fix(DataSpreadsheet):refractor handleKeyPress method

* fix(DataSpreadsheet):refractor handleKeyPress method update1

* fix(DataSpreadsheet):refractor handleKeyPress method lint

* fix(DataSpreadsheet):refractor handleKeyPress method lint err

* fix(DataSpreadsheet):refractor handleKeyPress method lint cahnges
@SeonyuK @paul-balchin-ibm
feat: the button bar covers the last filter options for Datagrid filt…
2b15a47 
…er panel #4337 (#4350)
@jlongshore
Merge branch 'main' into longshorejeff/security_component_migration_g…
186f430 
…uide
@jlongshore
Test commit, disregard
2541d42
@jlongshore
Fixing my trivial change
5ac2c17
@jlongshore
Merge branch 'main' into longshorejeff/security_component_migration_g…
0ebe350 
…uide
@jlongshore
docs: continued progress on the migrated components section
21484be
@jlongshore
docs: simple changes
4a33546
@jlongshore
docs: added carbon components that were forwarded
155e4a3
@jlongshore
Merge branch 'main' into longshorejeff/security_component_migration_g…
6743835 
…uide
@jlongshore
docs: added LOE column to roughly aid in estimating effort to migrate
6c8b512
@elycheea elycheea mentioned this pull request Mar 26, 2024
Closed
@jlongshore jlongshore changed the title feat(Security component migration guide): Adding a migration guide for the old Security package components feat: adding a migration guide for the old security package components Apr 18, 2024
@jlongshore jlongshore marked this pull request as ready for review April 18, 2024 14:39
@jlongshore jlongshore requested a review from a team as a code owner April 18, 2024 14:39
elycheea
elycheea reviewed Apr 25, 2024
View reviewed changes
Copy link
Contributor

@elycheea elycheea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly formatting changes for consistency. But suggested listing renames as part of the changes for the new names as well.

So for ICA ➡️ BigNumbers ... we would include the note on rename on BigNumbers but include the **Renamed:** See [BigNumbers] on ICA too.

We did include some cleanup in #4923 but can update the smaller changes once the PR is merged.

docs/guides/security-component-migration.md Outdated
| `CodeSnippet` | No changes | `@carbon/react` | Low |
| `Column` | [Carbon v11 Migration guide][106] | `@carbon/react` | Medium |
| `ComboBox` | The `className` prop is now applied to the outermost element of `ComboBox` | `@carbon/react` | Low |
| `ComboButton` | Deprecated - Promoted to Carbon v11. [View component][107] | `@carbon/react` | High |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `ComboButton` | Deprecated - Promoted to Carbon v11. [View component][107] | `@carbon/react` | High |
| `ComboButton` | **Deprecated** — Promoted to Carbon v11. [View component][107] | `@carbon/react` | High |

docs/guides/security-component-migration.md Outdated
| `BreadcrumbSkeleton` | No changes | `@carbon/react` | Low |
| `Button` | [Carbon v11 Migration guide][102] | `@carbon/react` | Low |
| `ButtonSkeleton` | [Carbon v11 Migration guide][103] | `@carbon/react` | Low |
| `Card` | **Deprecated** [View replacement][1] | `@carbon/ibm-products` | Medium |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `Card` | **Deprecated** [View replacement][1] | `@carbon/ibm-products` | Medium |
| `Card` | **Deprecated:** [View replacement][1] | `@carbon/ibm-products` | Medium |

docs/guides/security-component-migration.md
| `ContentSwitcher` | Updated from a class to functional component | `@carbon/react` | Low |
| `ControlledPasswordInput` | The `size` prop has been updated to match `PasswordInput` | `@carbon/react` | Low |
| `CopyButton` | No changes | `@carbon/react` | Low |
| `DataDecorator` | **Deprecated:** [View replacement][2] | `@carbon/ibm-products` | Medium |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious if it’s worth mentioning that the DataDecorator and Decorators have been broken into multiple components (one to many).

docs/guides/security-component-migration.md Outdated
| `ControlledPasswordInput` | The `size` prop has been updated to match `PasswordInput` | `@carbon/react` | Low |
| `CopyButton` | No changes | `@carbon/react` | Low |
| `DataDecorator` | **Deprecated:** [View replacement][2] | `@carbon/ibm-products` | Medium |
| `DataTable` | No code changes. Scss changes can be found [here][108] | `@carbon/react` | Low |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `DataTable` | No code changes. Scss changes can be found [here][108] | `@carbon/react` | Low |
| `DataTable` | No code changes. SCSS changes can be found [here][108] | `@carbon/react` | Low |

docs/guides/security-component-migration.md Outdated
| `AccordionItem` | [Carbon v11 Migration guide][100] | `@carbon/react` | Low |
| `AccordionSkeleton` | The deprecated prop `uid` is no longer needed and has been removed | `@carbon/react` | Low |
| `ActionableNotification` | [Carbon v11 Migration guide][101] | `@carbon/react` | Low |
| `BigNumbers` (ICA) | View changes [here](#bignumbers) | `@carbon/ibm-products` | Low |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder if it’s easier to list the name change as part of the Changes section.

Suggested change
| `BigNumbers` (ICA) | View changes [here](#bignumbers) | `@carbon/ibm-products` | Low |
| `BigNumbers` | Renamed from `ICA`.<br/> View changes [here](#bignumbers) | `@carbon/ibm-products` | Low |

docs/guides/security-component-migration.md Outdated
| `SkeletonPlaceholder` | No changes | `@carbon/react` | Low |
| `SkeletonText` | No changes | `@carbon/react` | Low |
| `Slider` | [Carbon v11 Migration guide][127] | `@carbon/react` | Low |
| `StackedNotification` | **Removed** Proposing as a variant to Carbon notifications | — | High |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `StackedNotification` | **Removed** Proposing as a variant to Carbon notifications | — | High |
| `StackedNotification` | **Removed:** Proposing as a variant to Carbon notifications | — | High |

docs/guides/security-component-migration.md Outdated
| `StatusIcon` | **Deprecated:** [View replacement][12] | `@carbon/ibm-products` | Medium |
| `StatusIndicator` | View changes [here](#statusindicator) | `@carbon/ibm-products` | Medium |
| `StatusIndicatorStep` (StatusStep) | View changes [here](#statusindicatorstep) | `@carbon/ibm-products` | Low |
| `StatusStep` | **Renamed** See [StatusIndicatorStep](#statusindicatorstep) | — | — |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `StatusStep` | **Renamed** See [StatusIndicatorStep](#statusindicatorstep) | — | — |
| `StatusStep` | **Renamed:** See [StatusIndicatorStep](#statusindicatorstep) | — | — |

docs/guides/security-component-migration.md Outdated
| `TileAboveTheFoldContent` | Updated from a class to functional component | `@carbon/react` | Low |
| `TileBelowTheFoldContent` | Updated from a class to functional component | `@carbon/react` | Low |
| `TileGroup` | Updated from a class to functional component | `@carbon/react` | Low |
| `TimeIndicator` | **Removed** Too minimal to maintain | — | Medium |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `TimeIndicator` | **Removed** Too minimal to maintain | — | Medium |
| `TimeIndicator` | **Removed:** Too minimal to maintain | — | Medium |

docs/guides/security-component-migration.md Outdated
| `ToastNotification` | [Carbon v11 Migration guide][117] | `@carbon/react` | Medium |
| `Toggle` | [Carbon v11 Migration guide][136] | `@carbon/react` | Low |
| `ToggleSkeleton` | **Removed** | — | — |
| `ToggleSmall` | **Removed** Please use `<Toggle size="sm">` instead. [Carbon v11 Migration guide][136] | `@carbon/react` | Low |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `ToggleSmall` | **Removed** Please use `<Toggle size="sm">` instead. [Carbon v11 Migration guide][136] | `@carbon/react` | Low |
| `ToggleSmall` | **Removed:** Please use `<Toggle size="sm">` instead. [Carbon v11 Migration guide][136] | `@carbon/react` | Low |

docs/guides/security-component-migration.md Outdated
| `TooltipIcon` | [Carbon v11 Migration guide][137] | `@carbon/react` | Medium |
| `TrendingCard` | **Deprecated:** [View replacement][1] | `@carbon/ibm-products` | Medium |
| `TruncatedList` | View changes [here](#truncatedlist) | `@carbon/ibm-products` | Medium |
| `TypeLayout` | **Renamed** See [DescriptionList](#descriptionlist) | — | — |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `TypeLayout` | **Renamed** See [DescriptionList](#descriptionlist) | — | — |
| `TypeLayout` | **Renamed:** See [DescriptionList](#descriptionlist) | — | — |

@jlongshore jlongshore requested a review from a team as a code owner May 21, 2024 21:09
@jlongshore jlongshore requested review from davidmenendez and matthewgallo and removed request for a team May 21, 2024 21:09
@davidmenendez
Copy link
Contributor

@jlongshore i think there are still some changes that @elycheea requested that haven't been addressed?

@jlongshore
Copy link
Contributor Author

@jlongshore i think there are still some changes that @elycheea requested that haven't been addressed?

Just got it updated. Been a minute :D

@jlongshore jlongshore added this pull request to the merge queue May 23, 2024
Merged via the queue into carbon-design-system:main with commit d54fb50 May 23, 2024
16 checks passed
@jlongshore jlongshore deleted the longshorejeff/security_component_migration_guide branch May 23, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elycheea elycheea elycheea left review comments

@davidmenendez davidmenendez davidmenendez approved these changes

@matthewgallo matthewgallo matthewgallo approved these changes

Assignees
No one assigned
Labels
area: migration ➡️ Migration of Security package to IBM Products package: security type: docs 📖 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@jlongshore @davidmenendez @elycheea @matthewgallo @paul-balchin-ibm @matassp @amal-k-joy @SeonyuK