From 724bfc3d453fef4d389d039a254c32a9858d9758 Mon Sep 17 00:00:00 2001 From: Liran Tal Date: Sat, 8 Aug 2015 19:09:49 +0300 Subject: [PATCH] fixing typos across documentation in gh-pages --- README.md | 2 +- _includes/docs/0.3.x/angularjsmodules.html | 18 +++++++++--------- _includes/docs/0.3.x/configuration.html | 12 ++++++------ _includes/docs/0.3.x/folderstructure.html | 6 +++--- changelog.html | 4 ++-- generator.html | 22 +++++++++++----------- 6 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 47cb21e60d..34f1e3322c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![MEAN.JS Logo](http://meanjs.org/img/logo-small.png)](http://meanjs.org/) # The Website -This branch of the repository is for the http://meanjs.org/ website which inludes the documentation for the [MEAN.JS Project](https://github.com/meanjs/mean). +This branch of the repository is for the http://meanjs.org/ website which includes the documentation for the [MEAN.JS Project](https://github.com/meanjs/mean). # Testing / Contributing This website uses [Jekyll!](http://jekyllrb.com/) to serve web pages, which means you need to install jekyll on your computer to test it! diff --git a/_includes/docs/0.3.x/angularjsmodules.html b/_includes/docs/0.3.x/angularjsmodules.html index abb07d9347..3e95f42bc9 100644 --- a/_includes/docs/0.3.x/angularjsmodules.html +++ b/_includes/docs/0.3.x/angularjsmodules.html @@ -52,7 +52,7 @@

AngularJS Modules

index.html

- Reorganizing the project this way helped us create bigger projects that are more maintainable in the long term. For a while we had fun using this but lately we found out that wasn’t enough. Now instead of bloating a single JavaScript file, we had pretty big folders containing ~20 controllers, and even more views in the partials folder. + Reorganizing the project this way helped us create bigger projects that are more maintainable in the long term. For a while we had fun using this but lately we found out that wasn't enough. Now instead of bloating a single JavaScript file, we had pretty big folders containing ~20 controllers, and even more views in the partials folder.

Luckily, when the original MEAN.IO boilerplate gained some traction, we got a chance to talk to some great AngularJS developers writing blogs and working on some popular libraries. One of the greatest topics in our conversations was Angular’s modularity. @@ -165,7 +165,7 @@

Vertical Modules Are Better

New Folder Structure

- Using vertical modules only solves half the problem because we still use horizontal approach in our folder structure. This means that all your application controllers will reside in the same folder, as are all the services, directives, filters, and views. In this case you wouldn’t be able to associate a file with its module until you open it. + Using vertical modules only solves half the problem because we still use horizontal approach in our folder structure. This means that all your application controllers will reside in the same folder, as are all the services, directives, filters, and views. In this case you wouldn't be able to associate a file with its module until you open it.

So we converted our application structure to a vertical structure to fit the vertical modular approach: @@ -207,10 +207,10 @@

New Folder Structure

This structure allow clear separation of functionality and concerns, so just by looking at the folder structure you can start asking questions about your modules, for example why does the users module have no tests? (hint: Its our fault and we plan to add those :)).

- But we didn’t want to stop at this point! + But we didn't want to stop at this point!

- Because we are building a full-stack solution, won’t it be great if module files could be automatically included in the backend view HTML, eliminating common import mistakes? We do two things to help with this issue: + Because we are building a full-stack solution, won't it be great if module files could be automatically included in the backend view HTML, eliminating common import mistakes? We do two things to help with this issue:

  1. @@ -256,7 +256,7 @@

    New Folder Structure

ApplicationConfiguration

