You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2016/01/15 00:54:41 UTC
[1/2] docs commit: Minor formatting and wording changes.
Repository: cordova-docs
Updated Branches:
refs/heads/master b01716c36 -> 59827c2c5
Minor formatting and wording changes.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/14dda36d
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/14dda36d
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/14dda36d
Branch: refs/heads/master
Commit: 14dda36d6920eb8896474fa8fe267ecdad2b6cc9
Parents: b01716c
Author: Dmitry Blotsky <dm...@gmail.com>
Authored: Thu Jan 14 14:27:38 2016 -0800
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Thu Jan 14 14:27:38 2016 -0800
----------------------------------------------------------------------
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/14dda36d/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 69e5d0a..24287f1 100644
--- a/README.md
+++ b/README.md
@@ -46,11 +46,12 @@ Verify the installation by running:
ruby --version
## Python
-To build cordova-docs, the python version 2.7 must be used. cordova-docs is incompatible with python 3.
+
+Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.*
### Mac OS X
-Mac OS X comes with the python 2.7 pre-installed. Else, Follow these steps:
+Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps:
1. Download [this installer][python_installer_mac] from [this page][python_downloads].
2. Run the downloaded file.
@@ -66,8 +67,7 @@ Follow these steps:
### Linux
-The latest version of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu come with python 2.7 pre-installed.
-Else, follow the steps from [this site][python_linux].
+The latest version of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu come with Python 2.7 pre-installed. Else, follow the steps from [this site][python_linux].
***
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[2/2] docs commit: Adding docs to gulpfile and removing debug code
from Makefile.
Posted by db...@apache.org.
Adding docs to gulpfile and removing debug code from Makefile.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/59827c2c
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/59827c2c
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/59827c2c
Branch: refs/heads/master
Commit: 59827c2c513acbf60c483cb3789e56d661f05d65
Parents: 14dda36
Author: Dmitry Blotsky <dm...@gmail.com>
Authored: Thu Jan 14 15:50:16 2016 -0800
Committer: Dmitry Blotsky <dm...@gmail.com>
Committed: Thu Jan 14 15:54:24 2016 -0800
----------------------------------------------------------------------
Makefile | 16 ------------
gulpfile.js | 76 ++++++++++++++++++++++++++++++++++++++++++--------------
2 files changed, 58 insertions(+), 34 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/59827c2c/Makefile
----------------------------------------------------------------------
diff --git a/Makefile b/Makefile
index 92527cb..5779aae 100644
--- a/Makefile
+++ b/Makefile
@@ -128,20 +128,6 @@ help usage default:
@echo " NODOCS: (defined or undefined) - excludes docs from build"
@echo ""
-debug:
- @echo "LATEST_DOCS_VERSION: " $(LATEST_DOCS_VERSION)
- @echo ""
- @echo "OS: " $(OS)
- @echo ""
- @echo "SCSS_SRC: " $(SCSS_SRC)
- @echo ""
- @echo "STYLES_SRC: " $(STYLES_SRC)
- @echo ""
- @echo "TOC_FILES: " $(TOC_FILES)
- @echo ""
- @echo "MKDIRP: " $(MKDIRP)
- @echo ""
-
data: $(TOC_FILES) $(LANGUAGES_DATA)
configs: $(DEFAULTS_CONFIG) $(VERSION_CONFIG)
styles: $(STYLES)
@@ -149,11 +135,9 @@ plugins: $(PLUGINS_APP)
dev: JEKYLL_CONFIGS += $(DEV_CONFIG)
dev: JEKYLL_FLAGS += --trace
-dev: DEBUG = 1
prod: JEKYLL_CONFIGS += $(PROD_CONFIG)
prod: JEKYLL_FLAGS +=
-prod: DEBUG =
dev prod: build
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/59827c2c/gulpfile.js
----------------------------------------------------------------------
diff --git a/gulpfile.js b/gulpfile.js
index eed3ce0..7729aa2 100644
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -53,11 +53,11 @@ var PLUGINS_FILE_NAME = "plugins.js";
var PLUGINS_FILE = path.join(JS_DIR, PLUGINS_FILE_NAME);
var PLUGINS_SRC_FILE = path.join(PLUGINS_SRC_DIR, "app.js");
-var DEFAULT_CONFIGS = [CONFIG_FILE, DEFAULTS_CONFIG_FILE, VERSION_CONFIG_FILE];
-var DEV_CONFIGS = [DEV_CONFIG_FILE];
-var PROD_CONFIGS = [PROD_CONFIG_FILE];
-var DEV_FLAGS = ["--trace"];
-var PROD_FLAGS = [];
+var BASE_CONFIGS = [CONFIG_FILE, DEFAULTS_CONFIG_FILE, VERSION_CONFIG_FILE];
+var DEV_CONFIGS = [DEV_CONFIG_FILE];
+var PROD_CONFIGS = [PROD_CONFIG_FILE];
+var DEV_FLAGS = ["--trace"];
+var PROD_FLAGS = [];
var BASE_URL = "";
var YAML_FRONT_MATTER = "---\n---\n";
@@ -103,7 +103,7 @@ function getJekyllExecutable() {
}
function getJekyllConfigs() {
- var configs = DEFAULT_CONFIGS;
+ var configs = BASE_CONFIGS;
// add build-specific config files
if (gutil.env.prod) {
@@ -131,6 +131,51 @@ function jekyllBuild(done) {
}
// tasks
+gulp.task("default", ["help"]);
+
+gulp.task("help", function () {
+ gutil.log("");
+ gutil.log("Tasks:");
+ gutil.log("");
+ gutil.log(" build same as configs + styles + plugins + jekyll");
+ gutil.log(" jekyll build with jekyll");
+ gutil.log(" regen same as jekyll + reload");
+ gutil.log(" serve build the site and open it in a browser");
+ gutil.log(" reload refresh the browser");
+ gutil.log("");
+ gutil.log(" plugins build " + PLUGINS_FILE);
+ gutil.log("");
+ gutil.log(" configs create all the below files");
+ gutil.log(" defaults create " + DEFAULTS_CONFIG_FILE);
+ gutil.log(" languages create " + LANGUAGES_FILE);
+ gutil.log(" version create " + VERSION_CONFIG_FILE);
+ gutil.log(" toc create all generated ToC files in " + TOC_DIR);
+ gutil.log("");
+ gutil.log(" styles compile all the below files");
+ gutil.log(" less compile all .less files");
+ gutil.log(" sass compile all .scss files");
+ gutil.log(" css copy over all .css files");
+ gutil.log("");
+ gutil.log(" watch serve + then watch all source files and regenerate as necessary");
+ gutil.log("");
+ gutil.log(" link-bugs replace CB-XXXX references with nice ");
+ gutil.log("");
+ gutil.log(" newversion create a new docs version from current dev version");
+ gutil.log(" --version the new version number (must be greater than the current latest version)");
+ gutil.log(" --language only increment the version for the given language");
+ gutil.log("");
+ gutil.log(" help show this text");
+ gutil.log(" clean remove all generated files and folders");
+ gutil.log("");
+ gutil.log("Arguments:");
+ gutil.log(" --nodocs don't generate docs");
+ gutil.log(" --prod build for production; without it, will build dev instead");
+ gutil.log("");
+});
+
+gulp.task("configs", ["toc", "languages", "defaults", "version"]);
+gulp.task("styles", ["less", "css", "sass"]);
+
gulp.task("watch", ["serve"], function () {
gulp.watch(
[
@@ -184,15 +229,15 @@ gulp.task("serve", ["build"], function () {
});
});
-gulp.task("gen-full", ["configs", "styles", "plugins"], function (done) {
+gulp.task("build", ["configs", "styles", "plugins"], function (done) {
jekyllBuild(done);
});
-gulp.task("gen-only", function (done) {
+gulp.task("jekyll", function (done) {
jekyllBuild(done);
});
-gulp.task("regen", ["gen-only"], function () {
+gulp.task("regen", ["jekyll"], function () {
browsersync.reload();
});
@@ -278,24 +323,19 @@ gulp.task("plugins", function() {
return stream
.pipe(gulp.dest(JS_DIR.replace(SOURCE_DIR, gutil.env.outDir)))
.pipe(browsersync.reload({stream: true}))
+
// NOTE:
- // adding YAML front matter at the end
- // so that uglify doesn't screw it up
+ // adding YAML front matter after doing everything
+ // else so that uglify doesn't screw it up
.pipe(header(YAML_FRONT_MATTER))
- // WORKAOUND:
+ // WORKAROUND:
// minified JS has some things that look like
// Liquid tags, so we replace them manually
.pipe(replace("){{", "){ {"))
.pipe(gulp.dest(JS_DIR));
});
-// compound tasks
-gulp.task("configs", ["toc", "languages", "defaults", "version"]);
-gulp.task("styles", ["less", "css", "sass"]);
-gulp.task("build", ["gen-full"]);
-gulp.task("default", ["serve"]);
-
// convenience tasks
gulp.task("link-bugs", function (done) {
exec(bin("linkify-bugs.sh"), [path.join(SOURCE_DIR, "_posts")], done);
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org