You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository is part of a Work-In-Progress project to refresh and replace the CLI guides content of [https://ember-cli.com](https://ember-cli.com).
5
+
This repository holds the guides and tutorials for the [Ember CLI](https://github.com/ember-cli/ember-cli), a powerful tool that helps you create, develop, and build an Ember app.
6
6
7
-
## Contributing
7
+
To contribute to the API documentation itself, which lists properties and methods used by addons and apps, instead visit [Ember CLI](https://github.com/ember-cli/ember-cli), where the API docs are managed as code comments within the codebase.
8
8
9
-
Do you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do? We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md).
9
+
This project replaces, updates, and adds to the content historically hosted at [https://ember-cli.com/](https://ember-cli.com/).
10
10
11
-
Overall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.
11
+
Looking for repositories for the other parts of [emberjs.com](https://emberjs.com)?
and [styleguide](https://github.com/ember-learn/ember-styleguide).
12
20
13
-
As this project is pre-1.0, no content should be taken as technically authoritative.
14
21
15
22
## Prerequisites
16
23
@@ -23,7 +30,7 @@ You will need the following things properly installed on your computer.
23
30
24
31
## Local Development
25
32
26
-
The Ember-Cli Guides is a normal Ember application so if you want to run it locally you follow the standard steps:
33
+
The Ember-Cli Guides is a normal Ember application, so if you want to run it locally you follow the standard steps:
27
34
28
35
* Clone this repository
29
36
*`cd cli-guides-source`
@@ -38,6 +45,17 @@ To run the tests you can run `npm test` in your terminal, this will run any
38
45
Ember tests that have been setup but also some scripts that check the Markdown
39
46
files such as the link-checker.
40
47
48
+
## How this app works
49
+
50
+
The guides content is in the form of Markdown files in the [guides](https://github.com/ember-learn/cli-guides/tree/master/guides) directory. An Ember app processes and serves the Markdown files. If you look at the `app` directory, you'll see there's not much in it! That's because most of the work is done through a dependency on [guidemaker](https://sea-region.github.com/empress/guidemaker), a static site generator created in Ember.
51
+
52
+
## Contributing
53
+
54
+
Do you know a thing or two about the CLI or addons? Do you _wish_ you knew a thing or do? We'd love to have your help with writing or reviewing to make sure that content is helpful to all knowledge levels. To learn more about the motivation for this, read this [RFC](https://github.com/jenweber/rfcs-1/blob/cli-guides/active/0000-cli-guides.md). If you're new to writing Markdown, follow [this cheat sheet](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf).
55
+
56
+
Overall project status and tasks that need help are tracked in [this Quest issue](https://github.com/ember-learn/cli-guides-source/issues/3). Have a read through that and the [CONTRIBUTING.md](CONTRIBUTING.md) file in order to get started.
57
+
58
+
41
59
### Adding more things to the table of contents
42
60
43
61
See `pages.yaml` in the cli-guides-source. Whatever has a url of index will be what is shown for the top level path, like `/tutorial/`. There must be an `index.md` under each topic.
0 commit comments