- While the angular module system is quite robust it lacks a few options, mainly the abiliy to add dependencies to the main module after it was already created. Because of that we use the ApplicationConfiguration object to maintain a list of modules, which the main module will use as depenedencies. If it weren't for the ApplicationConfiguration, you would have to register your module in two place: + While the angular module system is quite robust it lacks a few options, mainly the ability to add dependencies to the main module after it was already created. Because of that we use the ApplicationConfiguration object to maintain a list of modules, which the main module will use as dependencies. If it weren't for the ApplicationConfiguration, you would have to register your module in two place:

  1. @@ -268,7 +268,7 @@

    ApplicationConfiguration

- This can become an annoying pitfull, so we added the ApplicationConfiguration that is loaded before all the modules file. The ApplicationConfiguration global object expose a method named registerModule, this method will create the new angular module and add it to list of dependencies of the main application module. + This can become an annoying pitfall, so we added the ApplicationConfiguration that is loaded before all the modules file. The ApplicationConfiguration global object expose a method named registerModule, this method will create the new angular module and add it to list of dependencies of the main application module.

We recommend that you take a look at the code that is placed inside the /public/config.js file. @@ -279,7 +279,7 @@

Module Structure

- To add a new module, you’ll have to create a new folder in the public/modules folder. The directory structure should look something like this: + To add a new module, you'll have to create a new folder in the public/modules folder. The directory structure should look something like this: 

 |-module 
@@ -303,7 +303,7 @@ 
Module Structure

       
 'use strict';
 
-// Use Applicaion configuration module to register a new module
+// Use Application configuration module to register a new module
 ApplicationConfiguration.registerModule('moduleName');
 

 
@@ -316,7 +316,7 @@ 
Module Tests

         Adding Karma tests is a simple task, and you can follow the Article Example to learn all about it.
       

       

-        But here is another neat feature: loading your module tests is also done automatically! Karam config file will iterate through the module folder and add your new module tests as well. Don't worry! if you haven't written any tests karma will skip your module and just run the tests you already have.
+        But here is another neat feature: loading your module tests is also done automatically! Karma config file will iterate through the module folder and add your new module tests as well. Don't worry! if you haven't written any tests karma will skip your module and just run the tests you already have.
       

       

         Notice: Your test files should be placed in the module/tests folder or else MEAN won't ignore them and add them in the HTML as script files.
diff --git a/_includes/docs/0.3.x/configuration.html b/_includes/docs/0.3.x/configuration.html
index fdd5777162..7881597aeb 100644
--- a/_includes/docs/0.3.x/configuration.html
+++ b/_includes/docs/0.3.x/configuration.html
@@ -83,23 +83,23 @@ 
Assets Configuration

         
         
config.assets.js

         

-          A list of glob patterns idicating the project JavaScript project files.
+          A list of glob patterns indicating the project JavaScript project files.
         

         
config.assets.tests

         

-          A list of glob patterns idicating the project Jasmine test files.
+          A list of glob patterns indicating the project Jasmine test files.
         

         
config.assets.lib

         

-          
A list of glob patterns idicating the project packages files. We seperate those from other files so you could use CDN assets in your production configuration.

+          
A list of glob patterns indicating the project packages files. We separate those from other files so you could use CDN assets in your production configuration.

           

             
config.assets.lib.css

             

-              A list of glob patterns idicating the project packages CSS files.
+              A list of glob patterns indicating the project packages CSS files.
             

             
config.assets.lib.js

             

-              A list of glob patterns idicating the project packages JavaScript files.
+              A list of glob patterns indicating the project packages JavaScript files.
             

           

         

@@ -115,7 +115,7 @@ 
Social Configuration Properties

         MEAN.JS currently supports five social platforms: Facebook, Twitter, Google, Linkedin, and Github. You can also add other platforms using a passport-provider package and duplicating the samples logic.
       

       

-        To configure your social application oauth keys there's a property object for each platform:
+        To configure your social application OAuth keys there's a property object for each platform:
       

       

         
config.app.{OAuth Provider}.clientID

diff --git a/_includes/docs/0.3.x/folderstructure.html b/_includes/docs/0.3.x/folderstructure.html
index f13bbe5658..3a6787f8dc 100644
--- a/_includes/docs/0.3.x/folderstructure.html
+++ b/_includes/docs/0.3.x/folderstructure.html
@@ -80,7 +80,7 @@ 
env

         
  • 
           
    strategies
    
           Autoloaded 
