-
Notifications
You must be signed in to change notification settings - Fork 67
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.
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
Update documentation to remove formation and add css-library #3650
Changes from all commits
96daa7f
e25acd5
92e547f
9f6027b
06b560a
6536c1b
af46940
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,8 +16,7 @@ | |
"keywords": [ | ||
"Vets.gov", | ||
"design", | ||
"uswds", | ||
"formation" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👋🏼 byeeee |
||
"uswds" | ||
], | ||
"author": "Matthew Dingee", | ||
"license": "ISC", | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,9 +44,15 @@ The VA follows the USWDS spacing unit tokens and then adds additional semantic t | |
|
||
## Using the spacing units | ||
|
||
In order to keep spacing consistent throughout VA.gov, it is recommended you favor using the `units` functions instead of hard coding pixels (or relative units) for margins and padding. | ||
In order to keep spacing consistent throughout VA.gov, it is recommended you favor using the unit tokens instead of hard coding pixels (or relative units) for margins and padding. | ||
|
||
In order to access the spacing tokens in your project, you will need to import the [base files](https://github.com/department-of-veterans-affairs/veteran-facing-services-tools/tree/master/packages/formation/sass/base) into your project. [Here is how this site is doing that](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/src/assets/stylesheets/application.scss#L5). | ||
In order to access the unit tokens in your project, you will need to import the [variables file](https://github.com/department-of-veterans-affairs/component-library/tree/main/packages/css-library/dist/tokens/css/variables.css) into your project. | ||
<!-- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I removed this link to look at an example because the code shows code references to formation. I will leave a comment on the ticket for updating the code references to re-add this link. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This piece about spacing tokens is a little confusing because the paragraph above references a units function 🤔 Can spacing tokens be accessed directly be importing https://github.com/department-of-veterans-affairs/component-library/blob/main/packages/css-library/dist/tokens/css/variables.css? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I updated this. I think the spacing tokens can be used by importing that variables file. |
||
|
||
ToDo: uncomment after removing formation imports | ||
[Here is how this site is doing that](https://github.com/department-of-veterans-affairs/vets-design-system-documentation/blob/main/src/assets/stylesheets/application.scss#L5). | ||
|
||
--> | ||
|
||
There are two ways of using the spacing tokens in your code. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just updated this copy and I'm not sure if there is a better way to give these instructions or if we need to update them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree I think there might be some things we need to confirm before we can give these instructions. I have a feeling that even the Formation instructions don't actually work any more.
I would lean towards removing these steps completely rather than say something that doesn't work. Should we create a follow-up ticket for writing new steps for testing? Or maybe just remove this and link to the component-library vets-website testing instructions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@powellkerry did you happen to test the steps below to see if they work for css library? I'm specifically interested in learning if that local version thing on line 74 works, since that seems to be the key piece for connecting the two repos for local testing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@micahchiang yes the instructions work, but it's not as easy as they imply. I had to remove the node_modules directory and run yarn in vets-design-system-documentation in order for any changes to show. I think updating the instructions to use verdaccio might be better?