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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hotfix docs recipes #1752

Merged
merged 4 commits into from
May 17, 2021
Merged

hotfix docs recipes #1752

merged 4 commits into from
May 17, 2021

Conversation

hasparus
Copy link
Member

@hasparus hasparus commented May 17, 2021

Closes #1750 and fixes docs currently broken on production.

I'll merge it after first PR approve.

cc @fcisio @flo-sch — btw guys, feel free to tell me if you don't want to be spammed like this :P

📦 Published PR as canary version: 0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0

✨ Test out this PR locally via:

npm install @theme-ui/color-modes@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/color@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/components@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/core@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/css@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/custom-properties@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/editor@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install gatsby-plugin-theme-ui@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install gatsby-theme-style-guide@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install gatsby-theme-ui-layout@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/match-media@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/mdx@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/parse-props@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-base@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-bootstrap@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-bulma@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-dark@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-deep@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-funk@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-future@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-polaris@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-roboto@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-sketchy@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-swiss@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-system@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-tailwind@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/preset-tosh@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/presets@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/prism@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/sidenav@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/style-guide@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/tachyons@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/tailwind@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/theme-provider@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install theme-ui@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
npm install @theme-ui/typography@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
# or 
yarn add @theme-ui/color-modes@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/color@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/components@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/core@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/css@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/custom-properties@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/editor@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add gatsby-plugin-theme-ui@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add gatsby-theme-style-guide@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add gatsby-theme-ui-layout@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/match-media@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/mdx@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/parse-props@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-base@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-bootstrap@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-bulma@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-dark@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-deep@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-funk@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-future@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-polaris@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-roboto@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-sketchy@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-swiss@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-system@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-tailwind@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/preset-tosh@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/presets@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/prism@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/sidenav@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/style-guide@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/tachyons@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/tailwind@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/theme-provider@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add theme-ui@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0
yarn add @theme-ui/typography@0.9.0--canary.1752.aff9846e487eafc4767705fb79024fdb554c9e36.0

@hasparus hasparus requested a review from lachlanjc May 17, 2021 08:50
@vercel
Copy link

vercel bot commented May 17, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/systemui/theme-ui/9NUinDN1cvkL9xs4tqQvUXp6cneM
✅ Preview: https://theme-ui-git-fix-docs-recipes-systemui.vercel.app

@hasparus hasparus added bug Something isn't working affects-docs Changes affect documentation, but not only documentation skip-release Preserve the current version when merged patch Increment the patch version when merged and removed skip-release Preserve the current version when merged labels May 17, 2021
@hasparus hasparus changed the base branch from stable to develop May 17, 2021 09:26
@hasparus hasparus requested a review from atanasster as a code owner May 17, 2021 09:26
@hasparus hasparus changed the base branch from develop to stable May 17, 2021 09:26
@hasparus hasparus added skip-release Preserve the current version when merged and removed patch Increment the patch version when merged labels May 17, 2021
Copy link
Collaborator

@flo-sch flo-sch left a comment

Choose a reason for hiding this comment

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

Minor comments, LGTM otherwise

@@ -35,10 +35,9 @@
"gatsby": "^2.26.1",
"gatsby-plugin-catch-links": "^2.4.0",
"gatsby-plugin-compile-es6-packages": "^2.1.0",
"gatsby-plugin-mdx": "^2.0.1",
"gatsby-plugin-mdx": "^1",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Quite a rollback, I have very little experience with Gatsby so cannot say if it looks good or bad, but just checking if that was intentional

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks mate! Good catch. I downgraded it to see if the bump to v2 was the cause of the problem, as I had problems with gatsby-plugin-mdx 2.5.x (similar to gatsbyjs/gatsby#31392, but on Linux not Windows). Turns out downgrading to 2.0.1 is enough.

@@ -0,0 +1,4 @@

Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps gitignore?

@@ -3,6 +3,7 @@
"scripts": {
"build": "preconstruct build",
"build:docs": "yarn build && yarn workspace docs build",
"dev:docs": "yarn workspace docs start",
Copy link
Collaborator

Choose a reason for hiding this comment

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

btw, did you manage to get HMR working inside the docs package itself?
AFAIR it didn't work for me last time after switching to preconstruct, even though I made sure to preconstruct dev
Like, other packages were successfully reloaded on change, but not docs package files

Copy link
Member Author

Choose a reason for hiding this comment

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

Wait, so HMR in the docs works for you on all code except of the the own code of the actual docs app?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, from within the docs last time I had HMR for instance on components, but not on docs pages

If I understand correctly it was because "docs" is excluded from preconstruct config (since it has its own build tool), but for some reason gatsby did not provide HMR 🤷‍♂️

(Unless I missed a step)

@hasparus hasparus merged commit 6d614d0 into stable May 17, 2021
@hasparus hasparus deleted the fix-docs-recipes branch May 17, 2021 20:17
@hasparus hasparus added the prerelease This change is available in a prerelease. label May 17, 2021
@hasparus
Copy link
Member Author

🚀 PR was released in v0.9.0 🚀

@hasparus hasparus added released This issue/pull request has been released. and removed prerelease This change is available in a prerelease. labels May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects-docs Changes affect documentation, but not only documentation bug Something isn't working released This issue/pull request has been released. skip-release Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants