You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/05/29 14:16:43 UTC
incubator-nifi git commit: NIFI-640: - Adding component documentation
to website. - Current approach requires manually copying component docs into
dist. This still needs to be automated.
Repository: incubator-nifi
Updated Branches:
refs/heads/develop 7f4e3d8af -> e2eb6f7c0
NIFI-640:
- Adding component documentation to website.
- Current approach requires manually copying component docs into dist. This still needs to be automated.
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/e2eb6f7c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/e2eb6f7c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/e2eb6f7c
Branch: refs/heads/develop
Commit: e2eb6f7c09abdb0dfd1c0db845f36f6d6c4aff10
Parents: 7f4e3d8
Author: Matt Gilman <ma...@gmail.com>
Authored: Fri May 29 08:16:11 2015 -0400
Committer: Matt Gilman <ma...@gmail.com>
Committed: Fri May 29 08:16:11 2015 -0400
----------------------------------------------------------------------
nifi-site/Gruntfile.js | 49 ++++++++++----------
nifi-site/src/includes/topbar.hbs | 6 +--
.../src/pages/html/administrator-guide.hbs | 7 ---
nifi-site/src/pages/html/developer-guide.hbs | 2 +-
nifi-site/src/pages/html/docs.hbs | 7 +++
nifi-site/src/pages/html/overview.hbs | 7 ---
nifi-site/src/pages/html/rest-api.hbs | 7 ---
nifi-site/src/pages/html/user-guide.hbs | 7 ---
8 files changed, 34 insertions(+), 58 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/Gruntfile.js
----------------------------------------------------------------------
diff --git a/nifi-site/Gruntfile.js b/nifi-site/Gruntfile.js
index 33b2561..bb69dae 100644
--- a/nifi-site/Gruntfile.js
+++ b/nifi-site/Gruntfile.js
@@ -72,28 +72,28 @@ module.exports = function (grunt) {
}
},
copy: {
- generated: {
- files: [{
- expand: true,
- cwd: '../nifi/nifi-docs/target/generated-docs',
- src: ['*.html', 'images/*'],
- dest: 'dist/docs/'
- }, {
- expand: true,
- cwd: '../nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api',
- src: ['target/nifi-web-api-*/docs/rest-api/index.html', 'target/nifi-web-api-*/docs/rest-api/images/*'],
- dest: 'dist/docs/',
- rename: function (dest, src) {
- var path = require('path');
-
- if (src.indexOf('images') > 0) {
- return path.join(dest, 'rest-api/images', path.basename(src));
- } else {
- return path.join(dest, 'rest-api', path.basename(src));
- }
- }
- }]
- },
+// generated: {
+// files: [{
+// expand: true,
+// cwd: '../nifi/nifi-docs/target/generated-docs',
+// src: ['*.html', 'images/*'],
+// dest: 'dist/docs/'
+// }, {
+// expand: true,
+// cwd: '../nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api',
+// src: ['target/nifi-web-api-*/docs/rest-api/index.html', 'target/nifi-web-api-*/docs/rest-api/images/*'],
+// dest: 'dist/docs/',
+// rename: function (dest, src) {
+// var path = require('path');
+//
+// if (src.indexOf('images') > 0) {
+// return path.join(dest, 'rest-api/images', path.basename(src));
+// } else {
+// return path.join(dest, 'rest-api', path.basename(src));
+// }
+// }
+// }]
+// },
dist: {
files: [{
expand: true,
@@ -305,9 +305,10 @@ module.exports = function (grunt) {
grunt.registerTask('img', ['newer:copy']);
grunt.registerTask('css', ['clean:css', 'compass']);
grunt.registerTask('js', ['clean:js', 'concat']);
- grunt.registerTask('generate-docs', ['clean:generated', 'exec:generateDocs', 'exec:generateRestApiDocs', 'copy:generated', 'replace:addGoogleAnalytics', 'replace:moveTearDrop', 'replace:removeVersion']);
+// grunt.registerTask('generate-docs', ['clean:generated', 'exec:generateDocs', 'exec:generateRestApiDocs', 'copy:generated', 'replace:addGoogleAnalytics', 'replace:moveTearDrop', 'replace:removeVersion']);
- grunt.registerTask('build', ['assemble', 'css', 'js', 'img', 'generate-docs', 'copy:dist']);
+ grunt.registerTask('build', ['assemble', 'css', 'js', 'img', 'copy:dist']);
+// grunt.registerTask('build', ['assemble', 'css', 'js', 'img', 'generate-docs', 'copy:dist']);
grunt.registerTask('deploy', ['clean:all', 'prompt:username', 'exec:checkout', 'build', 'exec:status', 'prompt:commit']);
grunt.registerTask('dev', ['default', 'watch']);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/includes/topbar.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/includes/topbar.hbs b/nifi-site/src/includes/topbar.hbs
index 959771c..723365d 100644
--- a/nifi-site/src/includes/topbar.hbs
+++ b/nifi-site/src/includes/topbar.hbs
@@ -28,11 +28,7 @@
<ul class="dropdown">
<li><a href="faq.html">FAQ</a></li>
<li><a href="screencasts.html">Screencasts</a></li>
- <li><a href="overview.html">NiFi Overview</a></li>
- <li><a href="user-guide.html">User Guide</a></li>
- <li><a href="developer-guide.html">Developer Guide</a></li>
- <li><a href="administrator-guide.html">Admin Guide</a></li>
- <li><a href="rest-api.html">Rest Api</a></li>
+ <li><a href="docs.html">NiFi Docs</a></li>
</ul>
</li>
<li class="has-dropdown">
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/administrator-guide.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/administrator-guide.hbs b/nifi-site/src/pages/html/administrator-guide.hbs
deleted file mode 100644
index a58e8d2..0000000
--- a/nifi-site/src/pages/html/administrator-guide.hbs
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Apache NiFi Administrator Guide
----
-
-<div class="external-guide">
- <iframe src="docs/administration-guide.html"></iframe>
-</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/developer-guide.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/developer-guide.hbs b/nifi-site/src/pages/html/developer-guide.hbs
index 690923e..6a2e1c1 100644
--- a/nifi-site/src/pages/html/developer-guide.hbs
+++ b/nifi-site/src/pages/html/developer-guide.hbs
@@ -3,5 +3,5 @@ title: Apache NiFi Developer Guide
---
<div class="external-guide">
- <iframe src="docs/developer-guide.html"></iframe>
+ <iframe src="docs/nifi-docs/html/developer-guide.html"></iframe>
</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/docs.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/docs.hbs b/nifi-site/src/pages/html/docs.hbs
new file mode 100644
index 0000000..3dd95aa
--- /dev/null
+++ b/nifi-site/src/pages/html/docs.hbs
@@ -0,0 +1,7 @@
+---
+title: Apache NiFi Documentation
+---
+
+<div class="external-guide">
+ <iframe src="docs/nifi-docs/index.html"></iframe>
+</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/overview.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/overview.hbs b/nifi-site/src/pages/html/overview.hbs
deleted file mode 100644
index b2eae1c..0000000
--- a/nifi-site/src/pages/html/overview.hbs
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Apache NiFi Overview
----
-
-<div class="external-guide">
- <iframe src="docs/overview.html"></iframe>
-</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/rest-api.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/rest-api.hbs b/nifi-site/src/pages/html/rest-api.hbs
deleted file mode 100644
index 7efb462..0000000
--- a/nifi-site/src/pages/html/rest-api.hbs
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Apache NiFi Rest Api
----
-
-<div class="external-guide">
- <iframe src="docs/rest-api/index.html"></iframe>
-</div>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e2eb6f7c/nifi-site/src/pages/html/user-guide.hbs
----------------------------------------------------------------------
diff --git a/nifi-site/src/pages/html/user-guide.hbs b/nifi-site/src/pages/html/user-guide.hbs
deleted file mode 100644
index 8fa6c7d..0000000
--- a/nifi-site/src/pages/html/user-guide.hbs
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Apache NiFi User Guide
----
-
-<div class="external-guide">
- <iframe src="docs/user-guide.html"></iframe>
-</div>
\ No newline at end of file