Skip to content

Conversation

dpersing
Copy link

WHY are these changes introduced?

Currently we don't consistently check to see if documentation needs to change when we make updates to a component.

WHAT is this pull request doing?

Adds PR checklist items for:

  • Updating the component README.md (if necessary)
  • Tophatting that documentation change in the style guide (if it is visible there)

@BPScott BPScott temporarily deployed to polaris-react-pr-1362 April 25, 2019 18:54 Inactive
@BPScott BPScott temporarily deployed to polaris-react-pr-1362 April 25, 2019 18:55 Inactive
* [ ] Tested on [mobile](https://github.com/Shopify/polaris-react/blob/master/documentation/Tophatting.md#cross-browser-testing)
* [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/intro-to-shopify/shopify-admin/supported-browsers)
* [ ] Tested for [accessibility](https://github.com/Shopify/polaris-react/blob/master/documentation/Accessibility%20testing.md)
* [ ] Updated `README.md` with documentation changes
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this might be confusing since there's multiple README.md files in the repo, can you use language that's bit more specific like if you modified a component, then update that component's README file or something like that

Copy link
Author

Choose a reason for hiding this comment

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

Updated to specify the component-level README.md.

* [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/intro-to-shopify/shopify-admin/supported-browsers)
* [ ] Tested for [accessibility](https://github.com/Shopify/polaris-react/blob/master/documentation/Accessibility%20testing.md)
* [ ] Updated `README.md` with documentation changes
* [ ] Tophatted documentation changes in the style guide
Copy link
Contributor

Choose a reason for hiding this comment

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

This would be nice to include too but there's no easy way of doing this check right now. What if we told people to check in a MD previewer, do you think that's enough? We could also write a quick doc for how to tophat changes in the styleguide and link it here too

Copy link
Author

Choose a reason for hiding this comment

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

We could also write a quick doc for how to tophat changes in the styleguide and link it here too

Can do. I think testing the look in the style guide is important, since folks in lots of different roles need to do it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good, it should just be a matter of documenting the build-consumer command and telling people to set up polaris-styleguide as well 👍

Copy link
Author

Choose a reason for hiding this comment

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

Added a new doc, copying over some info from the Tophatting.md doc and adding instructions.

@dpersing dpersing changed the title Add checklist items for updating and tophatting documentation changes Add checklist and instructions updating and tophatting documentation changes Apr 25, 2019
Copy link
Contributor

@amrocha amrocha left a comment

Choose a reason for hiding this comment

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

Looks good to me, I'll let Selene review the content

Copy link
Contributor

@ry5n ry5n left a comment

Choose a reason for hiding this comment

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

This is fantastic. Thanks @dpersing!

I did notice one typo in the new tophatting doc (see below).

Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott requested a deployment to polaris-react-pr-1362 April 29, 2019 16:26 Abandoned
Co-Authored-By: dpersing <devon.persing@shopify.com>
@BPScott BPScott requested a deployment to polaris-react-pr-1362 April 29, 2019 16:26 Abandoned
@BPScott BPScott requested a deployment to polaris-react-pr-1362 April 29, 2019 16:28 Abandoned
@BPScott BPScott requested a deployment to polaris-react-pr-1362 April 29, 2019 16:29 Abandoned
@BPScott BPScott requested a deployment to polaris-react-pr-1362 April 29, 2019 16:33 Abandoned
@dpersing dpersing merged commit a3c06c9 into master Apr 29, 2019
@dpersing dpersing deleted the doc-check-for-checklist branch April 29, 2019 16:39
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