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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Page][Page actions][Pagination] Add cross references for page-related components #1103

Merged
merged 8 commits into from Feb 27, 2019

Conversation

@sadiesaurus
Copy link
Contributor

commented Feb 27, 2019

WHY are these changes introduced?

Resolves Shopify/polaris-react-deprecated#602

Add cross references to the "Related components" section for the following components:

  • Page
  • Page actions
  • Pagination

Page
alt

Page actions component
alt

Pagination component
alt

I'm not 馃挴 on the context on use-case for each of these components, so please let me know if the content needs adjustment.

Also, does a minor addition like this warrant a changelog entry?

@probot-shopify

This comment has been minimized.

Copy link

commented Feb 27, 2019

馃憢 Thanks for opening your first pull request. A contributor should give feedback soon. If you haven鈥檛 already, please check out the contributing guidelines. You can also join #polaris on the Shopify Partners Slack.

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

- To lay out the content within a page, use the [layout component](/components/structure/layout)
- To add pagination to a page, see the [pagination component](/components/navigation/pagination)
- To add primary and secondary calls to action at the bottom of a page, see the [page actions component](/components/structure/page-actions)
- When you use the page component within an [embedded app](https://github.com/Shopify/polaris-react/blob/master/documentation/Embedded%20apps.md), rendering is delegated to the Shopify App Bridge

This comment has been minimized.

Copy link
@alex-page

alex-page Feb 27, 2019

Member

Sometimes we do Page to indicate that is referencing a react component, I think your change to page is fine in this context.

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

@chloerice
Copy link
Member

left a comment

Thanks for improving component cross references! Left a few suggestions 馃槉

src/components/Page/README.md Outdated Show resolved Hide resolved
src/components/Page/README.md Outdated Show resolved Hide resolved
src/components/PageActions/README.md Outdated Show resolved Hide resolved
src/components/PageActions/README.md Outdated Show resolved Hide resolved
- To create stand-alone navigational links or calls to action, [use the button component](/components/actions/button)
- To embed actions or pathways to more information within a sentence, [use the link component](/components/navigation/link)
- To create stand-alone navigational links or calls to action, use the [button component](/components/actions/button)
- To embed actions or pathways to more information within a sentence, use the [link component](/components/navigation/link)

This comment has been minimized.

Copy link
@chloerice

chloerice Feb 27, 2019

Member

鉂わ笍

Update src/components/Page/README.md
Co-Authored-By: sadiesaurus <sadie.redden@shopify.com>

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

Update src/components/Page/README.md
Co-Authored-By: sadiesaurus <sadie.redden@shopify.com>

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

Update src/components/PageActions/README.md
Co-Authored-By: sadiesaurus <sadie.redden@shopify.com>

@BPScott BPScott temporarily deployed to polaris-react-pr-1103 Feb 27, 2019 Inactive

Update src/components/PageActions/README.md
Co-Authored-By: sadiesaurus <sadie.redden@shopify.com>

@sadiesaurus sadiesaurus merged commit c454f3c into master Feb 27, 2019

8 checks passed

CLA Contributor License Agreement (CLA) status
Details
WIP ready for review
Details
changelog changelog entry included
Details
ci/circleci: check Your tests passed on CircleCI!
Details
ci/circleci: percy Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing e19f868...0a43540
Details
percy/polaris-react Visual review automatically approved, no visual changes found.
Details
shrink-ray Webpack build report complete :)
Details
@probot-shopify

This comment has been minimized.

Copy link

commented Feb 27, 2019

馃帀 Thanks for your contribution to Polaris React!

@sadiesaurus sadiesaurus deleted the page-things branch Feb 27, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can鈥檛 perform that action at this time.