Chakra-ui: 1.0 Release Checklist

Created on 21 Jul 2020 · 25Comments · Source: chakra-ui/chakra-ui

I wanted to collect all last-minute tasks we need to accomplish when we publish 1.0. Mostly these changes relate to @chakra-ui/core@latest pointing to 1.0 and https://chakra-ui.com being updated to point to the v1 docs. We'll need to update various parts of our docs/pipeline to make sure this happens.

[x] Add Vercel v0.chakra-ui.com alias to existing deployment for chakra-ui.com
[x] Update alias in vercel.json to https://chakra-ui.com/
[x] Replace https://chakra-ui.com/ with https://v0.chakra-ui.com/ throughout the project
[x] Replace https://next.chakra-ui.com/ with https://chakra-ui.com/ throughout the project
[x] Add link to/note about outdated v0 docs somewhere in the v1 docs (?)
[x] Replace 1.0.0-next.#-specific versioning with base package names throughout the project (@chakra-ui/core instead of @chakra-ui/core@next)
[ ] Update EDIT_URL to point to master in next.config.js
[x] Update version/publish scripts to no longer use rc

Topic not stale

Source

with-heart

🎉20 🚀9

Most helpful comment

Any updates on the 1.0 release date? Been using 0.8 and there are handful of little bugs throughout the core library. I've searched through issues and they've been closed because they are fixed in 1.0 (which is great!) but I'm unsure if it's stable enough to use yet?

FWIW, I'd be personally more interested in a smaller 0.9 that didn't seek to completely nail the API (I'm fine with breaking changes over time if they are for the better) but fixed a lot of the little annoyances, than to bundle it up into a much larger 1.0 that may take a long time to ship.

ianstormtaylor on 8 Nov 2020

👍14

All 25 comments

I'd suggest we leave the docs as is, and make v1.chakra-ui.com till it's very stable.

segunadebayo on 22 Jul 2020

👍6 😕1

@segunadebayo I'm going back and forth on that. It makes sense to not confuse users on <=0.8 but I think it might cause problems for new users post-1.0 launch who may not catch that the main site doesn't have the docs they need. An example of this is #1391.

with-heart on 25 Jul 2020

👍5

Is the 1.0 release date public anywhere?

fr3fou on 30 Jul 2020

@fr3fou There is no date. We had been in our alpha next versions but have now moved to release candidates (rc.0 currently) since things are now mostly stable. Barring any unforseen circumstances, the api in rc.0 is the one that will exist in 1.0 though.

There are still a number of things to complete before we feel comfortable fully releasing 1.0 but we're getting there.

with-heart on 30 Jul 2020

So is it safe for me to use next without any issues?

fr3fou on 30 Jul 2020

👍1

Depends on how you define "safe" and "without any issues" 😆

It's in a fairly stable place but it isn't entirely bug-free yet, which is why it's not 1.0.0 yet. You should be able to use it without problems, but I can't promise you won't run into anything.

with-heart on 31 Jul 2020

👀1

I'd suggest we leave the docs as is, and make v1.chakra-ui.com till it's very stable.

How about redirecting https://v1.chakra-ui.com/ to https://next.chakra-ui.com/? It's currently broken.

maxwaiyaki on 3 Aug 2020

👍2

Couldn't find this anywhere but just curious, what's the reason of moving the docs from Gatsby to Next?

chhuang on 6 Aug 2020

👀6

what's the reason of moving the docs from Gatsby to Next

@chhuang I don't know the answer for sure but I believe Next.js is more flexible, especially if you want to server-render dynamic content (Gatsby basically generates a static site), and maybe if you want to show off advanced/dynamic features of chakra-ui and you want it SSR then next.js will be better. Lots of comparison articles on google.

vonwao on 21 Aug 2020

How about redirecting https://v1.chakra-ui.com/ to https://next.chakra-ui.com/? It's currently broken.

How about putting a link on the main chakra docs site (or at least in the github radme) to the correct URL. Right now it's difficult to find! (We can always put a disclaimer that it's not stable yet)

vonwao on 21 Aug 2020

👍1

@vonwao It won't matter much longer but putting it in the README for the time being is a good idea. I'll do that

with-heart on 23 Aug 2020

what's the reason of moving the docs from Gatsby to Next

@chhuang I don't know the answer for sure but I believe Next.js is more flexible, especially if you want to server-render dynamic content (Gatsby basically generates a static site), and maybe if you want to show off advanced/dynamic features of chakra-ui and you want it SSR then next.js will be better. Lots of comparison articles on google.

I understand the difference between the two, I was just curious and wanted to understand better the reasoning behind the switch.

chhuang on 31 Aug 2020

👍1

I really like the new docs site. It's too bad it's not a framework itself.

Also, is there any information on the upgrade steps to 1.0? Maybe I just missed it, but I'm having a hard time doing that.