Currently, our directive docs in source code look like this:
module: koji_directive
When rendered, the section is called
koji_directive - short description
And in examples, it is used like this:
- name: download rpms from koji koji: action: download koji_build: ${koji_build} arch: ${arch}
So, we call it koji_directive in many places, but the actual usage is koji:, not koji_directive:. I find that confusing.
koji_directive
koji:
koji_directive:
I'd like to replace this:
with this
directive: koji
And the script would generate html like this:
directive: koji - short description (therefore it would prepend directive: before the name)
directive:
I think it would be much clearer for readers that the directive name is the same as the keyword that they use in the task yaml file. As opposed to our expectation that they'll strip the _directive suffix.
_directive
Alternatively, we could render the docs like:
koji directive - short description I.e. append directive after the directive name. That would be nicer and more readable, I think.
directive
Metadata Update from @kparal: - Issue marked as depending on: #78 - Issue tagged with: easyfix
This is no longer needed with STI-based tasks.
Metadata Update from @kparal: - Issue close_status updated to: Invalid