docs: Add @rest-hooks/legacy directions (#929)

Author: ntucker

docs/upgrade/upgrading-test-to-six.md

@@ -0,0 +1,16 @@
+---
+title: Upgrading @rest-hooks/test to 6
+---
+
+`@rest-hooks/test` uses `react-hooks-testing-library` internally. Version 7
+has a major version upgrade for this library, so the following [breaking changes](https://github.com/testing-library/react-hooks-testing-library/releases/tag/v7.0.0
+)
+also apply to `@rest-hooks/test@6`
+
+- 'suppressErrorOutput will now work when explicitly called, even if the
+RHTL_DISABLE_ERROR_FILTERING env variable has been set' (from
+react-hooks-testing-library)
+- requires node 12 or above
+
+
+`@rest-hooks/test@6` [Release notes](https://github.com/coinbase/rest-hooks/releases/tag/%40rest-hooks%2Ftest%406.0.0)

docs/upgrade/upgrading-to-5.md

@@ -362,6 +362,43 @@ class MyResource extends Resource {
 
 </details>
 
+### @rest-hooks/legacy
+
+For v5 of Rest Hooks, the existing `Resource` and `SimpleResource` classes will
+be exported.
+
+In v6, this will no longer be the case. However, they will continue to live in `@rest-hooks/legacy`, allowing
+easy safe upgrade to v6 by simply changing the import path. However, it is still recommended to
+try to migrate to `@rest-hooks/rest` as this is the future. v1 of @rest-hooks/rest will be the easiest to
+start with.
+
+
+<details><summary>yarn add @rest-hooks/legacy</summary>
+
+
+<!--DOCUSAURUS_CODE_TABS-->
+<!--before-->
+
+```typescript
+import { Resource } from 'rest-hooks';
+
+class MyResource extends Resource {
+}
+```
+
+<!--after-->
+
+```typescript
+import { Resource } from '@rest-hooks/legacy';
+
+class MyResource extends Resource {
+}
+```
+
+<!--END_DOCUSAURUS_CODE_TABS-->
+
+</details>
+
 ### @rest-hooks/rest
 
 Rest Hooks is protocol agnostic, so the REST/CRUD specific class [Resource](../api/resource)

website/i18n/en.json

@@ -253,6 +253,9 @@
       "upgrade/upgrading-test-to-four": {
         "title": "Upgrading @rest-hooks/test to 4"
       },
+      "upgrade/upgrading-test-to-six": {
+        "title": "Upgrading @rest-hooks/test to 6"
+      },
       "upgrade/upgrading-test-to-three": {
         "title": "Upgrading @rest-hooks/test to 3"
       },
@@ -1081,6 +1084,9 @@
       "version-5.0/upgrade/version-5.0-upgrading-test-to-four": {
         "title": "Upgrading @rest-hooks/test to 4"
       },
+      "version-5.0/upgrade/version-5.0-upgrading-test-to-six": {
+        "title": "Upgrading @rest-hooks/test to 6"
+      },
       "version-5.0/upgrade/version-5.0-upgrading-test-to-three": {
         "title": "Upgrading @rest-hooks/test to 3"
       },

website/sidebars.json

@@ -163,7 +163,8 @@
     "Upgrade Guide": [
       "upgrade/upgrading-to-5",
       "upgrade/upgrading-test-to-three",
-      "upgrade/upgrading-test-to-four"
+      "upgrade/upgrading-test-to-four",
+      "upgrade/upgrading-test-to-six"
     ]
   }
 }

website/versioned_docs/version-5.0/upgrade/upgrading-test-to-six.md

@@ -0,0 +1,18 @@
+---
+title: Upgrading @rest-hooks/test to 6
+id: version-5.0-upgrading-test-to-six
+original_id: upgrading-test-to-six
+---
+
+`@rest-hooks/test` uses `react-hooks-testing-library` internally. Version 7
+has a major version upgrade for this library, so the following [breaking changes](https://github.com/testing-library/react-hooks-testing-library/releases/tag/v7.0.0
+)
+also apply to `@rest-hooks/test@6`
+
+- 'suppressErrorOutput will now work when explicitly called, even if the
+RHTL_DISABLE_ERROR_FILTERING env variable has been set' (from
+react-hooks-testing-library)
+- requires node 12 or above
+
+
+`@rest-hooks/test@6` [Release notes](https://github.com/coinbase/rest-hooks/releases/tag/%40rest-hooks%2Ftest%406.0.0)

website/versioned_docs/version-5.0/upgrade/upgrading-to-5.md

@@ -364,6 +364,43 @@ class MyResource extends Resource {
 
 </details>
 
+### @rest-hooks/legacy
+
+For v5 of Rest Hooks, the existing `Resource` and `SimpleResource` classes will
+be exported.
+
+In v6, this will no longer be the case. However, they will continue to live in `@rest-hooks/legacy`, allowing
+easy safe upgrade to v6 by simply changing the import path. However, it is still recommended to
+try to migrate to `@rest-hooks/rest` as this is the future. v1 of @rest-hooks/rest will be the easiest to
+start with.
+
+
+<details><summary>yarn add @rest-hooks/legacy</summary>
+
+
+<!--DOCUSAURUS_CODE_TABS-->
+<!--before-->
+
+```typescript
+import { Resource } from 'rest-hooks';
+
+class MyResource extends Resource {
+}
+```
+
+<!--after-->
+
+```typescript
+import { Resource } from '@rest-hooks/legacy';
+
+class MyResource extends Resource {
+}
+```
+
+<!--END_DOCUSAURUS_CODE_TABS-->
+
+</details>
+
 ### @rest-hooks/rest
 
 Rest Hooks is protocol agnostic, so the REST/CRUD specific class [Resource](../api/resource)

website/versioned_sidebars/version-5.0-sidebars.json

@@ -179,7 +179,8 @@
     "Upgrade Guide": [
       "version-5.0-upgrade/upgrading-to-5",
       "version-5.0-upgrade/upgrading-test-to-three",
-      "version-5.0-upgrade/upgrading-test-to-four"
+      "version-5.0-upgrade/upgrading-test-to-four",
+      "version-5.0-upgrade/upgrading-test-to-six"
     ]
   }
 }