Project

General

Profile

Actions
Copy link

coordination #50507

open

[qe-core][functional][saga] document lib/ functions

Added by jorauch about 5 years ago. Updated over 1 year ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Enhancement to existing tests
Target version:
SUSE QA - Milestone 31
Start date:
2019-05-08
Due date:
% Done:

75%

Estimated time:
(Total: 0.00 h)
Difficulty:

Description

Motivation

As we currently have no documentation for the functions in lib/ we need a mechanism to automatically generate it from POD inside the files.

Further details

The team decided to apply the best practices described in https://www.perl.com/pub/2005/07/14/bestpractices.html/

Hide closed

Checklist

  • enable gh-pages on os-autoinst-distri-opensuse
  • adapt travis to create and deploy documentation to gh-pages
  • write documentation for each lib/ function
  • fancy up the html output
  • document the gh-pages in the wiki, maybe crosslink in open.qa

Subtasks 36 (2 open — 34 closed)

coordination #50510: [qe-core][functional][epic] write documentation for lib/ functionsNew2019-05-20

Actions
action #51644: [functional][u] write documentation for lib/susedistributionResolvedjorauch2019-05-20

Actions
action #51647: [functional][u] write documentation for lib/known_bugsResolvedjorauch2019-05-20

Actions
action #54671: [sle][functional] write documentation for lib/version_utilsResolvedjorauch2019-07-26

Actions
action #54677: [sle][functional] write documentation for opensusebasetestResolveddheidler2019-07-26

Actions
action #56156: [functional][u] write documentation for lib/Utils/Architectures.pmResolvedzluo2019-08-30

Actions
action #56258: [functional][u] write documentation for lib/autofs_utils.pmResolvedzluo2019-09-02

Actions
action #57038: [sle][functional] write documentation for lib/suseconnect_register.pmResolvedzluo2019-09-18

Actions
action #57062: [sle][functional] write documentation for lib/apachetest.pmResolvedzluo2019-09-18

Actions
action #57128: [sle][functional] write documentation for lib/autofs_test.pmResolvedzluo2019-09-20

Actions
action #57209: [sle][functional][u] write documentation for lib/repo_tools.pmResolvedzluo2019-09-23

Actions
action #57302: [sle][functional][u] write documentation for lib/autoyast.pmResolvedzluo2019-09-24

Actions
action #57332: [sle][functional][u]write documentation for lib/rescuecdstep.pmResolvedzluo2019-09-25

Actions
action #57365: [sle][functional][u] write documentation for lib/service_check.pmResolvedzluo2019-09-25

Actions
action #57428: [sle][functional][u] write documentation for lib/s390base.pmResolvedzluo2019-09-26

Actions
action #57449: [sle][functional][u] extend and correct documentation for lib/data_integrity_utils.pmResolvedzluo2019-09-27

Actions
action #57458: [sle][functional][u] correct documentation for lib/network_utils.pmResolvedzluo2019-09-27

Actions
action #57518: [sle][functional][u] extend and correct documentation for lib/xml_utils.pmResolvedzluo2019-09-30

Actions
action #57566: [sle][functional][u] extend documentation for lib/y2lan_restart_common.pmResolvedzluo2019-10-01

Actions
action #57572: [functional][u] write doc for lib/networkdbase.pmResolveddheidler2019-10-01

Actions
action #57581: [functional][u] write doc for lib/thunderbird_common.pmResolveddheidler2019-10-01

Actions
action #57740: [sle][functional][u] write documentation for lib/bootloader_spvm.pmResolvedzluo2019-10-07

Actions
action #57752: [sle][functional][u] write documentation for lib/partition_setupResolvedjorauch2019-10-07

Actions
action #57761: [sle][functional][u] Extend documentation for lib/power_action_utils.pmResolvedzluo2019-10-07

Actions
action #57800: [sle][functional][u] extend documentation for lib/y2_module_basetest.pmResolvedzluo2019-10-08

Actions
action #57824: [sle][functional][u] correct and extend documentation for lib/y2_module_guitest.pmResolvedzluo2019-10-09

Actions
action #57839: [sle][functional][u] correct documentation for lib/yast2_widget_utils.pmResolvedzluo2019-10-09

Actions
action #57917: [sle][functional][u] extend documentation for lib/partition_setup.pmResolvedzluo2019-10-10

Actions
action #58136: [functional][u] write documentation for lib/x11utilsResolvedjorauch2019-10-14

Actions
action #58142: [functional][u] write documentation for lib/y2snapper_common.pmResolvedzluo2019-10-14

Actions
action #58190: [functional][u] document lib/web_browserResolvedjorauch2019-10-15

Actions
action #58202: [functional][u] write documentation for lib/y2_mm_common.pmResolvedzluo2019-10-15

Actions
action #58271: [functional][u] Write documentation for lib/xen.pmResolvedzluo2019-10-16

Actions
action #50519: [functional][u] extend utils documentation to all lib/functionsResolvedzluo2019-05-21

Actions
action #51272: [functional][u] fix travis deployment conditionResolveddheidler2019-05-08

Actions
action #51413: [qe-core][functional] Automatic checks for missing documentation in /libNew

Actions

Related issues 1 (0 open — 1 closed)

Related to openQA Tests - action #30862: [functional][u] render documentation of lib/utils Resolvedjorauch2018-01-26

Actions
Actions
Copy link

Also available in: Atom PDF