From c07846a49d101dbac03b69974fd77808899cf9ed Mon Sep 17 00:00:00 2001 From: Andy Joslin Date: Mon, 10 Mar 2014 09:32:13 -0600 Subject: [PATCH] docs(README): add instructions for testing docs --- README.md | 13 ++++++++++++- docs/docs.config.js | 2 +- gulpfile.js | 2 +- js/ext/angular/src/directive/ionicContent.js | 2 +- 4 files changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 712f5aece7..c0bbc613a2 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ For most cases, you'll need AngularJS as well. This is bundled in `js/angular/` * `npm install && npm install -g gulp protractor` to setup * `gulp` or `gulp build` to build -* `gulp docs` to generate docs (they are generated in tmp/ionic-site; clone ionic-site there if you wish to test them). +* `gulp docs` to generate docs (read Documentation below for how to test docs locally). * `gulp build --release` to build with minification & strip debugs * `gulp watch` to watch and rebuild on change * `gulp karma` to test one-time @@ -91,6 +91,17 @@ For most cases, you'll need AngularJS as well. This is bundled in `js/angular/` * `gulp protractor` to test e2e tests locally * `gulp cloudtest` to run e2e tests in the cloud +### Documentation + +* To test documentation, follow these steps: + 1. Clone ionic-site to `./tmp/ionic-site` - this is where the `gulp docs` task builds to. `./tmp` is the folder that travis uses to do all of its tasks. + - `mkdir tmp && git clone git@github.com:driftyco/ionic-site tmp/ionic-site` + 2. Make jekyll rebuild whenever you change the site. + - `cd tmp/ionic-site && jekyll serve -w` + 3. Build the docs + - `gulp docs` + 4. Open localhost:4000 and see your changes! Re-run `gulp docs` again whenever you change something, and jekyll will update the site. + ### Commit Conventions * Uses http://github.com/ajoslin/conventional-changelog conventions diff --git a/docs/docs.config.js b/docs/docs.config.js index 6f448f21b1..3b4595f76d 100644 --- a/docs/docs.config.js +++ b/docs/docs.config.js @@ -10,7 +10,7 @@ module.exports = function(config) { config = basePackage(config); - config.set('logging.level', 'debug'); + config.set('logging.level', 'info'); config.prepend('rendering.templateFolders', [ path.resolve(__dirname, 'templates') diff --git a/gulpfile.js b/gulpfile.js index 1f6421d2ce..c31864fcc9 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -37,7 +37,7 @@ gulp.task('default', ['build']); gulp.task('build', ['bundle', 'sass']); gulp.task('docs', function() { - dgeni('docs/docs.config.js').generateDocs(); + return dgeni('docs/docs.config.js').generateDocs(); }); var IS_WATCH = false; diff --git a/js/ext/angular/src/directive/ionicContent.js b/js/ext/angular/src/directive/ionicContent.js index a905b3e42f..550459c970 100644 --- a/js/ext/angular/src/directive/ionicContent.js +++ b/js/ext/angular/src/directive/ionicContent.js @@ -195,7 +195,7 @@ function($parse, $timeout, $ionicScrollDelegate, $controller, $ionicBind) { * @description * The ionInfiniteScroll directive, when placed inside of {@link ionic.directive:ionContent ionContent}, allows you to call a function whenever the user gets to the bottom of the page or near the bottom of the page. * - * The expression you pass in for `on-scroll` is called when the user scrolls down until he is `distance` away from the bottom of the screen. + * The expression you pass in for `on-infinite` is called when the user scrolls greater than `distance` away from the bottom of the content. * * @param {expression} on-infinite What to call when the scroller reaches the bottom. * @param {string=} distance The distance from the bottom that the scroll must reach to trigger the on-infinite expression. Default 1%.