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
Document 14.0.0 migration guide #5563
Conversation
e9d50f6
to
81dfe56
Compare
@hudochenkov Thanks for the suggestions. I've made those changes. |
I simplified the error messaging. However, feel free to push to this pull request this week if anyone has ideas for improvements. (Linting is failing on a missing Markdown link references, which can be ignored for now.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps, I think it may be better to create a migration document like docs/migration-guide/v13-to-v14.md
, instead of updating CHANGELOG.md
. 🤔
(CHANGELOG.md
has frequently changed and will be bigger)
What do you think?
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
It's a good suggestion. I'll pull the migration guide out when I'm back next week. |
I've pulled the content into a new migration guide section. I've also pulled out all the shared-config stuff until it's ready so that we can merge this and I can work on #5564. We can add the shared-config stuff back (in follow-up pull request) when it lands. This pull request is mainly about Pull request is ready for review. |
Co-authored-by: Aleks Hudochenkov <aleks@hudochenkov.com>
Co-authored-by: Aleks Hudochenkov <aleks@hudochenkov.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jeddy3 Thank you for extracting the v14 migration guide as another file!
I've left some trivial suggestions and questions.
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
@ybiquitous Thanks for the suggestions. I'm always impressed by your keen eyes! @hudochenkov I've added a couple of commits for your suggestions. I've also added to the discussion as the syntaxes that extract styles seem more compatible with PostCSS@8 than I originally thought. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fantastic work, @jeddy3!
Closes #5301
I figured I'd get the ball rolling on this to elicit feedback. We won't be able to merge this until the dust settles on custom syntaxes and shared configs, and we know what we can point to at release time.
The pull request touches quite a few markdown files. This was necessary to pull all the bits together.
Highlights of changes:
options.md
is the canonical place for details, withconfigure.md
linking to it (like we already do withcli.md
)configure.md
to make more sense (and emphasise thecustomSyntax
andoverrides
properties)syntax
optionThat last one is quick and dirty to check that this is the kind of thing we had in mind?