-          
    The strategies folder contains the startegies configuration files loaded by the passport.js file.
+          
    The strategies folder contains the strategies configuration files loaded by the passport.js file.
           
    
             When to use:
             Whenever you want to add, change, or remove a Passport Strategy.
@@ -100,7 +100,7 @@ 
    express.js
    
         
    • 
         
  • 
           
    init.js
    
-          The initialization file that set up a few project related configuraiton.
+          The initialization file that set up a few project related configuration.
         
    • 
         
  • 
           
    passport.js
    
@@ -141,7 +141,7 @@ 
    config.js
    
             
    
               This method is used to register a module as a new module and add it to the main module dependencies.
               
    
-                Although you don't have to, it is highly recommended that you use registerModule method to reigster your module as a dependency for the main application module. To understand this better please visit the AngularJS Modules section.
+                Although you don't have to, it is highly recommended that you use registerModule method to register your module as a dependency for the main application module. To understand this better please visit the AngularJS Modules section.
               
    
             
    
           
    • 
diff --git a/changelog.html b/changelog.html
index b14a02865e..8777e7dadc 100644
--- a/changelog.html
+++ b/changelog.html
@@ -68,7 +68,7 @@ 
    Major Release Changes
    
   
  • Added CSS Linting and created grunt lint task.
    • 
   
  • Added CSSMin and Uglify tasks wrapped in a grunt build task for production support.
    • 
   
  • Created environmental assets management.
    • 
-  
  • Introduced new Menus service that offers better menus managment.
    • 
+  
  • Introduced new Menus service that offers better menus management.
    • 
   
  • Added roles to the User model.
    • 
   
  • Updated the Yo Generator to support new structure and features.
    • 
 
@@ -150,7 +150,7 @@ 
    Design Changes
    
     Bootstrap 3.0.3 support.
   
   
  • 
-    Views redesigned to support reponsive behaviour.
+    Views redesigned to support responsive behavior.
   
    • 
 
 
    AngularJS Module Changes
    
diff --git a/generator.html b/generator.html
index 545ef4266e..6a41e15079 100644
--- a/generator.html
+++ b/generator.html
@@ -119,7 +119,7 @@ 
    CRUD Module Sub-Generator
    
       
    The CRUD module sub-generator will help you create a new CRUD module, similar to the article sample provided with the project. To create a new CRUD module you will need to use yo again:

    
       
    $ yo meanjs:crud-module <module-name>

    
       
    This will create both AngularJS and Express files supporting full CRUD functionality, and add the Karma and Mocha tests.
    
-      
    Note: Don’t forget to use your module name as an argument when calling the CRUD module sub-generator.
    
+      
    Note: don't forget to use your module name as an argument when calling the CRUD module sub-generator.
    
     
     
     
    
@@ -135,7 +135,7 @@ 
    AngularJS Module Sub-Generator
    
       
    AngularJS Route Sub-Generator
    
     
    
     
    
-      
    To construct your module you will often need to create a new route. The AngularJS route sub-generator will help you create a view, controller and a proper route in your module routes.js file. If it can’t find the module routes file the sub-generator will create one for you. Creating a new AngularJS route will involve executing this command:
     
    
+      
    To construct your module you will often need to create a new route. The AngularJS route sub-generator will help you create a view, controller and a proper route in your module routes.js file. If it can't find the module routes file the sub-generator will create one for you. Creating a new AngularJS route will involve executing this command:
     
    
       
    $ yo meanjs:angular-route <route-name>

    
       
    The sub-generator will ask for more information about your controller, view and routing URL, and will generate the appropriate files for you.
    
     
    
