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

Document 14.0.0 migration guide #5563

Merged
merged 28 commits into from Oct 10, 2021
Merged

Document 14.0.0 migration guide #5563

merged 28 commits into from Oct 10, 2021

Conversation

jeddy3
Copy link
Member

@jeddy3 jeddy3 commented Sep 26, 2021

Which issue, if any, is this issue related to?

Closes #5301

Is there anything in the PR that needs further explanation?

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:

  • added migrating details in the changelog
  • revamped the getting started guide to match this
  • options.md is the canonical place for details, with configure.md linking to it (like we already do with cli.md)
  • reordered the properties inconfigure.md to make more sense (and emphasise the customSyntax and overrides properties)
  • added an early draft of more helpful messages when:
    • using the syntax option
    • attempting to lint a non-CSS file without specifying a custom syntax

That last one is quick and dirty to check that this is the kind of thing we had in mind?

README.md Outdated Show resolved Hide resolved
docs/developer-guide/syntaxes.md Outdated Show resolved Hide resolved
lib/getPostcssResult.js Outdated Show resolved Hide resolved
lib/getPostcssResult.js Outdated Show resolved Hide resolved
@jeddy3 jeddy3 mentioned this pull request Sep 26, 2021
30 tasks
@jeddy3
Copy link
Member Author

jeddy3 commented Sep 26, 2021

@hudochenkov Thanks for the suggestions. I've made those changes.

@jeddy3
Copy link
Member Author

jeddy3 commented Sep 27, 2021

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.)

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@ybiquitous ybiquitous left a 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>
@jeddy3
Copy link
Member Author

jeddy3 commented Sep 27, 2021

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)

It's a good suggestion. I'll pull the migration guide out when I'm back next week.

@jeddy3 jeddy3 changed the title Prepare docs for version 14 Document 14.0.0 migration guide Oct 8, 2021
@jeddy3 jeddy3 marked this pull request as ready for review October 8, 2021 15:41
@jeddy3
Copy link
Member Author

jeddy3 commented Oct 8, 2021

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 customSyntax now and changes to support that.

Pull request is ready for review.

docs/developer-guide/plugins.md Show resolved Hide resolved
docs/user-guide/get-started.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
lib/getPostcssResult.js Show resolved Hide resolved
jeddy3 and others added 4 commits October 8, 2021 17:20
Co-authored-by: Aleks Hudochenkov <aleks@hudochenkov.com>
Co-authored-by: Aleks Hudochenkov <aleks@hudochenkov.com>
Copy link
Member

@ybiquitous ybiquitous left a 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.

docs/about/linting.md Outdated Show resolved Hide resolved
docs/developer-guide/syntaxes.md Outdated Show resolved Hide resolved
docs/developer-guide/plugins.md Outdated Show resolved Hide resolved
docs/developer-guide/syntaxes.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
docs/migration-guide/to-14.md Outdated Show resolved Hide resolved
jeddy3 and others added 10 commits October 9, 2021 08:28
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>
@jeddy3
Copy link
Member Author

jeddy3 commented Oct 9, 2021

@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.

Copy link
Member

@hudochenkov hudochenkov left a comment

Choose a reason for hiding this comment

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

Fantastic work, @jeddy3!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants