Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-640: 

- Adding component documentation to website.
- Current approach requires manually copying component docs into dist. This still needs to be automated.
This commit is contained in:
Matt Gilman 2015-05-29 08:16:11 -04:00
parent 7f4e3d8afc
commit e2eb6f7c09
8 changed files with 34 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
nifi-site/Gruntfile.js
View File

@ -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']);

6
nifi-site/src/includes/topbar.hbs
View File

@ -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">

7
nifi-site/src/pages/html/administrator-guide.hbs
View File

@ -1,7 +0,0 @@
---
title: Apache NiFi Administrator Guide
---
<div class="external-guide">
<iframe src="docs/administration-guide.html"></iframe>
</div>

2
nifi-site/src/pages/html/developer-guide.hbs
View File

@ -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>

7
nifi-site/src/pages/html/docs.hbs Normal file
View File

@ -0,0 +1,7 @@
---
title: Apache NiFi Documentation
---
<div class="external-guide">
<iframe src="docs/nifi-docs/index.html"></iframe>
</div>

7
nifi-site/src/pages/html/overview.hbs
View File

@ -1,7 +0,0 @@
---
title: Apache NiFi Overview
---
<div class="external-guide">
<iframe src="docs/overview.html"></iframe>
</div>

7
nifi-site/src/pages/html/rest-api.hbs
View File

@ -1,7 +0,0 @@
---
title: Apache NiFi Rest Api
---
<div class="external-guide">
<iframe src="docs/rest-api/index.html"></iframe>
</div>

7
nifi-site/src/pages/html/user-guide.hbs
View File

@ -1,7 +0,0 @@
---
title: Apache NiFi User Guide
---
<div class="external-guide">
<iframe src="docs/user-guide.html"></iframe>
</div>