Skip to content

Commit

Permalink
docs: add new outline structure
Browse files Browse the repository at this point in the history
Generate new routes for the new outline of the docs, and begin
populating them with existing content or stubs for new content.
  • Loading branch information
chriskrycho committed Dec 5, 2019
1 parent 2fcef6e commit 99193e5
Show file tree
Hide file tree
Showing 19 changed files with 163 additions and 55 deletions.
24 changes: 23 additions & 1 deletion tests/dummy/app/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,30 @@ const Router = AddonDocsRouter.extend({

Router.map(function() {
docsRoute(this, function() {
this.route('setup', function() {
this.route('installation');
this.route('configuration');
});

this.route('guide', function() {
this.route('overview');
this.route('components');
this.route('services');
this.route('testing');
this.route('routes');
this.route('controllers');
this.route('helpers');
this.route('apps-and-addons');
});

this.route('legacy', function() {
this.route('overview');
this.route('ember-object');
this.route('mixins');
this.route('ember-component');
});

this.route('upgrade-notes');
this.route('configuration');
this.route('ts-guide', function() {
this.route('with-addons');
this.route('using-ts-effectively');
Expand Down
31 changes: 24 additions & 7 deletions tests/dummy/app/templates/docs.hbs
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
<DocsHeader @prefix='Ember CLI' @name='TypeScript' />

{{#docs-viewer as |viewer|}}
<DocsViewer as |viewer|>
<viewer.nav as |nav|>
{{nav.section 'Introduction'}}
{{nav.item 'Installation' 'docs.index'}}
{{nav.item 'Upgrading from 1.x' 'docs.upgrade-notes'}}
{{nav.item 'Configuration' 'docs.configuration'}}
{{nav.section 'Getting Started'}}
{{nav.item 'Installation' 'docs.setup'}}
{{nav.item 'Configuration' 'docs.setup.configuration'}}

{{nav.section 'Guide'}}
{{nav.item 'Overview' 'docs.guide.overview'}}
{{nav.item 'Components' 'docs.guide.components'}}
{{nav.item 'Services' 'docs.guide.services'}}
{{nav.item 'Routes' 'docs.guide.routes'}}
{{nav.item 'Helpers' 'docs.guide.helpers'}}
{{nav.item 'Testing' 'docs.guide.testing'}}
{{nav.item 'Controllers' 'docs.guide.controllers'}}

{{nav.section 'Legacy Guide'}}
{{nav.item 'Overview' 'docs.legacy.overview'}}
{{nav.item 'EmberObject' 'docs.legacy.ember-object'}}
{{nav.item 'Mixins' 'docs.legacy.mixins'}}
{{nav.item 'EmberComponent' 'docs.legacy.ember-component'}}

{{nav.section 'Using TypeScript with Ember'}}
{{nav.item 'Using TypeScript Effectively' 'docs.ts-guide.using-ts-effectively'}}
Expand All @@ -17,9 +30,13 @@

{{nav.section 'Troubleshooting'}}
{{nav.item 'Conflicting Type Dependencies' 'docs.troubleshooting.conflicting-types'}}

{{nav.section 'Upgrading'}}
{{nav.item '1.x → 2.x' 'docs.upgrade-notes'}}
{{nav.item '2.x → 3.x' 'docs.upgrade-notes'}}
</viewer.nav>

<viewer.main>
{{outlet}}
</viewer.main>
{{/docs-viewer}}
</DocsViewer>
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{outlet}}
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/apps-and-addons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{outlet}}
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/controllers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Controllers
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/helpers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Helpers
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/routes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Routes
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/guide/services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Services
File renamed without changes.
52 changes: 5 additions & 47 deletions tests/dummy/app/templates/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,7 @@
# Installation
# Overview

You can simply `ember install` the dependency like normal:
This guide is designed to help you get up and running with TypeScript in an Ember app.

```sh
ember install ember-cli-typescript@latest
```

All dependencies will be added to your `package.json`, and you're ready to roll! **If you're upgrading from a previous release, see below!** you should check to merge any tweaks you've made to `tsconfig.json`.

## Installation Results

Installing ember-cli-typescript modifies your project in two ways:

- installing a number of other packages to make TypeScript work in your app or addon
- generating a number of files in your project

### Other packages this addon installs

We install the following packages—all at their current "latest" value—or generated:

- [`typescript`](https://github.com/Microsoft/TypeScript)
- **@types/ember** ([npm](https://www.npmjs.com/package/@types/ember) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember)) - Types for [Ember.js](https://github.com/emberjs/ember.js) which includes
- **@types/ember\_\_string** ([npm](https://www.npmjs.com/package/@types/ember__string) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__string)) - types for the [`@ember/string` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fstring)
- **@types/ember\_\_object** ([npm](https://www.npmjs.com/package/@types/ember__object) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__object)) - types for the [`@ember/object` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fobject)
- **@types/ember\_\_utils** ([npm](https://www.npmjs.com/package/@types/ember__utils) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__utils)) - types for the [`@ember/utils` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Futils)
- **@types/ember\_\_array** ([npm](https://www.npmjs.com/package/@types/ember__array) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__array)) - types for the [`@ember/array` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Farray)
- **@types/ember\_\_component** ([npm](https://www.npmjs.com/package/@types/ember__component) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__component)) - types for the [`@ember/component` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcomponent)
- **@types/ember\_\_engine** ([npm](https://www.npmjs.com/package/@types/ember__engine) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__engine)) - types for the [`@ember/engine` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fengine)
- **@types/ember\_\_application** ([npm](https://www.npmjs.com/package/@types/ember__application) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__application)) - types for the [`@ember/application` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fapplication)
- **@types/ember\_\_controller** ([npm](https://www.npmjs.com/package/@types/ember__controller) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__controller)) - types for the [`@ember/controller` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcontroller)
- **@types/ember\_\_service** ([npm](https://www.npmjs.com/package/@types/ember__service) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__service)) - types for the [`@ember/service` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fservice)
- **@types/ember\_\_runloop** ([npm](https://www.npmjs.com/package/@types/ember__runloop) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__runloop)) - types for the [`@ember/runloop` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frunloop)
- **@types/ember\_\_error** ([npm](https://www.npmjs.com/package/@types/ember__error) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__error)) - types for the [`@ember/error` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ferror)
- **@types/ember\_\_polyfills** ([npm](https://www.npmjs.com/package/@types/ember__polyfills) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__polyfills)) - types for the [`@ember/polyfills` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fpolyfills)
- **@types/ember\_\_debug** ([npm](https://www.npmjs.com/package/@types/ember__debug) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__debug)) - types for the [`@ember/debug` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fdebug)
- **@types/ember\_\_test** ([npm](https://www.npmjs.com/package/@types/ember__test) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__test)) - types for the [`@ember/test` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ftest)
- **@types/ember\_\_routing** ([npm](https://www.npmjs.com/package/@types/ember__routing) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__routing)) - types for the [`@ember/routing` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frouting)
- **@types/ember-data** - ([npm](https://www.npmjs.com/package/@types/ember-data) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-data)) - Types for [Ember-Data](https://github.com/emberjs/data)
- **@types/rsvp** - ([npm](https://www.npmjs.com/package/@types/rsvp) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rsvp)) - Types for [RSVP.js](https://github.com/tildeio/rsvp.js/)
- **@types/ember\_\_test-helpers** - ([npm](https://www.npmjs.com/package/@types/ember__test-helpers) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__test-helpers)) – Types for [@ember/test-helpers](https://github.com/emberjs/ember-test-helpers).

### Files this addon generates

We add the following files to your project:

- [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)
- `types/<app name>/index.d.ts` – the location for any global type declarations you need to write for you own application; see [**Using TS Effectively: Global types for your package**](./docs/ts-guide/using-ts-effectively#global-types-for-your-package) for information on its default contents and how to use it effectively
- `app/config/environment.d.ts` – a basic set of types defined for the contents of the `config/environment.js` file in your app; see [Environment and configuration typings](#environment-and-configuration-typings) for details
- To get started, check out the instructions in <LinkTo @route='docs.setup'>Getting Started</LinkTo>.
- If you're totally new to using TypeScript, or to using TypeScript with Ember, start by following the <LinkTo @route='docs.guide'>Guide</LinkTo>.
- If you're experienced with both TypeScript and Ember, you might be interested in the [Reference](TODO)
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/legacy/ember-component.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# `EmberComponent`
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/legacy/ember-object.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# `EmberObject`
1 change: 1 addition & 0 deletions tests/dummy/app/templates/docs/legacy/mixins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Mixins
3 changes: 3 additions & 0 deletions tests/dummy/app/templates/docs/legacy/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Legacy Ember Guide

We emphasize the happy path of working with Ember in the [Octane Edition](TODO). However, many existing applications include parts of the pre-Octane (“legacy”) Ember programming model, and we support that model—with caveats.
49 changes: 49 additions & 0 deletions tests/dummy/app/templates/docs/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Installation

You can simply `ember install` the dependency like normal:

```sh
ember install ember-cli-typescript@latest
```

All dependencies will be added to your `package.json`, and you're ready to roll! **If you're upgrading from a previous release, see below!** you should check to merge any tweaks you've made to `tsconfig.json`.

## Installation Results

Installing ember-cli-typescript modifies your project in two ways:

- installing a number of other packages to make TypeScript work in your app or addon
- generating a number of files in your project

### Other packages this addon installs

We install the following packages—all at their current "latest" value—or generated:

- [**`typescript`**](https://github.com/Microsoft/TypeScript)
- **`@types/ember`** ([npm](https://www.npmjs.com/package/@types/ember) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember)) - Types for [Ember.js](https://github.com/emberjs/ember.js) which includes
- **`@types/ember__string`** ([npm](https://www.npmjs.com/package/@types/ember__string) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__string)) - types for the [`@ember/string` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fstring)
- **`@types/ember__object`** ([npm](https://www.npmjs.com/package/@types/ember__object) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__object)) - types for the [`@ember/object` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fobject)
- **`@types/ember__utils`** ([npm](https://www.npmjs.com/package/@types/ember__utils) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__utils)) - types for the [`@ember/utils` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Futils)
- **`@types/ember__array`** ([npm](https://www.npmjs.com/package/@types/ember__array) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__array)) - types for the [`@ember/array` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Farray)
- **`@types/ember__component`** ([npm](https://www.npmjs.com/package/@types/ember__component) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__component)) - types for the [`@ember/component` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcomponent)
- **`@types/ember__engine`** ([npm](https://www.npmjs.com/package/@types/ember__engine) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__engine)) - types for the [`@ember/engine` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fengine)
- **`@types/ember__application`** ([npm](https://www.npmjs.com/package/@types/ember__application) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__application)) - types for the [`@ember/application` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fapplication)
- **`@types/ember__controller`** ([npm](https://www.npmjs.com/package/@types/ember__controller) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__controller)) - types for the [`@ember/controller` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fcontroller)
- **`@types/ember__service`** ([npm](https://www.npmjs.com/package/@types/ember__service) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__service)) - types for the [`@ember/service` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fservice)
- **`@types/ember__runloop`** ([npm](https://www.npmjs.com/package/@types/ember__runloop) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__runloop)) - types for the [`@ember/runloop` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frunloop)
- **`@types/ember__error`** ([npm](https://www.npmjs.com/package/@types/ember__error) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__error)) - types for the [`@ember/error` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ferror)
- **`@types/ember__polyfills`** ([npm](https://www.npmjs.com/package/@types/ember__polyfills) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__polyfills)) - types for the [`@ember/polyfills` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fpolyfills)
- **`@types/ember__debug`** ([npm](https://www.npmjs.com/package/@types/ember__debug) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__debug)) - types for the [`@ember/debug` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Fdebug)
- **`@types/ember__test`** ([npm](https://www.npmjs.com/package/@types/ember__test) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__test)) - types for the [`@ember/test` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Ftest)
- **`@types/ember__routing`** ([npm](https://www.npmjs.com/package/@types/ember__routing) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__routing)) - types for the [`@ember/routing` package](https://www.emberjs.com/api/ember/3.4/modules/@ember%2Frouting)
- **`@types/ember-data`** - ([npm](https://www.npmjs.com/package/@types/ember-data) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember-data)) - Types for [Ember-Data](https://github.com/emberjs/data)
- **`@types/rsvp`** - ([npm](https://www.npmjs.com/package/@types/rsvp) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rsvp)) - Types for [RSVP.js](https://github.com/tildeio/rsvp.js/)
- **`@types/ember__test-helpers`** - ([npm](https://www.npmjs.com/package/@types/ember__test-helpers) | [source](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ember__test-helpers)) – Types for [@ember/test-helpers](https://github.com/emberjs/ember-test-helpers).

### Files this addon generates

We add the following files to your project:

- [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)
- `types/<app name>/index.d.ts` – the location for any global type declarations you need to write for you own application; see [**Using TS Effectively: Global types for your package**](./docs/ts-guide/using-ts-effectively#global-types-for-your-package) for information on its default contents and how to use it effectively
- `app/config/environment.d.ts` – a basic set of types defined for the contents of the `config/environment.js` file in your app; see [Environment and configuration typings](#environment-and-configuration-typings) for details
Loading

0 comments on commit 99193e5

Please sign in to comment.