Actions
action #43793
openAdd all os-autoinst documentation to http://open.qa/documentation
Start date:
2018-11-14
Due date:
% Done:
0%
Estimated time:
Description
Motivation¶
That idea recently came up when extending the os-autoinst documentation.
Acceptance criteria¶
- AC1: All relevant documentation from the os-autoinst source repository is published and accessible on a common place
Out of scope¶
- No additional documentation needs to be written
Suggestions¶
- Understand how current documentation parts are covered already as mentioned in #43793#note-1
- Also read https://github.com/os-autoinst/openQA/blob/master/tools/generate-documentation
- Try to add the additional documentation, e.g. docs/backend_vars.asciidoc
Updated by okurz almost 6 years ago
I think we misunderstood. http://open.qa/api/testapi/ already includes the POD documentation from the testapi.pm file which is automatically generated and uploaded. Also see targets like https://github.com/os-autoinst/os-autoinst/blob/master/Makefile.am#L156 and especially https://github.com/os-autoinst/openQA/blob/master/script/generate-documentation#L54 calling asciidoctor. The missing parts is generated documentation from the other doc files within the os-autoinst repo.
Updated by mkittler almost 6 years ago
- Subject changed from Add os-autoinst documentation to http://open.qa/documentation to Add all os-autoinst documentation to http://open.qa/documentation
Updated by okurz about 4 years ago
- Description updated (diff)
- Status changed from New to Workable
- Target version set to Ready
Updated by okurz about 4 years ago
- Priority changed from Normal to Low
- Target version changed from Ready to future
low team capacity
Actions