Styled-components-website: Add upgrading guides

Created on 18 Dec 2017  路  17Comments  路  Source: styled-components/styled-components-website

Looking at our traffic stats, a search for "Upgrading" is our 5th most visited page on the main repo:

screen shot 2017-12-18 at 21 54 49

We should add an upgrading guide for v1 -> v2 to the website, which would contain this information: https://github.com/styled-components/styled-components/releases/tag/v2.0.0 (it's kinda funny because the _actual_ upgrade is a simple npm install)

We should also make sure that we can add more upgrading guides in the future, i.e. that it's extensible. (v2 -> v3, v3 -> v4, etc) Maybe we should just post our releases on the website? Is it possible to do that automatically based on the Releases page on GitHub? That'd be awesome for sure...

enhancement good first issue help wanted

Most helpful comment

screen shot 2017-12-20 at 11 58 07

Better ? :)

All 17 comments

Maybe adding the : https://github.com/styled-components/styled-components/blob/d2d6be5feafdc116a3429e6b6f71f7718c51a8ba/CHANGELOG.md with some text on the top that tells users how to upgrade ?

Using the API show a list of https://github.com/styled-components/styled-components/releases is also possible : https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository

That second one sounds perfect, since we usually have more "human-readable" patch notes in the GitHub releases.

Makes sense :)

Should this be a new page in the header ?

Don't really know, the header's getting pretty full. Maybe /docs/releases? :confused:

Looking like this ?

screen shot 2017-12-20 at 11 51 09

I guess, though that's kinda weird. Maybe we should just get rid of the "Homepage" link (since the logo links there anyway) and add a "Releases" link at the end after "Ecosystem", that's probably better?

screen shot 2017-12-20 at 11 58 07

Better ? :)

@SaraVieira Perfect :heart:

Awesome ! I will try to get started on this after work today 馃

If I don't anyone is welcome to pick up this , it already has a good documentation

This is what I have so far

screen shot 2017-12-22 at 22 19 01

@SaraVieira looking good :) only thing is that who released it is irrelevant to the reader. The version number and date however are vital 馃槵

Yeah I'd probably even totally remove the person and make the version number the heading?

I know that makes sense but i am sucker for photos 馃槢

New version:
screen shot 2017-12-23 at 21 26 35

They all have the same text because I am having a problem with the md component :(

Fixed

closed by #198

Was this page helpful?
0 / 5 - 0 ratings

Related issues

el1f picture el1f  路  4Comments

pronevich picture pronevich  路  3Comments

niraj8 picture niraj8  路  5Comments

mxstbr picture mxstbr  路  4Comments

mxstbr picture mxstbr  路  5Comments