Touch up quickstart (#358)

ember-learn · Apr 12, 2019 · 15f0559 · 15f0559
1 parent 8bceb98
commit 15f0559
Show file tree

Hide file tree

Showing 12 changed files with 134 additions and 125 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Ember CLI Addon Docs
+# Ember CLI AddonDocs
 
 [![npm version](https://img.shields.io/npm/v/ember-cli-addon-docs.svg?style=flat-square)](http://badge.fury.io/js/ember-cli-addon-docs)
 [![Build Status](https://img.shields.io/travis/ember-learn/ember-cli-addon-docs.svg?style=flat-square)](https://travis-ci.org/ember-learn/ember-cli-addon-docs)

diff --git a/addon/components/docs-svg-icon/component.js b/addon/components/docs-svg-icon/component.js
@@ -2,7 +2,7 @@ import Component from '@ember/component';
 import layout from './template';
 
 /**
-  The standard icon class used in addon docs
+  The standard icon class used in AddonDocs
 
   @class DocsSvgIcon
   @public

diff --git a/addon/components/docs-viewer/component.js b/addon/components/docs-viewer/component.js
@@ -6,7 +6,7 @@ import { on } from '@ember/object/evented';
 import { formElementHasFocus } from '../../keyboard-config';
 
 /**
-  The main docs viewer component for Ember-CLI addon docs. This component must be placed
+  The main docs viewer component for EmberCLI AddonDocs. This component must be placed
 
 
   ```hbs

diff --git a/sandbox/app/components/yuidoc-component.js b/sandbox/app/components/yuidoc-component.js
@@ -20,7 +20,7 @@ let YUIDocComponent = Component.extend({
     @argument count
     @type number
   */
- count: 0,
+  count: 0,
 
   /**
     An action that sends on events

diff --git a/tests/dummy/app/index.html b/tests/dummy/app/index.html
@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>Ember CLI Addon Docs</title>
+    <title>Ember CLI AddonDocs</title>
     <meta name="description" content="">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 

diff --git a/tests/dummy/app/pods/docs/deploying/template.md b/tests/dummy/app/pods/docs/deploying/template.md
@@ -1,14 +1,14 @@
 # Deploying
 
-Deploying your documentation site can involve a lot of moving parts, but Ember CLI Addon Docs aims to streamline as much of the process as possible by providing a set of out-of-the-box conventions for deploying to GitHub Pages.
+Deploying your documentation site can involve a lot of moving parts, but Ember CLI AddonDocs aims to streamline as much of the process as possible by providing a set of out-of-the-box conventions for deploying to GitHub Pages.
 
 Once everything is set up, you'll be able to visit <u>https://**[user]**.github.io/**[repo]**</u> to see the docs for the latest release of your addon, and your CI builds will automatically keep it up to date.
 
 ## Deploying your docs site
 
 To deploy your docs site to GitHub pages, you'll need to go through a few steps of first-time setup:
 
-1.  Run `ember g ember-cli-addon-docs` to set up the relevant deploy plugins (this is done automatically if you used `ember install` to install Addon Docs)
+1.  Run `ember g ember-cli-addon-docs` to set up the relevant deploy plugins (this is done automatically if you used `ember install` to install AddonDocs)
 2.  Set [the `repository` field](https://docs.npmjs.com/files/package.json#repository) of your `package.json`.
 3.  Commit any outstanding changes you've got on your current branch and push them to GitHub.
 4.  Run `ember deploy production` and answer "yes" if prompted to create a `gh-pages` branch. **Note**: if your repo already has a `gh-pages` branch, you may want to manually archive the existing content there before deploying.
@@ -38,7 +38,7 @@ If you were to make a change to your dummy app and run `ember deploy production`
 
 ## Versioning your content
 
-Whenever you deploy your documentation site with Addon Docs, it places the compiled application in a subdirectory based on the current state of your git repository. All of this behavior [is customizable](#customizing-deploys), but we expect the out-of-the-box configuration should be a good place to get started.
+Whenever you deploy your documentation site with AddonDocs, it places the compiled application in a subdirectory based on the current state of your git repository. All of this behavior [is customizable](#customizing-deploys), but we expect the out-of-the-box configuration should be a good place to get started.
 
 ### Tag deploys
 
@@ -107,7 +107,7 @@ stages:
 
 ## Customizing deploys
 
-When you install Addon Docs, a `config/addon-docs.js` file will automatically be created for you that looks something like this:
+When you install AddonDocs, a `config/addon-docs.js` file will automatically be created for you that looks something like this:
 
 ```js
 const AddonDocsConfig = require('ember-cli-addon-docs/lib/config');
@@ -145,7 +145,7 @@ If instead, however, you want to [set up a CNAME for your project](https://help.
 
 ### `getPrimaryBranch()`
 
-This method determines what Addon Docs considers to be your primary branch, which is where links such as "edit this page" will point. By default, this branch is `master`, but you can override this method to choose a different branch instead, e.g. `develop`.
+This method determines what AddonDocs considers to be your primary branch, which is where links such as "edit this page" will point. By default, this branch is `master`, but you can override this method to choose a different branch instead, e.g. `develop`.
 
 ## Removing a deployed version
 

diff --git a/tests/dummy/app/pods/docs/index/template.md b/tests/dummy/app/pods/docs/index/template.md
@@ -1,10 +1,10 @@
-# What is Addon Docs?
+# What is AddonDocs?
 
 Welcome addon author!
 
 This project was created to help you document and showcase your addon using the accumulated knowledge of the addon community. After surveying several popular project sites we saw that they had much in common, though addon authors have had no easy way to share these techniques.
 
-The app you're currently viewing is itself an example of an addon documented using Ember CLI Addon Docs (it is a fortunate dog-fooding position that we find ourselves in). This Ember application employs our thinking on best practices for layout, typography and design, and uses several features like
+The app you're currently viewing is itself an example of an addon documented using Ember CLI AddonDocs (it is a fortunate dog-fooding position that we find ourselves in). This Ember application employs our thinking on best practices for layout, typography and design, and uses several features like
 
 - Support for authoring pages in Markdown (this very page being an example – click *Edit this page* below to view the source)
 - Interactive {{#docs-link 'docs.components.docs-hero'}}component demos{{/docs-link}}

diff --git a/tests/dummy/app/pods/docs/patterns/template.md b/tests/dummy/app/pods/docs/patterns/template.md
@@ -58,17 +58,17 @@ Typography choices were made primarily for readability. Measure, a typographic t
 
 ## Versioning your docs
 
-Addon Docs provides versioned guides out of the box. You can see the version selector in the top-right part of this page. This is provided by the `<docs-header>` component, so your site will get this too assuming you use this component.
+AddonDocs provides versioned guides out of the box. You can see the version selector in the top-right part of this page. This is provided by the `<docs-header>` component, so your site will get this too assuming you use this component.
 
-If you look at the [`gh-pages`](https://github.com/ember-learn/ember-cli-addon-docs/tree/gh-pages) branch you'll see that this is where versioned builds of your docs app are stored. Versions are created at deploy time and Addon Docs manages this branch of your repository for you.
+If you look at the [`gh-pages`](https://github.com/ember-learn/ember-cli-addon-docs/tree/gh-pages) branch you'll see that this is where versioned builds of your docs app are stored. Versions are created at deploy time and AddonDocs manages this branch of your repository for you.
 
 New versions are created when a new tag is released. There is also a `master` version updated on every deployed commit, and a `Latest` alias that points to the most recent tag, unless it is force-updated to point to `master`.
 
 See the next section on {{docs-link 'deploy guides' 'docs.deploying'}} for more information about deploys.
 
 ## Hosting on GitHub Pages
 
-Addon Docs is built for open-source addons deploying their docs sites to GitHub Pages. Once you have this set up, you can even automate deployment as part of your Travis CI builds.
+AddonDocs is built for open-source addons deploying their docs sites to GitHub Pages. Once you have this set up, you can even automate deployment as part of your Travis CI builds.
 
 For more details, see the {{docs-link 'Deploying' 'docs.deploying'}} section of the guides.
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ import { on } from '@ember/object/evented'; @@
     import { formElementHasFocus } from '../../keyboard-config';
     /**
-      The main docs viewer component for Ember-CLI addon docs. This component must be placed
+      The main docs viewer component for EmberCLI AddonDocs. This component must be placed
       ```hbs
@@ Expand Down @@