doc - Manage job documentation

Manage project / title / description for jobs

moa.plugin.system.doc.blog(job, args)

Add an entry to the blog job (Blog.md)

Allows a user to maintain a blog for this job (in Blog.md). Use as follows:

$ moa blog
Enter your blog message (ctrl-d on an empty line to finish)

... enter your message here ..

[ctrl-d]

Note: the ctrl-d needs to be given on an empty line. The text is appended to moa.desciption. In the web interface this is converted to Markdown.

moa.plugin.system.doc.change(job, args)

Add entry to CHANGELOG.md

This function allows the user to add an entry to CHANGELOG.md (including a timestamp). Use it as follows:

$ moa change
Enter your changelog message (ctrl-d on an empty line to finish)

... enter your message here ..

[ctrl-d]

Note: the ctrl-d needs to be given on an empty line. The text is appended to moa.desciption. In the web interface this is converted to Markdown.

Note the same can be achieved by specifying the -m parameter (before the command - for example:

moa -m ‘intelligent remark’ set ...

moa.plugin.system.doc.hook_defineCommands()

Set the moa commands for this plugin

moa.plugin.system.doc.hook_git_finish_blog()

Execute just after setting running moa blog

moa.plugin.system.doc.hook_git_finish_change()

Execute just after setting running moa blog

moa.plugin.system.doc.hook_git_finish_readme()

Execute just after setting running moa readme

moa.plugin.system.doc.readme(job, args)

Edit the README.md file for this job

You could, obviously, also edit the file yourself - this is a mere shortcut to try to stimulate you in maintaining one