This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
[RAINCATCH 1399] Docs improvements #152
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,89 @@ | ||
| var spawn = require('child_process').spawn; | ||
| var yargs = require('yargs'); | ||
| var fs = require('fs'); | ||
| var path = require('path'); | ||
| const spawn = require('child_process').spawn; | ||
| const yargs = require('yargs'); | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const fse = require('fs-extra') | ||
| var ghpages = require('gh-pages'); | ||
| var moment = require('moment'); | ||
| const ghpages = require('gh-pages'); | ||
| const moment = require('moment'); | ||
|
|
||
| var pageRoot = './website'; | ||
| var ascidocsPath = '../docs/workforce-management-framework/upstream-1'; | ||
| var docRoot = path.join(__dirname, ascidocsPath).normalize() | ||
| const pageRoot = './website'; | ||
| const ascidocsPath = '../docs/workforce-management-framework/upstream-1'; | ||
| const docRoot = path.join(__dirname, ascidocsPath).normalize() | ||
|
|
||
| yargs.usage('Usage: $0 <command>') | ||
| .command('asciidocs-build', | ||
| 'Build asciidocs documentation. Requires: asciidoctor', function(yargs) { | ||
| }, asciidocsHandler) | ||
| .command('apidocs-build', 'Copy documentation folder', function(yargs) { | ||
| }, apiHandler) | ||
| .command('publish', 'Publish website to github pages', function(yargs) { | ||
| }, publishHandler) | ||
| .demandCommand() | ||
| .help() | ||
| .argv; | ||
| .command('asciidocs-build', | ||
| 'Build asciidocs documentation. Requires: asciidoctor', function(yargs) { | ||
| }, asciidocsHandler) | ||
| .command('apidocs-build', 'Copy documentation folder', function(yargs) { | ||
| yargs | ||
| .alias('f', 'folder') | ||
| .default('folder', './api') | ||
| }, apiHandler) | ||
| .command('publish', 'Publish website to github pages', function(yargs) { | ||
| }, publishHandler) | ||
| .demandCommand() | ||
| .help() | ||
| .argv; | ||
|
|
||
|
|
||
| function apiHandler(argv) { | ||
| return copyApiFiles(); | ||
| return copyApiFiles(argv); | ||
| } | ||
|
|
||
| function publishHandler(argv) { | ||
| return publishWebsite(); | ||
| return publishWebsite(); | ||
| } | ||
|
|
||
| function asciidocsHandler(argv) { | ||
| return buildAsciDocs(function(err) { | ||
| if (err) { | ||
| console.log("Failed to build ascidocs page", err); | ||
| return process.exit(1); | ||
| } | ||
| console.log("Created documentation file"); | ||
| fse.moveSync(path.join(docRoot, "master.html"), pageRoot + '/docs/index.html', | ||
| { overwrite: true }); | ||
| fse.copySync(path.join(docRoot, "/topics/shared/images"), pageRoot + '/docs/images', | ||
| { overwrite: true }); | ||
| console.log("Documentation copied to website"); | ||
| }); | ||
| return buildAsciDocs(function(err) { | ||
| if (err) { | ||
| console.log("Failed to build ascidocs page", err); | ||
| return process.exit(1); | ||
| } | ||
| console.log("Created documentation file"); | ||
| fse.moveSync(path.join(docRoot, "master.html"), pageRoot + '/docs/index.html', | ||
| { overwrite: true }); | ||
| fse.copySync(path.join(docRoot, "/topics/shared/images"), pageRoot + '/docs/images', | ||
| { overwrite: true }); | ||
| console.log("Documentation copied to website"); | ||
| }); | ||
| } | ||
|
|
||
| function publishWebsite() { | ||
| var options = { | ||
| branch: 'gh-pages', | ||
| remote: 'origin', | ||
| dotfiles: 'true' | ||
| var options = { | ||
| branch: 'gh-pages', | ||
| remote: 'origin', | ||
| dotfiles: 'true' | ||
| } | ||
| ghpages.publish(pageRoot, options, function(err) { | ||
| if (err) { | ||
| return console.error("Page failed to publish", err); | ||
| } | ||
| ghpages.publish(pageRoot, options, function(err) { | ||
| if (err) { | ||
| return console.error("Page failed to publish", err); | ||
| } | ||
| console.info("Page published"); | ||
| }); | ||
| console.info("Page published"); | ||
| }); | ||
| } | ||
|
|
||
| function copyApiFiles() { | ||
| fse.copySync('./api', pageRoot + '/api', { overwrite: true }); | ||
| console.log("Created api documentation"); | ||
| function copyApiFiles(args) { | ||
| const { folder } = args; | ||
| console.log(`Copying file information from ${folder}`) | ||
| fse.copySync(folder, pageRoot + '/api', { overwrite: true }); | ||
| console.log("Created api documentation"); | ||
| }; | ||
|
|
||
| function buildAsciDocs(cb) { | ||
| var args = ['master.adoc']; | ||
| var process = spawn('asciidoctor', args, { cwd: docRoot }); | ||
| process.on('message', function(message) { | ||
| console.info("Asciidocs", message); | ||
| }); | ||
| process.on('error', function(message) { | ||
| console.error("Asciidocs", message); | ||
| }); | ||
| process.on('close', function(status) { | ||
| if (status === 0) { | ||
| cb && cb(); | ||
| } else { | ||
| cb && cb(new Error("Command failed with status " + status)); | ||
| } | ||
| }); | ||
| var args = ['master.adoc']; | ||
| var process = spawn('asciidoctor', args, { cwd: docRoot }); | ||
| process.on('message', function(message) { | ||
| console.info("Asciidocs", message); | ||
| }); | ||
| process.on('error', function(message) { | ||
| console.error("Asciidocs", message); | ||
| }); | ||
| process.on('close', function(status) { | ||
| if (status === 0) { | ||
| cb && cb(); | ||
| } else { | ||
| cb && cb(new Error("Command failed with status " + status)); | ||
| } | ||
| }); | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😍