@ember-learn/cli-guides

Ember-Cli Guides Source

This repository is part of a Work-In-Progress project to refresh and replace the CLI guides content of https://ember-cli.com.

Contributing

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.

Overall project status and tasks that need help are tracked in this Quest issue. Have a read through that and the CONTRIBUTING.md file in order to get started.

As this project is pre-1.0, no content should be taken as technically authoritative.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with npm)
• Ember CLI
• Google Chrome
• npm

Local Development

To see what a local copy of the Guides markdown looks like:

• Clone the Ember CLI Guides App repository
• link the cli-guides-source repository by running npm link inside this repository, then npm link @ember-learn/cli-guides in the guides-app
• npm install and ember serve in the guides app
• Visit your app at http://localhost:4200.
• Visit your tests at http://localhost:4200/tests.

If you follow this strategy above, as you save changes to the markdown files of this repository, your locally served app should update.

Adding more things to the table of contents

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.

Deploying

See instructions on the cli-guides-app README.