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

docs: include 2.x/3.x to 4.0 migration guide #381

Merged
merged 8 commits into from
Jul 15, 2019

Conversation

P0lip
Copy link
Contributor

@P0lip P0lip commented Jul 15, 2019

Closes #364

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

@P0lip P0lip requested review from philsturgeon and tbarn July 15, 2019 14:32

1. Config is gone...

...here is no way to restore it.
Copy link
Contributor

Choose a reason for hiding this comment

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

this could be "The config files (which was spectral.yml by default, or using the --config was a combination of things that could all be done as CLI flags, and was just meant to reduce how much you needed to type those things out. The important stuff has been replaced with looking for a drefault ruleset, called .spectral.yml (notice the . prefix) and loading a ruleset and skipping a rule would now look like this: (before and after)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@philsturgeon done.
Besides that, added a note on recommended property.

tbarn
tbarn previously approved these changes Jul 15, 2019
Copy link
Contributor

@tbarn tbarn left a comment

Choose a reason for hiding this comment

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

✨✨✨

@philsturgeon philsturgeon merged commit c2e2bf2 into develop Jul 15, 2019
@philsturgeon philsturgeon deleted the docs/4.0-migration branch July 15, 2019 18:48
philsturgeon pushed a commit that referenced this pull request Aug 8, 2019
* docs: include 2.x/3.x to 4.0 migration guide

* cleaned up migration guide

* remove periods for consistency

* docs: feedback from @philsturgeon

* docs: cover recommended property

* clearing a few things up

* Update 4.0.md
philsturgeon pushed a commit that referenced this pull request Aug 8, 2019
* docs: include 2.x/3.x to 4.0 migration guide (#381)

* docs: include 2.x/3.x to 4.0 migration guide

* cleaned up migration guide

* remove periods for consistency

* docs: feedback from @philsturgeon

* docs: cover recommended property

* clearing a few things up

* Update 4.0.md

* fix typo

* Documentation Rewrite (#417)

New documentation covering CLI and JS APIs, rulesets, workflows, core rules, etc.
philsturgeon pushed a commit that referenced this pull request Aug 20, 2019
* docs: include 2.x/3.x to 4.0 migration guide (#381)

* docs: include 2.x/3.x to 4.0 migration guide

* cleaned up migration guide

* remove periods for consistency

* docs: feedback from @philsturgeon

* docs: cover recommended property

* clearing a few things up

* Update 4.0.md

* fix typo

* Documentation Rewrite (#417)

New documentation covering CLI and JS APIs, rulesets, workflows, core rules, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add migration documents from 3.X => 4.X
4 participants