Skip to content

Commit 118be77

Browse files
committed
finish table of contents
1 parent aebc537 commit 118be77

20 files changed

+93
-17
lines changed

guides/advanced-use/asset-pipeline.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Cover very very basic Broccoli info. Link to Oli's tutorials. See the Ember Times Readers questions for a great writeup of what broccoli is -->

guides/advanced-use/blueprints.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- cover what blueprints are and how to modify them. Can be ported from the existing site -->

guides/advanced-use/configurations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Should cover at least minification and fingerprinting -->

guides/advanced-use/file-layout.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- A place to talk about the resolver (see ember-cli.com), module imports, and eventually, Module Unification when it becomes a thing -->

guides/advanced-use/stylesheets.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Should cover similar topics as ember-cli.com -->

guides/basic-use/configurations.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- The bare minimum explanation of what to do with ember-cli-build.js -->

guides/basic-use/deploying.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- should show ember build, link to ember-cli-deploy, Guides tutorial -->

guides/basic-use/index.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,21 @@ npm install -g ember-cli
1818

1919
This will make the `ember` command available throughout your project folders. The installation is successful if `ember -v` returns a version number. When it is run inside of an Ember app directory, it will show the version of the app, otherwise it will show the globally installed version of the CLI.
2020

21-
### Additional steps for Mac users
21+
### Additional steps for Mac and Linux users
2222

