Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

[terra-core-docs] Introducing terra-core-docs #3431

Merged
merged 8 commits into from
May 4, 2021
Merged

[terra-core-docs] Introducing terra-core-docs #3431

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
edecbe8
Introducing terra-core-docs
mjhenkes Apr 30, 2021
4992604
remove npm ignore
mjhenkes Apr 30, 2021
1f7e3be
change logs
mjhenkes Apr 30, 2021
27b6ea7
Make repo private until we're ready to release.
mjhenkes Apr 30, 2021
f3af0d3
oops, missed some tests
mjhenkes Apr 30, 2021
471965c
compile private packages
mjhenkes Apr 30, 2021
3326f0f
Update packages/terra-core-docs/package.json
mjhenkes May 3, 2021
3da7b6c
Merge branch 'main' into terra-core-docs
mjhenkes May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lerna.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
{
"command": {
"publish": {
"ignoreChanges": [
"packages/terra-core-docs/**"
]
}
},
"packages": [
"packages/*"
],
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this change will allow lerna ls to pickup private packages, which we want for compiling. we just don't want to release it yet.

"compile:clean": "rm -rf packages/**/lib",
"compile:prod": "rm -rf ./build; webpack -p",
"compile:lowlight": "rm -rf ./build; THEME=clinical-lowlight-theme webpack -p",
Expand Down
6 changes: 5 additions & 1 deletion packages/terra-action-footer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

* Changed
* migrate doc to terra-core-docs
* remove unnecessary dependencies

## 2.60.0 - (April 13, 2021)

* Changed
Expand All @@ -22,7 +26,7 @@
## 2.57.0 - (January 5, 2021)

* Fixed
* Fixed broken links in documentation.
* Fixed broken links in documentation.

## 2.56.0 - (December 8, 2020)

Expand Down
3 changes: 0 additions & 3 deletions packages/terra-action-footer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@
"dependencies": {
"classnames": "^2.2.5",
"prop-types": "^15.5.8",
"terra-button": "^3.55.0",
"terra-hyperlink": "^2.47.0",
"terra-spacer": "^3.54.0",
Comment on lines -31 to -33
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This right here is awesome, fewer dependencies, smaller component footprints.

"terra-theme-context": "^1.0.0"
},
"scripts": {
Expand Down
4 changes: 0 additions & 4 deletions ...ra-action-footer/src/terra-dev-site/test/action-footer/EmptyCenteredActionFooter.test.jsx
View file
Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions ...ion-footer/src/terra-dev-site/test/action-footer/WithoutActionsBlockActionFooter.test.jsx
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions packages/terra-action-footer/tests/wdio/action-footer-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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');
Copy link
Contributor

Choose a reason for hiding this comment

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

Since tests are shipped with the component, does this mean terra-core-docs is expected to be installed for testing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you'd need to yes, but i think we should discontinue the practice of shipping tests with components.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.


Terra.validates.element('multiple end actions');
});

it('displays ActionFooter with multiple start actions', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/multiple-start-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/multiple-start-action-footer');

Terra.validates.element('multiple start actions');
});

it('displays ActionFooter with single end action', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/single-end-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/single-end-action-footer');

Terra.validates.element('single end action');
});

it('displays ActionFooter with single start action', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/single-start-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/single-start-action-footer');

Terra.validates.element('single start action');
});

