Create FORMATION_MIGRATION.md #1454
Conversation
micahchiang
added
the
ignore-for-release
| @@ -0,0 +1,102 @@ | |||
| ## Background | |||
| In December 2024 the design system team sunsetted Formation in vets-website in favor of [css library](https://github.com/department-of-veterans-affairs/component-library/tree/main/packages/css-library). Though migration has been completed for vets-website, content-build, and next-build, there may be some external teams that are still looking to migrate over. This documentation outlines necessary configuration for integrating css library into a stand alone project. | |||
There was a problem hiding this comment.
Where it says "css library" or "css-library" as a noun throughout, should we make it capitalized consistently? ie. CSS Library
There was a problem hiding this comment.
Agreed but I would vote for "CSS-Library" with the hyphen.
There was a problem hiding this comment.
yeah sorry it's inconsistent. My vote is for "css-library", since that's the name of the actual package, so we can compromise and go with Andrew's suggestion which seems like a happy medium 😄
| In December 2024 the design system team sunsetted Formation in vets-website in favor of [css library](https://github.com/department-of-veterans-affairs/component-library/tree/main/packages/css-library). Though migration has been completed for vets-website, content-build, and next-build, there may be some external teams that are still looking to migrate over. This documentation outlines necessary configuration for integrating css library into a stand alone project. | ||
|
|
||
| ## Installation | ||
| We recommend installing css-library as a dependency in your package.json file. It can be installed [via npm](https://www.npmjs.com/package/@department-of-veterans-affairs/css-library?activeTab=readme). If you're unable to use a package.json file to manage dependencies, then you may be able to import stylesheets using a cdn like unpkg. Files can be grabbed [here](https://unpkg.com/browse/@department-of-veterans-affairs/[email protected]/dist/). |
There was a problem hiding this comment.
The link to unkpg is going to a specific version. Is there a way we could point to where it can be linked without using a version that will become obsolete?
There was a problem hiding this comment.
Ah good catch, I'll try and update
There was a problem hiding this comment.
mm the URL needs a version, but I'll add a note stating users will need to use the select dropdown on the right to select the latest version.
|
|
||
| If your application needs VADS utility classes, add this import to your application stylesheet: | ||
|
|
||
| `@import "~@department-of-veterans-affairs/css-library/dist/stylesheets/utilities` |
There was a problem hiding this comment.
Does the utilities section need any clarification about the grid classes?
Signed-off-by: Micah Chiang <[email protected]>
Chromatic
https://mc-formation-migration-docs--65a6e2ed2314f7b8f98609d8.chromatic.com
Configuring this pull request
major,minor,patch, orignore-for-release).ignore-for-releaseif files haven't been changed in a component library package. (ie. only Storybook files)Description
Closes 3623
QA Checklist - not applicable
Acceptance criteria
Definition of done