[terra-core-docs] Introducing terra-core-docs #3431
Conversation
mjhenkes
requested review from
dkasper-was-taken,
ryanthemanuel and
tbiethman
as code owners
| "terra-button": "^3.55.0", | ||
| "terra-hyperlink": "^2.47.0", | ||
| "terra-spacer": "^3.54.0", |
There was a problem hiding this comment.
This right here is awesome, fewer dependencies, smaller component footprints.
| "precompile": "rm -rf lib" | ||
| }, | ||
| "dependencies": { | ||
| "terra-action-footer": "^2.60.0", |
There was a problem hiding this comment.
i don't need all these dependencies for this package out of the gate, but we will need them all once we've migrated. These are just dependencies from terra-core but we can easily add any terra dependencies here.
| @@ -40,7 +40,7 @@ | |||
| "clean:obsolete-snapshots": "npm test -- -u", | |||
| "create-props-markdown": "node scripts/props-table-gen/generatePropsTables.js", | |||
| "compile": "npm run compile:clean && npm run compile:build", | |||
| "compile:build": "lerna ls | sed 's/@cerner\\///g' | cut -d ' ' -f1 | xargs -I {} babel packages/{}/src --out-dir packages/{}/lib --copy-files", | |||
| "compile:build": "lerna ls -a | sed 's/@cerner\\///g' | cut -d ' ' -f1 | xargs -I {} babel packages/{}/src --out-dir packages/{}/lib --copy-files", | |||
There was a problem hiding this comment.
this change will allow lerna ls to pickup private packages, which we want for compiling. we just don't want to release it yet.
| @@ -1,30 +1,30 @@ | |||
| Terra.describeViewports('ActionFooter', ['small', 'medium'], () => { | |||
| it('displays ActionFooter with multiple end actions', () => { | |||
| browser.url('/#/raw/tests/terra-action-footer/action-footer/multiple-end-action-footer'); | |||
| browser.url('/raw/tests/terra-core-docs/action-footer/multiple-end-action-footer'); | |||
There was a problem hiding this comment.
Since tests are shipped with the component, does this mean terra-core-docs is expected to be installed for testing?
There was a problem hiding this comment.
you'd need to yes, but i think we should discontinue the practice of shipping tests with components.
There was a problem hiding this comment.
I had considered moving the wdio tests to the docs package as well, but I ended up not wanting to mess with how we currently can run just the tests for a specific package.
Co-authored-by: Ben Cai <bcai@cerner.com>
| @@ -0,0 +1,6 @@ | |||
| import { Badge } from 'terra-action-header/package.json?dev-site-package'; | |||
There was a problem hiding this comment.
Not sure why this ChangeLog.3.dooc.mdx file shows up as a new file being added. I would think it should be shown as a file that is just moved to a different location similar to https://github.com/cerner/terra-core/pull/3431/files#diff-3ed4d041ad6d8833ce057565742867826eec7fef430f2f612042149c25337704?
There was a problem hiding this comment.
yeah it was moved, but i changed it just enough for git to not want to mark it as moved.
Summary
This PR introduces the terra-core-docs package and migrates doc and test pages from terra-action-footer and terra-action-header.
Goals:
Considerations:
Closes #
Deployment Link
https://terra-core-deployed-pr-#.herokuapp.com/
Testing
Additional Details
Thank you for contributing to Terra.
@cerner/terra