Merge pull request #2394 from miragejs/docs-restructure

Restructure docs from pods to classic structure

package.json

@@ -129,7 +129,6 @@
     "@embroider/macros": "1.6.0",
     "@embroider/shared-internals": "1.6.0",
     "@embroider/util": "1.6.0",
-    "babel-import-util": "1.2.2",
     "colors": "1.4.0",
     "favicons": "5.3.0"
   },

tests/dummy/app/router.js

@@ -33,6 +33,7 @@ Router.map(function () {
     });
 
     this.route('testing', function () {
+      this.route('setup-mirage');
       this.route('acceptance-tests');
       this.route('integration-and-unit-tests');
       this.route('assertions');

tests/dummy/app/pods/blog/detail/route.js → tests/dummy/app/routes/blog/detail.js

@@ -1,11 +1,15 @@
 import Route from '@ember/routing/route';
+import { inject as service } from '@ember/service';
 
 export default class extends Route {
+  @service router;
+  @service store;
+
   model({ post_slug_and_id }) {
     let matches = post_slug_and_id.match(/\d+$/);
     if (!matches) {
       let path = document.location.pathname.replace(/^\/|\/$/g, '');
-      this.transitionTo('not-found', path);
+      this.router.transitionTo('not-found', path);
     }
 
     let postId = matches[0];

tests/dummy/app/routes/docs/index.js

@@ -0,0 +1,10 @@
+import Route from '@ember/routing/route';
+import { inject as service } from '@ember/service';
+
+export default class extends Route {
+  @service router;
+
+  beforeModel() {
+    this.router.transitionTo('docs.getting-started.what-is-mirage');
+  }
+}

tests/dummy/app/pods/not-found/route.js → tests/dummy/app/routes/not-found.js

@@ -1,13 +1,19 @@
 import Route from '@ember/routing/route';
+import { inject as service } from '@ember/service';
 
 export default class extends Route {
+  @service router;
+
   beforeModel() {
     let { path } = this.paramsFor('not-found');
 
     this.redirects.forEach((redirect) => {
       redirect.from.forEach((candidate) => {
         if (path === candidate || path === `${candidate}/`) {
-          this.transitionTo('blog.detail', redirect.to.replace('blog/', ''));
+          this.router.transitionTo(
+            'blog.detail',
+            redirect.to.replace('blog/', '')
+          );
         }
       });
     });

tests/dummy/app/pods/application/template.hbs → tests/dummy/app/templates/application.hbs

@@ -1,7 +1,7 @@
 <DocsHeader as |header|>
-  {{#header.link "blog"}}
+  <header.link @route="blog">
     Blog
-  {{/header.link}}
+  </header.link>
 </DocsHeader>
 
 {{outlet}}

tests/dummy/app/templates/docs.hbs

@@ -0,0 +1,46 @@
+<DocsViewer as |viewer|>
+
+  <viewer.nav as |nav|>
+    <nav.section @label="Getting started" />
+    <nav.item @label="What is Mirage?" @route="docs.getting-started.what-is-mirage" />
+    <nav.item @label="Installation" @route="docs.getting-started.installation" />
+    <nav.item @label="Upgrade guide" @route="docs.getting-started.upgrade-guide" />
+    <nav.item @label="Overview" @route="docs.getting-started.overview" />
+
+    <nav.section @label="Route handlers" />
+    <nav.item @label="Functions" @route="docs.route-handlers.functions" />
+    <nav.item @label="Shorthands" @route="docs.route-handlers.shorthands" />
+
+    <nav.section @label="Data layer" />
+    <nav.item @label="The Database" @route="docs.data-layer.database" />
+    <nav.item @label="Why an ORM?" @route="docs.data-layer.orm" />
+    <nav.item @label="Models" @route="docs.data-layer.models" />
+    <nav.item @label="Relationships" @route="docs.data-layer.relationships" />
+    <nav.item @label="Factories" @route="docs.data-layer.factories" />
+    <nav.item @label="Fixtures" @route="docs.data-layer.fixtures" />
+    <nav.item @label="Serializers" @route="docs.data-layer.serializers" />
+    <nav.subnav as |nav|>
+      <nav.item @label="Ember Data Serializer" @route="docs.data-layer.serializers.ember-data-serializer" />
+    </nav.subnav>
+
+    <nav.section @label="Testing" />
+    <nav.item @label="setupMirage test helper" @route="docs.testing.setup-mirage" />
+    <nav.item @label="Acceptance tests" @route="docs.testing.acceptance-tests" />
+    <nav.item @label="Integration and unit tests" @route="docs.testing.integration-and-unit-tests" />
+    <nav.item @label="Assertions" @route="docs.testing.assertions" />
+
+    <nav.section @label="Advanced" />
+    <nav.item @label="Environment options" @route="docs.advanced.environment-options" />
+    <nav.item @label="Server Configuration" @route="docs.advanced.server-configuration" />
+    <nav.item @label="Simulating cookie responses" @route="docs.advanced.simulating-cookie-responses" />
+    <nav.item @label="Mocking GUIDs" @route="docs.advanced.mocking-guids" />
+    <nav.item @label="Customizing the inflector" @route="docs.advanced.customizing-the-inflector" />
+    <nav.item @label="Switching between scenarios" @route="docs.advanced.switching-between-scenarios" />
+
+  </viewer.nav>
+
+  <viewer.main>
+    {{outlet}}
+  </viewer.main>
+
+</DocsViewer>

yarn.lock

@@ -3879,7 +3879,12 @@ babel-helpers@^6.24.1:
     babel-runtime "^6.22.0"
     babel-template "^6.24.1"
 
-[email protected], babel-import-util@^0.2.0, babel-import-util@^1.1.0:
+babel-import-util@^0.2.0:
+  version "0.2.0"
+  resolved "https://registry.yarnpkg.com/babel-import-util/-/babel-import-util-0.2.0.tgz#b468bb679919601a3570f9e317536c54f2862e23"
+  integrity sha512-CtWYYHU/MgK88rxMrLfkD356dApswtR/kWZ/c6JifG1m10e7tBBrs/366dFzWMAoqYmG5/JSh+94tUSpIwh+ag==
+
+babel-import-util@^1.1.0:
   version "1.2.2"
   resolved "https://registry.yarnpkg.com/babel-import-util/-/babel-import-util-1.2.2.tgz#1027560e143a4a68b1758e71d4fadc661614e495"
   integrity sha512-8HgkHWt5WawRFukO30TuaL9EiDUOdvyKtDwLma4uBNeUSDbOO0/hiPfavrOWxSS6J6TKXfukWHZ3wiqZhJ8ONQ==