@@ -147,16 +147,16 @@ 
    AngularJS Controller Sub-Generator
    
       
    The AngularJS Controller sub-generator will create a new AngularJS controller in the specified module's controllers folder. To create a new AngularJS controller run yo again by using this command:

    
       
    $ yo meanjs:angular-controller <controller-name>

    
       
    The sub-generator will ask you for the module name under which you would like to create your new controller, and will create a new AngularJS controller file in that module controllers folder and a controller test in the module tests folder.
    
-      
    Don’t forget! This time you pass the controller name as an argument. 
    
+      
    Don't forget! This time you pass the controller name as an argument. 
    
     
     
     
    
       
    AngularJS View Sub-Generator
    
     
    
     
    
-      
    Once you have your controller file ready, you may want to add a view that makes use of this controller. The AngularJS view sub-generator will create a new AngularJS view in thr specified module's views folder, and will allow you to add a route definition for it. To create a new AngularJS view you will need to execute this command:

    
+      
    Once you have your controller file ready, you may want to add a view that makes use of this controller. The AngularJS view sub-generator will create a new AngularJS view in the specified module's views folder, and will allow you to add a route definition for it. To create a new AngularJS view you will need to execute this command:

    
       
    $ yo meanjs:angular-view <view-name>

    
-      
    The sub-generator will ask you for the module name under which you would like to create your new view, and some additional routing information. It will then create a new view file in that module's views folder and add a routing state to the module routes.js file. If it can’t find the module routes file it will create one for you.
    
+      
    The sub-generator will ask you for the module name under which you would like to create your new view, and some additional routing information. It will then create a new view file in that module's views folder and add a routing state to the module routes.js file. If it can't find the module routes file it will create one for you.
    
     
    
     
     
    
@@ -199,10 +199,10 @@ 
    AngularJS Config Sub-Generator
    
       
    AngularJS Test Sub-Generator
    
     
    
     
    
-      
    Your MEAN application comes pre-bundled with the Karma test runner and Jasmine testing framework. To test your AngularJS controllers you’ll need to create a test file, which Karma will later use to run the tests. For this purpose we provided you with the AngularJS test sub-generator. Creating a new AngularJS test is effortless, just execute this command:

    
+      
    Your MEAN application comes pre-bundled with the Karma test runner and Jasmine testing framework. To test your AngularJS controllers you'll need to create a test file, which Karma will later use to run the tests. For this purpose we provided you with the AngularJS test sub-generator. Creating a new AngularJS test is effortless, just execute this command:

    
       
    $ yo meanjs:angular-test <controller-name>

    
-      
    This will create a test file for your controller, and if the sub-generator doesn’t find the specified controller file, it will create one for you.
    
-      
    Don’t forget! You're suppose to pass the controller name as an argument. 
    
+      
    This will create a test file for your controller, and if the sub-generator doesn't find the specified controller file, it will create one for you.
    
+      
    Don't forget! You're suppose to pass the controller name as an argument. 
    
     
    
     
     
    
@@ -237,10 +237,10 @@ 
    Express Routes Sub-Generator
    
       
    Express Test Sub-Generator
    
     
    
     
    
-      
    Your MEAN application comes pre-bundled with the Mocha testing framework. To test your Express models you’ll need to create a new test file, which Mocha will use while running tests. For this purpose we provided you with the Express test sub-generator. Creating a new Express test is easy, just execute this command:

    
+      
    Your MEAN application comes pre-bundled with the Mocha testing framework. To test your Express models you'll need to create a new test file, which Mocha will use while running tests. For this purpose we provided you with the Express test sub-generator. Creating a new Express test is easy, just execute this command:

    
       
    $ yo meanjs:express-test <model-name>

    
-      
    This will create a test file for your Express model, and if the sub-generator doesn’t find the specified model, it will create one for you.
    
-      
    Don’t forget! You're suppose to pass the model name as an argument. 
    
+      
    This will create a test file for your Express model, and if the sub-generator doesn't find the specified model, it will create one for you.
    
+      
    Don't forget! You're suppose to pass the model name as an argument. 
    
     
    
   
 
\ No newline at end of file