Skip to content

[polaris.shopify.com] Add legacy documentation #8570

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
Merged
merged 4 commits into from
Mar 7, 2023
Merged

[polaris.shopify.com] Add legacy documentation #8570

merged 4 commits into from
Mar 7, 2023

Conversation

laurkim
Copy link
Contributor

@laurkim laurkim commented Mar 6, 2023 •
edited
Loading

WHY are these changes introduced?

Adds context for Legacy status on component lifecycle page and updates LegacyStack and LegacyCard component pages to suggest using AlphaStack and AlphaCard.

WHAT is this pull request doing?

  • Adds Legacy section to component lifecycle page
  • Adds legacy to status banner and status badge
  • Updates LegacyStack and LegacyCard to include banner marking it as legacy and suggesting AlphaStack and AlphaCard instead while also linking to component lifecycle page.

Here are screenshots of the updates:


Component lifecycle page
Component lifecycle page


LegacyCard page with status banner and status badge
LegacyCard page with status banner and status badge

How to 🎩

🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines

🎩 checklist

@laurkim laurkim self-assigned this Mar 6, 2023
@laurkim laurkim marked this pull request as ready for review March 6, 2023 20:53
jjgali
jjgali reviewed Mar 6, 2023
View reviewed changes
Copy link
Contributor

@jjgali jjgali left a comment

Choose a reason for hiding this comment

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

Very small grammatical suggestion. Other than that, looks great! 🚢

@laurkim laurkim merged commit 45ca38d into main Mar 7, 2023
@laurkim laurkim deleted the lo/add-legacy-documentation branch March 7, 2023 00:52
@shopify-github-actions-access shopify-github-actions-access bot mentioned this pull request Mar 7, 2023
Merged
@laurkim laurkim mentioned this pull request Mar 7, 2023
Merged
5 tasks
laurkim added a commit that referenced this pull request Mar 7, 2023
@laurkim
[polaris.shopify.com] Fix component lifecycle url in alpha banners (#…
0389fd8 
…8573)

### WHY are these changes introduced?

