[polaris.shopify.com] Add components lifecycle #8045
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarahill
requested review from
aveline,
dominikwilkowski,
jjgali,
kyledurand and
raquelbreternitz
Contributor
Author
|
One weird thing is the section titles. I had wanted them to be the same for each section: "Requirements" and "What to expect" but there's a bug with the TOC that causes weird selected state issues when there are duplicate section titles. That's why they're longish and repetitive. Open to suggestions. cc: @jjgali if you have any thoughts
|
Contributor
Author
|
The page lives under "Polaris 101" right now. I was debating between "Polaris 101" and "Contributing". I landed on 101 because the content also applies to how our team works and feels necessary to understand when using components in general. That being said I'm happy to move it if others have strong opinions that it should live elsewhere.
|
tracytees
approved these changes
Jan 26, 2023
Contributor
selenehinkley
left a comment
selenehinkley
left a comment
There was a problem hiding this comment.
Did a light copy edit. Didn't focus on the structure or accuracy of the content. Overall, use oxford commas and don't punctuate lists if they're all single sentences. If a list item has more than one sentence, then the entire list "chunk" is punctuated :)
polaris.shopify.com/content/getting-started/components-lifecycle.md
Outdated
Show resolved
Hide resolved
polaris.shopify.com/content/getting-started/components-lifecycle.md
Outdated
Show resolved
Hide resolved
polaris.shopify.com/content/getting-started/components-lifecycle.md
Outdated
Show resolved
Hide resolved
polaris.shopify.com/content/getting-started/components-lifecycle.md
Outdated
Show resolved
Hide resolved
polaris.shopify.com/content/getting-started/components-lifecycle.md
Outdated
Show resolved
Hide resolved
Contributor
|
@sarahill This looks great! Re: the bug with section titles, it's incredibly annoying, but I think you've got a good work around here. The other option would be to have shorter, repeatable titles, and ignore the bug until there's a fix (that's my current plan of action for a different page I'm working on). I'm not sure what the timeline on fixing that bug is (seems like it might be a little complex), so I'll defer to your best judgement. I don't think these titles are too long winded if you decide to keep them. Re: living in the Polaris 101 section, I think that makes sense for now. I'd almost expect this to live within the Components section, but I don't think we have the page structure to support that right now. |
jjgali
approved these changes
Jan 26, 2023
…le.md Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
…le.md Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
…le.md Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
…le.md Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
…le.md Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
Merged
yurm04
pushed a commit
that referenced
this pull request
Jan 26, 2023
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-icons@6.10.0 ### Minor Changes - [#8150](#8150) [`a0c6e467b`](a0c6e46) Thanks [@leileu](https://github.com/leileu)! - Adding two metaobject icons: Metaobject and Metaobject Reference. ### Patch Changes - [#8148](#8148) [`0ca0b7899`](0ca0b78) Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Updated clipboard icon ## @shopify/polaris@10.24.0 ### Minor Changes - [#8083](#8083) [`18991daf1`](18991da) Thanks [@krithikajanakiraman](https://github.com/krithikajanakiraman)! - Adding an oprtional headerContent prop to ResourceList - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` to use primitive Layout components Removed `max-width` on children in `AlphaStack` Added `narrowWidth` and `fullWidth` examples to `AlphaStack` stories ### Patch Changes - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Updated `SkeletonPage` title and body layout - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` title layout - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed `ResourceList` header alignment - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ResourceItem` with layout components - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed IndexTable checkbox alignment - [#8099](#8099) [`a3605c855`](a3605c8) Thanks [@AndrewMusgrave](https://github.com/AndrewMusgrave)! - Fixed `BulkActions` causing `IndexTable` & `ResourceList` to ignore pointer events - Updated dependencies \[[`a0c6e467b`](a0c6e46), [`0ca0b7899`](0ca0b78)]: - @shopify/polaris-icons@6.10.0 ## @shopify/plugin-polaris@0.0.31 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.11.2 ## @shopify/polaris-migrator@0.11.2 ### Patch Changes - Updated dependencies \[[`07669075a`](0766907), [`74a75a473`](74a75a4), [`f8f9eecd5`](f8f9eec)]: - @shopify/stylelint-polaris@5.1.2 ## @shopify/stylelint-polaris@5.1.2 ### Patch Changes - [#8167](#8167) [`07669075a`](0766907) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Temporarily disable layout category - [#8162](#8162) [`74a75a473`](74a75a4) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Allow SCSS namespaces with Polaris breakpoints - [#8168](#8168) [`f8f9eecd5`](f8f9eec) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Ignored needless disables for layout category and added meta URL to error message ## polaris.shopify.com@0.30.1 ### Patch Changes - [#8123](#8123) [`3bb6c03d3`](3bb6c03) Thanks [@marlowpayne](https://github.com/marlowpayne)! - Improve readability of markdown tables by wrapping on words - [#8045](#8045) [`b3ee45c47`](b3ee45c) Thanks [@sarahill](https://github.com/sarahill)! - Added component lifecycle page to polaris.shopify.com - [#7821](#7821) [`a0941743a`](a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - Updated dependencies \[[`a0941743a`](a094174), [`18991daf1`](18991da), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0941743a`](a094174), [`a0c6e467b`](a0c6e46), [`a3605c855`](a3605c8), [`0ca0b7899`](0ca0b78)]: - @shopify/polaris@10.24.0 - @shopify/polaris-icons@6.10.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Merged
juzser
pushed a commit
to juzser/polaris
that referenced
this pull request
Jul 27, 2023
### WHY are these changes introduced? We have component statuses within individual component pages but no place where we document what each status means. ### What is this PR doing? This PR adds a component lifecycle page with definitions, requirements, and expectations for each stage. [Google doc content](https://docs.google.com/document/d/1v_dlfosdBxMYlfnJ1HOff5lS8Rj4VVXkib1W3-99daU/edit#) Co-authored-by: Selene Hinkley <selene.hinkley@shopify.com>
juzser
pushed a commit
to juzser/polaris
that referenced
this pull request
Jul 27, 2023
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-icons@6.10.0 ### Minor Changes - [Shopify#8150](Shopify#8150) [`a0c6e467b`](Shopify@a0c6e46) Thanks [@leileu](https://github.com/leileu)! - Adding two metaobject icons: Metaobject and Metaobject Reference. ### Patch Changes - [Shopify#8148](Shopify#8148) [`0ca0b7899`](Shopify@0ca0b78) Thanks [@zecarlostorre](https://github.com/zecarlostorre)! - Updated clipboard icon ## @shopify/polaris@10.24.0 ### Minor Changes - [Shopify#8083](Shopify#8083) [`18991daf1`](Shopify@18991da) Thanks [@krithikajanakiraman](https://github.com/krithikajanakiraman)! - Adding an oprtional headerContent prop to ResourceList - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` to use primitive Layout components Removed `max-width` on children in `AlphaStack` Added `narrowWidth` and `fullWidth` examples to `AlphaStack` stories ### Patch Changes - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Updated `SkeletonPage` title and body layout - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Refactored `SkeletonPage` title layout - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed `ResourceList` header alignment - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ResourceItem` with layout components - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Fixed IndexTable checkbox alignment - [Shopify#8099](Shopify#8099) [`a3605c855`](Shopify@a3605c8) Thanks [@AndrewMusgrave](https://github.com/AndrewMusgrave)! - Fixed `BulkActions` causing `IndexTable` & `ResourceList` to ignore pointer events - Updated dependencies \[[`a0c6e467b`](Shopify@a0c6e46), [`0ca0b7899`](Shopify@0ca0b78)]: - @shopify/polaris-icons@6.10.0 ## @shopify/plugin-polaris@0.0.31 ### Patch Changes - Updated dependencies \[]: - @shopify/polaris-migrator@0.11.2 ## @shopify/polaris-migrator@0.11.2 ### Patch Changes - Updated dependencies \[[`07669075a`](Shopify@0766907), [`74a75a473`](Shopify@74a75a4), [`f8f9eecd5`](Shopify@f8f9eec)]: - @shopify/stylelint-polaris@5.1.2 ## @shopify/stylelint-polaris@5.1.2 ### Patch Changes - [Shopify#8167](Shopify#8167) [`07669075a`](Shopify@0766907) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Temporarily disable layout category - [Shopify#8162](Shopify#8162) [`74a75a473`](Shopify@74a75a4) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Allow SCSS namespaces with Polaris breakpoints - [Shopify#8168](Shopify#8168) [`f8f9eecd5`](Shopify@f8f9eec) Thanks [@aaronccasanova](https://github.com/aaronccasanova)! - Ignored needless disables for layout category and added meta URL to error message ## polaris.shopify.com@0.30.1 ### Patch Changes - [Shopify#8123](Shopify#8123) [`3bb6c03d3`](Shopify@3bb6c03) Thanks [@marlowpayne](https://github.com/marlowpayne)! - Improve readability of markdown tables by wrapping on words - [Shopify#8045](Shopify#8045) [`b3ee45c47`](Shopify@b3ee45c) Thanks [@sarahill](https://github.com/sarahill)! - Added component lifecycle page to polaris.shopify.com - [Shopify#7821](Shopify#7821) [`a0941743a`](Shopify@a094174) Thanks [@laurkim](https://github.com/laurkim)! - Rebuilt `ActionList` to use layout primitives - Updated dependencies \[[`a0941743a`](Shopify@a094174), [`18991daf1`](Shopify@18991da), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0941743a`](Shopify@a094174), [`a0c6e467b`](Shopify@a0c6e46), [`a3605c855`](Shopify@a3605c8), [`0ca0b7899`](Shopify@0ca0b78)]: - @shopify/polaris@10.24.0 - @shopify/polaris-icons@6.10.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
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
We have component statuses within individual component pages but no place where we document what each status means.
What is this PR doing?
This PR adds a component lifecycle page with definitions, requirements, and expectations for each stage.
Google doc content