Skip to content
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

Re-add deprecated typography docs #8206

Merged
merged 4 commits into from
Feb 1, 2023
Merged

Re-add deprecated typography docs #8206

merged 4 commits into from
Feb 1, 2023

Conversation

laurkim
Copy link
Contributor

@laurkim laurkim commented Jan 30, 2023

WHY are these changes introduced?

Re-adds the deprecated typography docs and images on the style guide so that users can still reference them.
The get-props script had to be updated to resolve build errors. It was failing since the component files no longer existed in polaris-react/src/components.

WHAT is this pull request doing?

  • Re-add dep components images
  • Re-add dep component pages
  • Adds new deprecatedComponents array to the get-props file and if the parsed file matches any of the elements, return empty object
  • If component status is deprecated, props table is not rendered on component page

How to 🎩

🖥 Local development instructions
🗒 General tophatting guidelines
📄 Changelog guidelines

Copy-paste this code in playground/Playground.tsx:
import React from 'react';
import {Page} from '../src';

export function Playground() {
  return (
    <Page title="Playground">
      {/* Add the code you want to test in here */}
    </Page>
  );
}

🎩 checklist

@laurkim laurkim self-assigned this Jan 30, 2023
@laurkim laurkim marked this pull request as ready for review January 30, 2023 16:04
Copy link
Member

@sam-b-rose sam-b-rose left a comment

Choose a reason for hiding this comment

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

I like that we provide the mappings to the new components. Should we also include props and usage information until v12 for those not ready to upgrade quite yet? Looks like GitHub Primer does this by moving the components to a deprecated folder for referencing the documentation, but not exporting from the latest version index.

Maybe this is out of scope for this change. But possibly something to consider for future deprecated components.

@laurkim
Copy link
Contributor Author

laurkim commented Feb 1, 2023

I like that we provide the mappings to the new components. Should we also include props and usage information until v12 for those not ready to upgrade quite yet? Looks like GitHub Primer does this by moving the components to a deprecated folder for referencing the documentation, but not exporting from the latest version index.

Maybe this is out of scope for this change. But possibly something to consider for future deprecated components.

I think this is a valid point but may require a bigger refactor of the style guide and increase scope for this change by a significant amount. I'm going to merge this into the v11 branch but happy to continue to have this discussion 👍

@laurkim laurkim merged commit 1333261 into v11-major Feb 1, 2023
@laurkim laurkim deleted the lo/readd-type-docs branch February 1, 2023 15:21
@laurkim laurkim mentioned this pull request Feb 1, 2023
23 tasks
sam-b-rose added a commit that referenced this pull request May 26, 2023
## @shopify/polaris v11.0.0

### Dependencies

- [x] #8200

### NodeJS

- [x] #8201

### TypeScript

- [x] #8203

### Components

- [x] #7349
- [x] #7397
- [x] #7962
- [x] #8187
- [x] #8184
- [x] #8206
- [x] #7990
- [x] #8468
- [x] #8577
- [x] #8631
- [x] #8962

## @shopify/polaris-tokens v7.0.0

### Tokens
- [x] #6920
- [x] #8245
- [x] #4826
- [x] #8405

## @shopify/stylelint-polaris v7.0.0
- [x] #7622
- [x] #8419

# Post @shopify/polaris v11 shipping
- [ ] #8420

## Low priority or not ready breaking changes
- [x] Remove deprecated layout components
- [x] Release Layout primitive components

---------

Co-authored-by: Tim Layton <tmlayton@users.noreply.github.com>
Co-authored-by: Ryan Musgrave <ryan.musgrave@shopify.com>
Co-authored-by: Ryan Musgrave <ryanm128@gmail.com>
Co-authored-by: aveline <aveline@users.noreply.github.com>
Co-authored-by: Kyle Durand <kyledurand@users.noreply.github.com>
Co-authored-by: Matt Gregg <matt.gregg@shopify.com>
Co-authored-by: Alex Page <hi@alexpage.dev>
Co-authored-by: Lo Kim <lo.kim@shopify.com>
Co-authored-by: Ben Scott <227292+BPScott@users.noreply.github.com>
Co-authored-by: Aaron Casanova <32409546+aaronccasanova@users.noreply.github.com>
Co-authored-by: Sam Rose <11774595+samrose3@users.noreply.github.com>
Co-authored-by: Sam Rose <sam.rose@shopify.com>
Co-authored-by: Marc Thomas <marc.thomas@shopify.com>
Co-authored-by: Alex Page <19199063+alex-page@users.noreply.github.com>
Co-authored-by: Chloe Rice <18447883+chloerice@users.noreply.github.com>
Co-authored-by: Chloe Rice <chloerice@users.noreply.github.com>
Co-authored-by: Joe Thomas <joe.thomas@shopify.com>
Co-authored-by: Yuraima Estevez <yuraima.estevez@shopify.com>
Co-authored-by: shopify-github-actions-access[bot] <109624739+shopify-github-actions-access[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
juzser pushed a commit to juzser/polaris that referenced this pull request Jul 27, 2023
## @shopify/polaris v11.0.0

### Dependencies

- [x] Shopify#8200

### NodeJS

- [x] Shopify#8201

### TypeScript

- [x] Shopify#8203

### Components

- [x] Shopify#7349
- [x] Shopify#7397
- [x] Shopify#7962
- [x] Shopify#8187
- [x] Shopify#8184
- [x] Shopify#8206
- [x] Shopify#7990
- [x] Shopify#8468
- [x] Shopify#8577
- [x] Shopify#8631
- [x] Shopify#8962

## @shopify/polaris-tokens v7.0.0

### Tokens
- [x] Shopify#6920
- [x] Shopify#8245
- [x] Shopify#4826
- [x] Shopify#8405

## @shopify/stylelint-polaris v7.0.0
- [x] Shopify#7622
- [x] Shopify#8419

# Post @shopify/polaris v11 shipping
- [ ] Shopify#8420

## Low priority or not ready breaking changes
- [x] Remove deprecated layout components
- [x] Release Layout primitive components

---------

Co-authored-by: Tim Layton <tmlayton@users.noreply.github.com>
Co-authored-by: Ryan Musgrave <ryan.musgrave@shopify.com>
Co-authored-by: Ryan Musgrave <ryanm128@gmail.com>
Co-authored-by: aveline <aveline@users.noreply.github.com>
Co-authored-by: Kyle Durand <kyledurand@users.noreply.github.com>
Co-authored-by: Matt Gregg <matt.gregg@shopify.com>
Co-authored-by: Alex Page <hi@alexpage.dev>
Co-authored-by: Lo Kim <lo.kim@shopify.com>
Co-authored-by: Ben Scott <227292+BPScott@users.noreply.github.com>
Co-authored-by: Aaron Casanova <32409546+aaronccasanova@users.noreply.github.com>
Co-authored-by: Sam Rose <11774595+samrose3@users.noreply.github.com>
Co-authored-by: Sam Rose <sam.rose@shopify.com>
Co-authored-by: Marc Thomas <marc.thomas@shopify.com>
Co-authored-by: Alex Page <19199063+alex-page@users.noreply.github.com>
Co-authored-by: Chloe Rice <18447883+chloerice@users.noreply.github.com>
Co-authored-by: Chloe Rice <chloerice@users.noreply.github.com>
Co-authored-by: Joe Thomas <joe.thomas@shopify.com>
Co-authored-by: Yuraima Estevez <yuraima.estevez@shopify.com>
Co-authored-by: shopify-github-actions-access[bot] <109624739+shopify-github-actions-access[bot]@users.noreply.github.com>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants