Commit Graph

87 Commits

Author SHA1 Message Date
Devon Persing
0bad84d5fe Removed section about running pa11y during CI (#1449)
* Removed section about running pa11y during CI

* Add documentation entry
2019-05-09 08:59:19 -10:00
Kaelig Deloumeau-Prigent
6579045fbb [Tophatting documentation] Formatting fixes 2019-04-29 15:23:52 -07:00
Devon Persing
a3c06c99f0 Add checklist and instructions updating and tophatting documentation changes (#1362)
* Add checklist items for updating and tophatting documentation changes
* Add entry to UNRELEASED.md
2019-04-29 06:39:01 -10:00
Tim Layton
97f66452f4 document the Skip Changelog label 2019-02-21 12:21:57 -08:00
Kaelig Deloumeau-Prigent
1f46b9a759 [Documentation] Add link to console message guidelines in deprecation guidelines (#1076)
Deprecation guidelines mention that contributors should add a console warning for deprecated tags.

This PR adds a link to guidelines that will help the contributor write a good console message.
2019-02-20 17:32:26 -08:00
Koen Vendrik
81d1d04a3f Adds example to deprecation guidelines (#878)
* Update Deprecation guidelines.md

* fixes formatting

* adds upgrade path requirement to deprecation docs
2019-01-21 11:04:04 -05:00
Tim Layton
0a75c3c51b add deprecation category and changelog entry 2019-01-11 12:54:12 -08:00
Tim Layton
7338acb563 add deprecation guidelines 2019-01-11 12:53:09 -08:00
Ben Scott
083230365f Replace playground with Storybook
Ran with the same command (`yarn dev`) this contains all the
functionality you know and love - hot reloading, a playground, percy
snapshots just with a different veneer
2019-01-08 13:02:07 -08:00
Chloe Rice
2408cecf8d upgraded polaris-tokens for a11y hex change to dark yellow 2019-01-07 17:36:03 -08:00
Owain Williams
0855730ee4 Update browser tophatting guide 2018-12-18 13:47:20 -05:00
Tim Layton
54bdd86116 Merge pull request #766 from Shopify/housekeeping-changes
Add "code quality" grouping to changelog docs
2018-12-17 14:27:45 -08:00
Kaelig Deloumeau-Prigent
a5e6e3b386 [Documentation] Add syntax highlighting to console logging guidelines (#764)
@tmlayton as mentioned earlier, this is where we have _some_ docs around deprecation.

This PR just makes it look nicer.
2018-12-17 10:37:18 -08:00
Tim Layton
4d293ad3c2 add code quality group for changelog 2018-12-14 15:47:53 -08:00
Kaelig Deloumeau-Prigent
176af46388 Fix straight quotes into apostrophes (#683) 2018-11-28 15:20:50 -08:00
Ben Scott
a1a8aaa7d4 Unify Tophat and Playground servers
Tophatting is now done through the playground server instead of being a
separate thing. Examples are now hot reloadable - modifications to
README files and components will be reflected in your browser without
needing to save due to markdown files being imported via webpack loader.

This makes the examples part of the build pipeline instead of something
that gets serialised into the page. This makes individual pages smaller
at the expense of a larger bundle (which is shared amongst pages).
2018-11-22 18:51:35 -08:00
Ben Scott
a89de5b3b5 Provide better error messaging when README examples have syntax errors
This shall identify the file and example that the problem occurs in.
2018-11-19 17:48:26 -08:00
Tim Layton
5db82accd0 update app-bridge doc links 2018-10-26 11:47:38 -07:00
Ben Scott
ef63e17a72 Update other references to the polaris repo 2018-10-25 14:18:40 -07:00
Devon Persing
0e9521bbc3 [a11y] Improved testing checklist (#469)
* Updated based on feedback from last week

- Added more detail to items about keyboard accessibility and focus.
- Added CTA for requesting help on Slack or GitHub, for internal use.
- Clarified resizing/reflowing.
- Added exemptions for color contrast.
- Clarified text resizing.
- Added more detail to images.
- Introduced the notion of accessibility guidelines in the style guide.
- Clarified the definition of "accessible".
- Moved 3.2.2 and 4.1.2 related items to the Dynamic content section.
- Renamed mobile-related sections.

* Updated language and navigation

- Added language around impairments
- Firmed up verbs
- Added links to test checklist sections
- Added note on SVG best practice
- Removed reference to internal-only resources.

* Fixed a formatting typo

* Added a11y doc update
2018-10-25 12:53:34 -07:00
Tim Layton
0d33f0e678 minor edits to docs 2018-10-23 12:29:55 -07:00
Tim Layton
626c6f29d4 fix bad rebase of a11y doc 2018-10-21 14:57:54 -07:00
Tim Layton
dfdefc0b37 Merge branch 'open-development' into beta-and-open-dev 2018-10-21 13:17:54 -07:00
Tim Layton
69912ed0a9 Merge branch 'master' into merge-master-10-21 2018-10-21 12:59:13 -07:00
Dan Rosenthal
58549a607a Merge branch 'master' of github.com:Shopify/polaris-react into master-into-src-build-beta-for-rc 2018-10-19 15:16:14 -04:00
Tim Layton
828898e596 Shopify App Bridge 🌉🎉 (#2450)
* add appBridge to polaris context

* implement app bridge for loading and update tests

* add tests

* use appBridge in toast

* update tests

* update prop with default value, set to dismissable, and unmount safely

* render page components with app bridge

* add callback support, move to private methods

* add lifecycle handlers

* bump app-bridge version and update isDismissible option

* generate redirect callbacks based on url

* add target type to actions, remove logic to infer target

* add tests

* dev up

* [Modal] App Bridge (#2320)

* stop exporting embedded modal and export normal modal with modal props instead

* get a working app bridge modal

* better type for size and pull title

* get all props working, needs refactor with page

* easdk action is already part of the complex action type

* move modal app bridge transforms into shared utility

* refactor page to use shared transformers

* rebase off beta/app-bridge, respond to feedback, and fix modal typing

* add tests

* refactor transforms

* add transformer tests, refactor transformer to use overload, and subsequent refactors of page and modal and their tests

* add test for modal not opening on mount

* respond to feedback

* [Resource picker] App bridge (#2443)

* upgrade resource picker to use app bridge

* refactor toast and loading based on app bridge version bump

* change close callback to cancel callback, fix subscribed select action

* tweak docs

* set defaults to keep them in sync with our docs, add  showVariants

* add tests

* fix tests

* not true is also known as false

* cast action as Action.ADMIN_PATH to avoid casting as any

* use enum instead of string for argument to subscribe

* The EASDK is dead, long live the Shopify App Bridge

* fix tests

* replace type cast with overload function

* safe guard against calls to set unless something has changed

* add tests for safe guards to set

* support the danger button

* document all the changes

* ignore tophat examples if hidePlayground is true

* burn handle warning from Modal

* use default toast duration in tests

* stop typing as any in overloaded transformer function

* add note about shopOrigin to not have https://

* update history example

* dynamically generate types for target and modal size

* update prop docs for shopOrigin

* no no no
2018-10-19 11:22:02 -07:00
Koen Vendrik
13f769e262 adds testing documentation (#2397)
* add testing docs

* Update Testing.md

* Update Testing.md
2018-10-12 10:50:54 -04:00
Tim Layton
9aebff99cd Merge branch 'master' into open-dev-merge-master 2018-10-06 00:10:16 -07:00
Andrew Musgrave
5b8ce1e06a Merge branch 'master' into master-to-beta-2110 2018-10-03 13:30:46 -04:00
Kaelig Deloumeau-Prigent
9b0cfbef5d styleguide -> style guide (#2270) 2018-09-19 09:33:13 -07:00
Dan Rosenthal
de58a8eed5 Merge branch 'master' of github.com:Shopify/polaris-react into master-into-src-build-beta-7 2018-09-19 09:26:28 -04:00
Devon Persing
fe6ce90220 Spelling and typos
Words are hard.
2018-09-14 15:55:59 -07:00
Devon Persing
0ce00c8916 Typos and bullets
Fixing typos, tweaking language to be more consistent, and nesting
2018-09-14 10:54:35 -07:00
Devon Persing
43fa1c416b Cross-linked docs and added PR template
Absolute URLs, unfortunately
2018-09-14 10:26:17 -07:00
Devon Persing
1486dd3010 Link fixes
Fixing links. (Fingers crossed)
2018-09-14 10:14:52 -07:00
Devon Persing
31069530fb Added accessibility intro guide
Added the guide modified for the public repo, and altered it slightly to link to the test checklist.

Added a link to the checklist to link to the intro doc.
2018-09-14 09:47:53 -07:00
Devon Persing
beb5bed3f8 Punctuation and vocab
Updating punctuation (Oxford commas, curly quotes), adding assistive technology specifics, and clarifying vocabulary.
2018-09-13 16:35:12 -07:00
Devon Persing
081d1a5039 Accessibility checklist
This document adds a manual accessibility checklist for submitting pull requests to polaris-react, and more broadly talks about accessibility testing that should be done when contributing.
2018-09-13 14:58:43 -07:00
Kaelig Deloumeau-Prigent
9f05dcdce0 Document component README formating guidelines (#2210) 2018-09-11 10:46:09 -07:00
Dan Rosenthal
9915560ca0 Merge branch 'master' of github.com:Shopify/polaris-react into master-into-src-build-beta-6 2018-09-10 11:23:53 -04:00
Tim Layton
7419083ffd Merge branch 'master' into open-development-merge-master 2018-09-09 17:43:23 -07:00
Solona Armstrong
3939a2d2bb Change component names to PascalCase and update changelog guidelines 2018-08-31 14:53:55 -07:00
Dan Rosenthal
537e59956e Merge branch 'master' of github.com:Shopify/polaris-react into master-into-src-build-beta 2018-08-27 12:12:27 -04:00
Kaelig Deloumeau-Prigent
6df6116b82 Dump upcoming changes in UNRELEASED.md instead of CHANGELOG.md (#1693) 2018-08-24 11:36:49 -07:00
Solona Armstrong
a0bd152445 Add changelog guidelines 2018-08-23 05:40:40 -07:00
Dominic McPhee
834b73fcc7 Revert "Merge branch 'src-build-beta' into master"
This reverts commit ec32046933, reversing
changes made to d084463b98.
2018-08-17 10:11:30 -04:00
Solona Armstrong
6cf4b76834 Add EASDK handling to Toast 2018-08-07 14:11:22 -04:00
Tim Layton
a07064c21e update links from Shopify/polaris to Shopify/polaris-react 2018-07-21 13:09:13 -07:00
Tim Layton
1ddea0e9cb Merge pull request #1769 from Shopify/master
Merge master into open-development
2018-07-15 11:07:01 -07:00
Tim Layton
f61f4b6516 add changelog entry and change group to chnagelog docs 2018-07-13 15:34:19 -07:00