it('displays ActionFooter with single start and end action', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/single-start-end-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/single-start-end-action-footer');

Terra.validates.element('single start and end action');
});
Expand Down
4 changes: 2 additions & 2 deletions packages/terra-action-footer/tests/wdio/block-action-footer-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Terra.describeViewports('BlockActionFooter', ['small', 'medium'], () => {
it('displays BlockActionFooter with no actions', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/without-actions-block-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/without-actions-block-action-footer');

Terra.validates.element('no actions');
});

it('displays BlockActionFooter with actions', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/with-actions-block-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/with-actions-block-action-footer');

Terra.validates.element('with actions');
});
Expand Down
4 changes: 2 additions & 2 deletions packages/terra-action-footer/tests/wdio/centered-action-footer-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Terra.describeViewports('CenteredActionFooter', ['small', 'medium'], () => {
it('displays CenteredActionFooter with multiple actions', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/multiple-action-centered-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/multiple-action-centered-action-footer');

Terra.validates.element('multiple actions');
});

it('displays CenteredActionFooter with single action', () => {
browser.url('/#/raw/tests/terra-action-footer/action-footer/single-action-centered-action-footer');
browser.url('/raw/tests/terra-core-docs/action-footer/single-action-centered-action-footer');

Terra.validates.element('single action');
});
Expand Down
6 changes: 5 additions & 1 deletion packages/terra-action-header/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

* Changed
* migrate doc to terra-core-docs
* remove unnecessary dependencies

## 2.66.0 - (April 13, 2021)

* Changed
Expand Down Expand Up @@ -31,7 +35,7 @@
* Removed usage of `FormattedMessage` in favor of `injectIntl`

* Fixed
* Fixed broken links in documentation.
* Fixed broken links in documentation.

## 2.61.0 - (December 8, 2020)

Expand Down
2 changes: 0 additions & 2 deletions packages/terra-action-header/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
"classnames": "^2.2.5",
"prop-types": "^15.5.8",
"terra-button": "^3.55.0",
"terra-button-group": "^3.55.0",
"terra-icon": "^3.43.0",
"terra-mixins": "^1.40.0",
"terra-theme-context": "^1.0.0"
},
Expand Down
6 changes: 0 additions & 6 deletions ...es/terra-action-header/src/terra-dev-site/doc/action-header/ChangeLog.3.doc.mdx
View file
Open in desktop

This file was deleted.

22 changes: 11 additions & 11 deletions packages/terra-action-header/tests/wdio/action-header-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,66 @@
Terra.describeViewports('ActionHeader', ['tiny', 'medium', 'large'], () => {
it('displays default ActionHeader', () => {
browser.url('/raw/tests/terra-action-header/action-header/default-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/default-action-header');

Terra.validates.element('default');
});

it('displays ActionHeader with back', () => {
browser.url('/raw/tests/terra-action-header/action-header/back-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/back-action-header');

Terra.validates.element('back');
});

it('displays ActionHeader with back and close', () => {
browser.url('/raw/tests/terra-action-header/action-header/back-close-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/back-close-action-header');

Terra.validates.element('back close');
});

it('displays ActionHeader with close', () => {
browser.url('/raw/tests/terra-action-header/action-header/close-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/close-action-header');

Terra.validates.element('close');
});

it('displays ActionHeader with minimize custom button', () => {
browser.url('/raw/tests/terra-action-header/action-header/minimize-custom-button-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/minimize-custom-button-action-header');

Terra.validates.element('minimize custom button');
});

it('displays ActionHeader with maximize close', () => {
browser.url('/raw/tests/terra-action-header/action-header/maximize-close-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/maximize-close-action-header');

Terra.validates.element('maximize close');
});

it('displays ActionHeader with back close previous next', () => {
browser.url('/raw/tests/terra-action-header/action-header/back-close-previous-next-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/back-close-previous-next-action-header');

Terra.validates.element('back close previous next');
});

it('displays ActionHeader with next enabled previous disabled', () => {
browser.url('/raw/tests/terra-action-header/action-header/next-enabled-previous-disabled-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/next-enabled-previous-disabled-action-header');

Terra.validates.element('next enabled previous disabled');
});

it('displays ActionHeader with previous enabled next disabled', () => {
browser.url('/raw/tests/terra-action-header/action-header/previous-enabled-next-disabled-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/previous-enabled-next-disabled-action-header');

Terra.validates.element('previous enabled next disabled');
});

it('displays ActionHeader with wrapped title', () => {
browser.url('/raw/tests/terra-action-header/action-header/wrapped-title-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/wrapped-title-action-header');

Terra.validates.element('wrapped title');
});

it('displays ActionHeader with end element only', () => {
browser.url('/raw/tests/terra-action-header/action-header/end-element-action-header');
browser.url('/raw/tests/terra-core-docs/action-header/end-element-action-header');

Terra.validates.element('end element only');
});
Expand Down
1 change: 1 addition & 0 deletions packages/terra-core-docs/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
5 changes: 5 additions & 0 deletions packages/terra-core-docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Changelog

## Unreleased

* Initial stable release
Loading