Add a migration guide

This commit is contained in:
Rowan Manning
2016-06-05 12:59:10 +01:00
parent 2633248ea1
commit 9d53739c06
2 changed files with 34 additions and 0 deletions

19
MIGRATION.md Normal file
View File

@@ -0,0 +1,19 @@
Migration Guide
===============
Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens.
Table Of Contents
-----------------
- [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)
Migrating from 1.0 to 2.0
-------------------------
### Node.js Support
The only breaking change in Pa11y Dashboard 2.0 is that Node.js 0.10 and 0.12 are no longer supported. We'll be using newer ES6 features in upcoming releases which will not work in these older Node.js versions.

View File

@@ -114,6 +114,21 @@ Useful Resources
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitialOcean][resource-una-k]
Support and Migration
---------------------
Pa11y Dashboard major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
We also maintain a [migration guide](MIGRATION.md) to help you migrate.
| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
| :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
| :heart: | 2 | N/A | 4+ | N/A |
| :hourglass: | 1 | 1.12 | 0.106 | 2016-12-05 |
If you're opening issues related to these, please mention the version that the issue relates to.
License
-------