Project

General

Profile

action #43793

Add all os-autoinst documentation to http://open.qa/documentation

Added by mkittler over 2 years ago. Updated 11 months ago.

Status:
Workable
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2018-11-14
Due date:
% Done:

0%

Estimated time:
Difficulty:

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

  1. No additional documentation needs to be written

Suggestions

History

#1 Updated by okurz over 2 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.

#2 Updated by mkittler over 2 years ago

  • Assignee set to mkittler

okurz even better :-)

#3 Updated by mkittler over 2 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

#4 Updated by mkittler almost 2 years ago

  • Assignee deleted (mkittler)

#5 Updated by okurz about 1 year ago

  • Description updated (diff)
  • Status changed from New to Workable
  • Target version set to Ready

#6 Updated by okurz 11 months ago

  • Priority changed from Normal to Low
  • Target version changed from Ready to future

low team capacity

Also available in: Atom PDF