Skip to content
This repository has been archived by the owner on Jun 12, 2024. It is now read-only.

a catalog site #137

Merged
merged 122 commits into from
Jun 25, 2020
Merged

a catalog site #137

merged 122 commits into from
Jun 25, 2020

Conversation

katydecorah
Copy link
Contributor

@katydecorah katydecorah commented May 31, 2019

Borrowing from our very good friend mr-ui

image

To do:

  • TopbarSticker and PageLayout travel with the page, need to restrict the sticky to the example.

fixes #23

@katydecorah
Copy link
Contributor Author

katydecorah commented Jun 4, 2019

In testing the deploy script, the catalog site is now live at: https://mapbox.github.io/dr-ui/

After working with adding examples and testing out the components, there are a few things that I think should be fixed in separate PRs:

  • all images:
    • set a default size instead of making it required
    • compress SVG
    • make size value a number

@katydecorah katydecorah changed the title 🚧🔜a catalog site a catalog site Jun 4, 2019
@katydecorah katydecorah marked this pull request as ready for review June 4, 2019 12:46
Katy DeCorah added 11 commits June 4, 2019 08:49
* master:
  [search] add ability to filter results (#138)
  increase modal zindex to prevent collision with topbar sticker (#139)
* master:
  0.16.2
  Prepare 0.16.2
  0.16.1
  Prepare 0.16.1
  0.16.0
  Prepare 0.16.0
  [search] update search-ui, add loader, increase debounce length (#145)
  0.15.2
  Prepare 0.15.2
  🐛do not package optionalDependencies and jest (#143)
  add snapshot tests (#136)
  0.15.1
  Prepare 0.15.1
  0.15.0
  Prepare 0.15.0
  [search] adds segment tracking for queries and clicks (#140)
* master:
  Create create-redirect.js (#144)
  0.18.2
  [search] fix missing proptype (#151)
  0.18.1
  Update security vulnerabilities in dependencies (#152)
  0.18.0
  Feedback component (#135)
  0.17.0
  Prepare 0.17.0
  [version-sort] do not push pre-releases of the latest stable version (#148)
  🐛make compare-versions a dependency (#142)
  [PageLayout] add data attribute to prevent Swiftype from indexing sidebar content (#146)
* master:
  0.19.0
  Prepare 0.19.0
  [search] update to v1.0.0 of search-ui (#156)
@katydecorah
Copy link
Contributor Author

This is ready for review.

The current version is deployed at https://mapbox.github.io/dr-ui/

Overview of changes

  • New CONTRIBUTING.md. The catalog site adds a slightly new workflow that I'm attempting to document in the new CONTRIBUTING.md file.

    • ❓ I'd love your gut checks on this file if anything is missing or doesn't make sense. This workflow will make sure the catalog and test cases stay up to date and prevent duplicating code where possible.
    • ❓ Are two sites too much to manage? I'm hoping not. I think we can continue to do our development working using the test cases app and won't likely need to run the catalog site during dev work. I considered doing away with the test cases app, but there are quite a few one off cases that could overwhelm the catalog site.
  • New component script. This PR includes a generation script for creating new components. If you run node scripts/new.js crocs image it will automatically create all the files and starter code for the CrocsImage component. (Including creating a basic catalog example and importing it as a test case.).

  • New tests. There are a few more tests in this repo to help assert catalog data. Travis will also run npm run build-docs - this will help us catch build issues of all components. Fixes Improve testing by adding a batfish testing site in this repo #168

  • Ordered components in catalog by category. I thought it would be helpful to order all the components in the catalog by category (Features, Code, Layout, Images) to improve discoverability. The categories are controlled by docs/src/categories.json and asserted by tests.

    • ❓ What do you think of these categories? Would you change or move anything?

There should be no changes to the components themselves in this PR. In most cases I used a component's first (basic) test case as the catalog example. I did make some slight changes to a few examples and test cases to make them more palatable for the catalog.

@katydecorah katydecorah removed this from the v1 milestone Jun 14, 2020
@katydecorah katydecorah changed the base branch from master to main June 14, 2020 17:36
Copy link
Contributor

@danswick danswick left a comment

Choose a reason for hiding this comment

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

🎣 WOO this one's a keeper!

I built the catalog site, ran tests, and reviewed all of the code changes in here. Everything looks great to me. The new /examples organization is really sensible to me and helps make it more obvious what's going on in the test cases. The site looks good and is easy to navigate. The new.js functionality seems useful and the CI changes to require a successful build are a good idea!

Katy DeCorah added 4 commits June 25, 2020 08:56
* main:
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
* main:
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
@katydecorah katydecorah merged commit a5f161a into main Jun 25, 2020
@katydecorah katydecorah deleted the catalog branch June 25, 2020 13:04
katydecorah pushed a commit that referenced this pull request Jun 25, 2020
* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
katydecorah pushed a commit that referenced this pull request Jun 25, 2020
* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
katydecorah pushed a commit that referenced this pull request Jun 25, 2020
* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
katydecorah added a commit that referenced this pull request Jul 8, 2020
* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
katydecorah pushed a commit that referenced this pull request Jul 8, 2020
* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
katydecorah pushed a commit that referenced this pull request Jul 8, 2020
* main:
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
katydecorah pushed a commit that referenced this pull request Jul 8, 2020
* main:
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
katydecorah pushed a commit that referenced this pull request Jul 8, 2020
* main:
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
katydecorah pushed a commit that referenced this pull request Jul 8, 2020
* update sentry; set peerDependency

* Update CHANGELOG.md

* pin the peer dependency version

* add test to make sure peerDep matches dep

* Update react, react-dom, prop-types, react-test-renderer; Make react and react-dom peerDeps

* add mr-ui and mbx-assembly as peerDeps

* Update CHANGELOG.md

* Update peer-deps.test.js

* Merge branch 'main' into peer-deps

* main:
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad

* Merge branch 'main' into peer-deps

* main:
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad

* Update sentry

* Update package-lock.json
katydecorah pushed a commit that referenced this pull request Jul 10, 2020
* main: (27 commits)
  Add Changelog to catalog site
  0.29.2
  Prepare 0.29.2
  Update devDependencies, create jest-setup.js (#311)
  Set peerDependencies to keep frontend libraries in sync (#292)
  Remove unused highlight.js and util function (#305)
  Add aria-label to BackToTopButton (#290)
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)
  0.29.1
  Update CHANGELOG.md
  Remove `limiter` from Topbar (#282)
  0.29.0
  Prepare 0.29.0
  Allow Kotlin-only activities (#278)
  0.28.0
  ...
katydecorah pushed a commit that referenced this pull request Apr 22, 2021
…toplay (#276)

* show video controls on hover; show play button for browsers with disabled autoplay

* Merge branch 'main' into video-controls

* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)

* Add example

* More comments

* Reduce changes

* eslint and fix button styles

* Clean up button

* Set playsInline to true if autoPlay is true; make `muted` a prop

* Update test cases description to indicate the autoplay state

* Update description

* Update snapshots

* Update CHANGELOG.md

* Create `playsInline` prop

* Append hash to src to enable preview on iOS

* Update video.js

* Adds optional `poster` prop

* Remove hack

* Add poster example

* Fix paths

* Update descriptions

* Apply suggestions from code review
katydecorah pushed a commit that referenced this pull request May 11, 2021
* Prepare 4.0.0 changelog

* Make code toggles in test cases interactive or label if they are not (#432)

* Update dependencies (#433)

* Update dependencies

* Update package-lock.json

* Update rehype-slug

* Fix links

* Update page-layout.md

* Update snapshots

* Replace stateless components with pure components (#414)

* Use PureComponent on stateless components

* Update package-lock.json

* 4.0.0-alpha.0

* Use PureComponents where components do not require rerenders

* 4.0.0-alpha.1

* prefer-const

* Update CHANGELOG.md

* Make more components pure

* 4.0.0-alpha.2

* 4.0.0-alpha.3

* Improve color contrast on code and anchor elements (#434)

* Expand a code color contrast improvement

* Increase color contrast on .color-gray code

* Increase color contrast for prism's .token.regex,.token.important

* Clean up test cases

* Update CHANGELOG.md

* Clean up test cases

* Clean up test cases

* Update docs/src/pages/guides/a11y.md

Co-authored-by: Colleen McGinnis <colleen.mcginnis@mapbox.com>

* Reduce changes

Co-authored-by: Colleen McGinnis <colleen.mcginnis@mapbox.com>

* 🔧 Run prettier

* Add eslint-plugin-jsx-a11y (#435)

* Add eslint-plugin-jsx-a11y

* Fix props

* Update CHANGELOG.md

* Update search.test.js.snap

* Update eslint

* Update eslint

* Create `prepareSitemap` Batfish helper to improve sitemap (#427)

* Create prepareSitemap Batfish helper

* Update CHANGELOG.md

* Clean up, add `docsPath`, and `outputDirectory`

* Exclude `splitPage` from sitemap

* Assert sitemap

* Extract urls

* Sort sitemap

* Remove snapshot

* Update sitemap.test.js

* Update batfish-helpers.md

* Update batfish-helpers.md

* Copyedit

* Update package-lock.json

* Replace `id` with `aria-label` in VimeoPlayImage (#438)

* Replace `id` with aria-label to prevent duplicated id

* Update CHANGELOG.md

* Make `filename` optional for `CodeSnippetTitle`

* Make "With token" `DemoIframe` a no render test case (#440)

* Make "With token" `DemoIframe` a no render test case

* Rename

* Use passive event listeners on `Search`, `NumberedCodeSnippet`, and `OnThisPage` to improve performance (#437)

* Use passive event listeners on `Search`, `NumberedCodeSnippet`, and `OnThisPage` to improve performance.

* Update CHANGELOG.md

* Reconfigure `Video` options to optimize for user's settings around autoplay (#276)

* show video controls on hover; show play button for browsers with disabled autoplay

* Merge branch 'main' into video-controls

* main:
  Add the catalog site  (#137)
  Delete dependabot.yml
  Only direct dependencies
  Create dependabot.yml (#296)
  Update Travis bad
  Update devDependencies (#294)

* Add example

* More comments

* Reduce changes

* eslint and fix button styles

* Clean up button

* Set playsInline to true if autoPlay is true; make `muted` a prop

* Update test cases description to indicate the autoplay state

* Update description

* Update snapshots

* Update CHANGELOG.md

* Create `playsInline` prop

* Append hash to src to enable preview on iOS

* Update video.js

* Adds optional `poster` prop

* Remove hack

* Add poster example

* Fix paths

* Update descriptions

* Apply suggestions from code review

* Load Search with a facade (#430)

* Load Search with a facade

* Add @loadable/babel-plugin

* Update CHANGELOG.md

* Fix logic

* Update search.test.js.snap

* Define development babel env to prevent `@loadable/babel-plugin` from loading on start (because it fails)

* Adjusting snapshots

* Revert "Adjusting snapshots"

This reverts commit d2e7fd9.

* Clean up props

* Comments

* Reduce changes

* Reduce changes

* Reduce changes

* Reduce changes

* Clean up props

* Use SearchInput in SearchBox

* Use SearchButton in SearchBox

* Reduce changes

* Add missing props

* Consolidate wrapper

* 4.0.0-alpha.4

* Try dynamic import

* Update package-lock.json

* 4.0.0-alpha.5

* Update package-lock.json

* Reduce changes

* Reorganize files

* 4.0.0-alpha.6

* Switch to noRenderCase

* Reduce changes

* Add passive event listener

* Allow autofocus

* Enable react/jsx-no-bind (#442)

* jsx-no-bind

* Update CHANGELOG.md

* Simplify, reduce changes

* The `NumberedCodeSnippet` prop `onCopy` is deprecated and will automatically send a track event to Segment

* Remove unused onCopy

* Simplify

* Add onCopy

* Create onCopy function

* Update src/components/code-snippet/on-copy.js

* Update dependencies

* Update caniuse

* Update devDependencies

* Update CHANGELOG.md

* Fix NavigationAccordion tests (#443)

* 4.0.0-alpha.7

* Fix prepareSitemap: append index.html to files ending in index.js (#444)

* 4.0.0-alpha.8

* Update batfish

* Update caniuse-lite

* Fix props on search toggle (#448)

* Fix props on search toggle

* 4.0.0-alpha.9

* For searches with no results, retry if Swiftype thinks there is a spelling error (#451)

* pass through swiftype API spelling option

* move prettier'd comment

* Update search-ui, downshift

* Update caniuse-lite

* Update @sentry/browser

* Send search results with no queries to Sentry (#452)

* Send search results with no queries to Sentry

* Update CHANGELOG.md

* Update prettier

* Fix Sentry test

* 4.0.0-alpha.10

* Switch Sentry environment back to `main`

* Fix Search/Sentry, only send when results change

* 4.0.0

* Clean up

Co-authored-by: Colleen McGinnis <colleen.mcginnis@mapbox.com>
Co-authored-by: Dan Swick <dan.swick@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs build process maybe
2 participants