Noticed a broken URL in the alpha banner of Columns for the component
lifecycle page.
Also updated the copy for all the URLs to match what is in LegacyCard
and LegacyStack based off this
[feedback](#8570 (comment))
for consistency.

<img width="1195" alt="columns-1"
src="https://user-images.githubusercontent.com/26749317/223420647-00579282-fa42-40e3-858b-4d5e1bb55681.png">

### WHAT is this pull request doing?

Fixes typo in Columns alpha banner.
Updated copy in alpha component banner from `Component lifecycle` to
`component lifecycles`.

<!-- ℹ️ Delete the following for small / trivial changes -->

### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)

### 🎩 checklist

- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [x] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
kyledurand pushed a commit that referenced this pull request Mar 7, 2023
@shopify-github-actions-access @github-actions
Version Packages (#8568)
34f6e30 
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @shopify/polaris@10.34.0

### Minor Changes

- [#8546](#8546)
[`8872c0861`](8872c08)
Thanks [@MindRave](https://github.com/MindRave)! - Added "magic" color
to the Icon component's color prop type.


- [#8545](#8545)
[`7c174e47a`](7c174e4)
Thanks [@alex-page](https://github.com/alex-page)! - Updated DropZone
with a signifigant restructure to remove Class child component


- [#8525](#8525)
[`8a4de8168`](8a4de81)
Thanks [@rcaplanshopify](https://github.com/rcaplanshopify)! -
[IndexTable] Adds support for header config object alignment property
and treatment of right-aligned, sortable column headings


- [#8569](#8569)
[`646fba23f`](646fba2)
Thanks [@kyledurand](https://github.com/kyledurand)! - Allowed aria
attributes on Bleed, Inline, and Columns

### Patch Changes

- [#8581](#8581)
[`336d14545`](336d145)
Thanks [@kyledurand](https://github.com/kyledurand)! - Fixed a bug where
bulk actions wouldn't render when only promoted actions exist

## @shopify/polaris-cli@0.1.15



## polaris.shopify.com@0.38.1

### Patch Changes

- [#8570](#8570)
[`45ca38d41`](45ca38d)
Thanks [@laurkim](https://github.com/laurkim)! - Added `Legacy` status
to component lifecycle page and banner/badge to `LegacyStack` and
`LegacyCard`


- [#8573](#8573)
[`0389fd8b8`](0389fd8)
Thanks [@laurkim](https://github.com/laurkim)! - Fixed links to
component lifecycle page in alpha component banners

- Updated dependencies
\[[`336d14545`](336d145),
[`8872c0861`](8872c08),
[`7c174e47a`](7c174e4),
[`8a4de8168`](8a4de81),
[`646fba23f`](646fba2)]:
    -   @shopify/polaris@10.34.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
rdott added a commit that referenced this pull request Mar 7, 2023
@rdott
[polaris.shopify.com] Fix component lifecycle url in alpha banners (#…
2555b6a 
…8573)

Noticed a broken URL in the alpha banner of Columns for the component
lifecycle page.
Also updated the copy for all the URLs to match what is in LegacyCard
and LegacyStack based off this
[feedback](#8570 (comment))
for consistency.

<img width="1195" alt="columns-1"
src="https://user-images.githubusercontent.com/26749317/223420647-00579282-fa42-40e3-858b-4d5e1bb55681.png">

Fixes typo in Columns alpha banner.
Updated copy in alpha component banner from `Component lifecycle` to
`component lifecycles`.

<!-- ℹ️ Delete the following for small / trivial changes -->

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)

- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [x] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
@laurkim @juzser
[polaris.shopify.com] Add legacy documentation (Shopify#8570)
a9fb4ad 
### WHY are these changes introduced?

Adds context for Legacy status on component lifecycle page and updates
LegacyStack and LegacyCard component pages to suggest using AlphaStack
and AlphaCard.

### WHAT is this pull request doing?

- Adds `Legacy` section to component lifecycle page
- Adds `legacy` to status banner and status badge
- Updates `LegacyStack` and `LegacyCard` to include banner marking it as
legacy and suggesting `AlphaStack` and `AlphaCard` instead while also
linking to component lifecycle page.

Here are screenshots of the updates:
    <details>
      <summary>Component lifecycle page</summary>
<img
src="https://user-images.githubusercontent.com/26749317/223225303-9ac73318-67db-4048-b984-77e2928fdd30.png"
alt="Component lifecycle page">
    </details>
    <details>
<summary>LegacyCard page with status banner and status badge</summary>
<img
src="https://user-images.githubusercontent.com/26749317/223225302-f2cd943e-4f68-48db-9b43-3257fa274652.png"
alt="LegacyCard page with status banner and status badge">
    </details>

### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)

### 🎩 checklist

- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [x] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
@laurkim @juzser
[polaris.shopify.com] Fix component lifecycle url in alpha banners (S…
0a660ec 
…hopify#8573)

### WHY are these changes introduced?

Noticed a broken URL in the alpha banner of Columns for the component
lifecycle page.
Also updated the copy for all the URLs to match what is in LegacyCard
and LegacyStack based off this
[feedback](Shopify#8570 (comment))
for consistency.

<img width="1195" alt="columns-1"
src="https://user-images.githubusercontent.com/26749317/223420647-00579282-fa42-40e3-858b-4d5e1bb55681.png">

### WHAT is this pull request doing?

Fixes typo in Columns alpha banner.
Updated copy in alpha component banner from `Component lifecycle` to
`component lifecycles`.

<!-- ℹ️ Delete the following for small / trivial changes -->

### How to 🎩

🖥 [Local development
instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development)
🗒 [General tophatting
guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md)
📄 [Changelog
guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog)

### 🎩 checklist

- [ ] Tested on
[mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing)
- [ ] Tested on [multiple
browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers)
- [ ] Tested for
[accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md)
- [ ] Updated the component's `README.md` with documentation changes
- [x] [Tophatted
documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md)
changes in the style guide
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
@shopify-github-actions-access @github-actions @juzser
Version Packages (Shopify#8568)
a5bad3e 
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @shopify/polaris@10.34.0

### Minor Changes

- [Shopify#8546](Shopify#8546)
[`8872c0861`](Shopify@8872c08)
Thanks [@MindRave](https://github.com/MindRave)! - Added "magic" color
to the Icon component's color prop type.


- [Shopify#8545](Shopify#8545)
[`7c174e47a`](Shopify@7c174e4)
Thanks [@alex-page](https://github.com/alex-page)! - Updated DropZone
with a signifigant restructure to remove Class child component


- [Shopify#8525](Shopify#8525)
[`8a4de8168`](Shopify@8a4de81)
Thanks [@rcaplanshopify](https://github.com/rcaplanshopify)! -
[IndexTable] Adds support for header config object alignment property
and treatment of right-aligned, sortable column headings


- [Shopify#8569](Shopify#8569)
[`646fba23f`](Shopify@646fba2)
Thanks [@kyledurand](https://github.com/kyledurand)! - Allowed aria
attributes on Bleed, Inline, and Columns

### Patch Changes

- [Shopify#8581](Shopify#8581)
[`336d14545`](Shopify@336d145)
Thanks [@kyledurand](https://github.com/kyledurand)! - Fixed a bug where
bulk actions wouldn't render when only promoted actions exist

## @shopify/polaris-cli@0.1.15



## polaris.shopify.com@0.38.1

### Patch Changes

- [Shopify#8570](Shopify#8570)
[`45ca38d41`](Shopify@45ca38d)
Thanks [@laurkim](https://github.com/laurkim)! - Added `Legacy` status
to component lifecycle page and banner/badge to `LegacyStack` and
`LegacyCard`


- [Shopify#8573](Shopify#8573)
[`0389fd8b8`](Shopify@0389fd8)
Thanks [@laurkim](https://github.com/laurkim)! - Fixed links to
component lifecycle page in alpha component banners

- Updated dependencies
\[[`336d14545`](Shopify@336d145),
[`8872c0861`](Shopify@8872c08),
[`7c174e47a`](Shopify@7c174e4),
[`8a4de8168`](Shopify@8a4de81),
[`646fba23f`](Shopify@646fba2)]:
    -   @shopify/polaris@10.34.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kyledurand kyledurand kyledurand approved these changes

@sarahill sarahill Awaiting requested review from sarahill

+1 more reviewer

@jjgali jjgali jjgali left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@laurkim laurkim

Labels

polaris.shopify.com

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@laurkim @kyledurand @jjgali