23-
Mac users may need to install [Watchman](https://facebook.github.io/watchman/) via [Homebrew](http://brew.sh/). Watchman helps correct for some buggy file watching behavior in MacOS. Do not use the `npm` package by the same name.
23+
Mac and Linux users may need to install [Watchman](https://facebook.github.io/watchman/). Watchman helps correct for some buggy and inefficient file watching behavior. Do not use the `npm` package by the same name.
24+
25+
Mac users cann install via [Homebrew](http://brew.sh/):
2426

2527
```bash
2628
brew install watchman
2729
```
2830

29-
## Versioning
30-
31-
The Ember CLI is backwards compatible, meaning that the latest CLI can be used on older app versions. New versions of the CLI are released roughly every 6 weeks, in step with versions of Ember.js itself.
32-
33-
A list of CLI releases and their features can be found on the GitHub repository for [ember-cli](https://github.com/ember-cli/ember-cli/releases).
34-
35-
## Upgrading the CLI version
36-
37-
The Ember CLI can be updated independently of the apps it is used with.
38-
Upgrade instructions are published with [each release](https://github.com/ember-cli/ember-cli/releases).
31+
Linux users should follow the steps on the [Watchman](https://facebook.github.io/watchman/) website to build from the source.
3932

40-
## Upgrading the Ember app itself
33+
### Installing for Windows
4134

42-
There are automated Ember CLI tools available to help upgrade Ember apps, including codemods that help with syntax changes. Visit
43-
[ember-cli-update](https://github.com/ember-cli/ember-cli-update for the latest instructions.
35+
<!-- copy over from ember-cli.com -->
4436

4537
## Getting help
4638

guides/basic-use/upgrading.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
There are three kinds of upgrades for normal Ember app development:
2+
3+
1. The version of the CLI that you are using
4+
2. The version of the app itself
5+
3. Addons used by an app
6+
7+
## Upgrading the CLI version
8+
9+
The Ember CLI is backwards compatible, meaning that the latest CLI can be used on older app versions. New versions of the CLI are released roughly every 6 weeks, in step with versions of Ember.js itself.
10+
11+
Upgrade instructions are published with [each release](https://github.com/ember-cli/ember-cli/releases).
12+
13+
In general, here's how to upgrade the version of the CLI and verify that the upgrade worked:
14+
15+
```bash
16+
npm uninstall -g ember-cli
17+
npm install -g ember-cli
18+
ember --version
19+
```
20+
21+
## Upgrading an Ember app itself
22+
23+
There are automated Ember CLI tools available to help upgrade Ember apps, including codemods that help with syntax changes. Visit
24+
[ember-cli-update](https://github.com/ember-cli/ember-cli-update for the latest instructions.
25+
26+
<!-- Needs a section that describes a common upgrade experience, explains deprecations, links to Deprecations site, and hints that upgrades to get new features or jump major versions require changes to the codebase. Common misconception is that you can just jump versions in package.json. Pull in info from https://ember-cli.com/user-guide/#upgrading -->
27+
28+
## Upgrading Addon Dependencies
29+
30+
<!-- very brief guidance on how to approach addons, and a note that sometimes deprecation warnings come from outdated addons rather than your app -->

guides/pages.yml

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,20 @@
77
- title: 'Basic Use'
88
url: 'basic-use'
99
pages:
10-
- title: 'Installing and upgrading'
10+
- title: 'Installing'
1111
url: 'index'
1212
- title: 'CLI commands'
1313
url: 'cli-commands'
1414
- title: 'Using addons'
1515
url: 'using-addons'
1616
- title: 'Using npm packages'
1717
url: 'using-npm-packages'
18+
- title: 'Deploying an Ember app'
19+
url: 'deploying'
20+
- title: 'Upgrading'
21+
url: 'upgrading'
22+
- title: 'Common configurations'
23+
url: 'configurations'
1824

1925
- title: 'Writing addons'
2026
url: 'writing-addons'
@@ -25,12 +31,44 @@
2531
url: 'tutorial'
2632
- title: 'Testing'
2733
url: 'testing'
34+
- title: 'Writing documentation'
35+
url: 'documenting'
36+
- title: 'Deploying an addon'
37+
url: 'deploying'
38+
- title: 'Wrapping existing libraries'
39+
url: 'wrappers'
40+
- title: 'Managing addon dependencies'
41+
url: 'dependencies'
2842

2943
- title: 'Advanced use'
3044
url: 'advanced-use'
3145
pages:
3246
- title: 'Overview'
3347
url: 'index'
48+
- title: 'Advanced configurations'
49+
url: 'configurations'
50+
- title: 'Broccoli asset pipeline'
51+
url: 'asset-pipeline'
52+
- title: 'Creating blueprints'
53+
url: 'blueprints'
54+
- title: 'Stylesheet compilation'
55+
url: 'stylesheets'
56+
- title: 'File layout and the resolver'
57+
url: 'file-layout'
58+
59+
- title: 'Reference'
60+
url: 'reference'
61+
pages:
62+
- title: 'Overview'
63+
url: 'index'
64+
- title: 'Windows support'
65+
url: 'windows'
66+
- title: 'Code Editor Integrations'
67+
url: 'dev-tools'
68+
- title: 'Common issues'
69+
url: 'common-issues'
70+
- title: 'Frequently Asked Questions'
71+
url: 'faq'
3472

3573
- title: 'API Documentation'
3674
url: 'api-documentation'

guides/reference/common-issues.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- copy over from ember-cli.com -->

guides/reference/dev-tools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Copy over code editor content -->

guides/reference/faq.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Do I need to use the CLI, why broccoli instead of webpack, node version compatibility? -->

guides/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Brief description of what goes in the reference section. Mostly edge case stuff -->

guides/reference/windows.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Port over info from existing site -->

guides/writing-addons/dependencies.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Should cover where to put dependencies in package.json, how to export specific assets -->

guides/writing-addons/deploying.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- This section should at least give people some clues about how to do a local production build, try it out locally, and then link to resources on publishing to npm -->

guides/writing-addons/documenting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Should mention that many authors use the dummy app for their documentation. Should link to ember-cli-addon-docs, with clear indication of its status as a community project -->

guides/writing-addons/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!-- Help Wanted -->
1+
<!-- Should cover ember-try, tests, and using the dummy app in testing. See ember-styleguide and popular addons for inspiration -->

guides/writing-addons/wrappers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- Supplemental information to help someone write an Ember wrapper. Do not repeat content from the tutorial. -->

0 commit comments

Comments
 (0)