Step-by-step guides and tutorials for using the ember-cli to create apps and addons
Switch branches/tags
Clone or download
jenweber Merge pull request #82 from ember-learn/locks-patch-1
Remove ember-welcome dependency
Latest commit 231b971 Dec 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Small CSS fixes (#31) Nov 10, 2018
config fixing edit button Nov 26, 2018
guides Merge pull request #75 from maxwondercorn/issues/layouts Dec 6, 2018
node-tests Convert cli-guides to be a single repo project (#28) Nov 10, 2018
public Convert cli-guides to be a single repo project (#28) Nov 10, 2018
tests Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.alexrc #3 blueprints (#38) Nov 25, 2018
.editorconfig Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.ember-cli Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.eslintignore Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.eslintrc.js Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.gitignore Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.local.dic lint/remark frail (#80) Dec 13, 2018
.netlifyheaders Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.netlifyredirects Update .netlifyredirects Nov 26, 2018
.remarkignore Updated linting and added spellchecking (#73) Dec 6, 2018
.remarkrc.js Updated linting and added spellchecking (#73) Dec 6, 2018
.template-lintrc.js Convert cli-guides to be a single repo project (#28) Nov 10, 2018
.travis.yml Change travis.yml to use Node 8 like the ember.js guides Dec 6, 2018
.watchmanconfig Convert cli-guides to be a single repo project (#28) Nov 10, 2018
CONTRIBUTING.md lint/remark frail (#80) Dec 13, 2018
README.md lint/remark frail (#80) Dec 13, 2018
ember-cli-build.js Convert cli-guides to be a single repo project (#28) Nov 10, 2018
package-lock.json lint/remark frail (#80) Dec 13, 2018
package.json Remove ember-welcome depedency Dec 15, 2018
testem.js Convert cli-guides to be a single repo project (#28) Nov 10, 2018

README.md

Ember CLI guides

Build Status

This repository holds the guides and tutorials for the Ember CLI, a powerful tool that helps you create, develop, and build an Ember app.

To contribute to the API documentation itself, which lists properties and methods used by addons and apps, instead visit Ember CLI, where the API docs are managed as code comments within the codebase.

This project replaces, updates, and adds to the content historically hosted at https://ember-cli.com/.

Looking for repositories for the other parts of emberjs.com? Check out guides-source, website, ember-api-docs, super-rentals tutorial, statusboard, deprecation-app, and styleguide.

Prerequisites

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

Local Development

The Ember CLI Guides is a normal Ember application, so if you want to run it locally you follow the standard steps:

  • Clone this repository
  • cd cli-guides-source
  • npm install
  • ember serve
  • Visit your app at http://localhost:4200.

If you then edit the Markdown files located in the guides/ folder your application should live-update with the content changes.

To run the tests you can run npm run lint:md and npm test in your terminal. npm run lint:md will spellcheck and enforce consistency in the Markdown files. npm test will run Ember tests that have been setup and also scripts that check the Markdown files links.

Markdown linting (lint:md) must pass otherwise it will fail in Travis-CI. Spellchecking uses a custom ember-dictionary with words and terms common to the Ember community, such as SemVer. Words and terms that are associated with a specific guide can be placed in the .local.dic dictionary file. Create a pull request if a word needs to be added to ember-dictionary.

How this app works

The guides content is in the form of Markdown files in the 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, a static site generator created in Ember.

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. If you're new to writing Markdown, follow this cheat sheet.

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.

Adding more things to the table of contents

See pages.yaml in the cli-guides-source. Whatever has a URL of index will be shown for the top level path, like /tutorial/. There must be an index.md under each topic.

Deploying

This app has CI/CD in place, which automatically deploys the contents of the master branch. It is hosted on the Ember Learning org's Netlify account.