Project

General

Profile

coordination #50507

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

Added by jorauch over 2 years ago. Updated 6 months 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/


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

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

action #51644: [functional][u] write documentation for lib/susedistributionResolvedjorauch

action #51647: [functional][u] write documentation for lib/known_bugsResolvedjorauch

action #54671: [sle][functional] write documentation for lib/version_utilsResolvedjorauch

action #54677: [sle][functional] write documentation for opensusebasetestResolveddheidler

action #56156: [functional][u] write documentation for lib/Utils/Architectures.pmResolvedzluo

action #56258: [functional][u] write documentation for lib/autofs_utils.pmResolvedzluo

action #57038: [sle][functional] write documentation for lib/suseconnect_register.pmResolvedzluo

action #57062: [sle][functional] write documentation for lib/apachetest.pmResolvedzluo

action #57128: [sle][functional] write documentation for lib/autofs_test.pmResolvedzluo

action #57209: [sle][functional][u] write documentation for lib/repo_tools.pmResolvedzluo

action #57302: [sle][functional][u] write documentation for lib/autoyast.pmResolvedzluo

action #57332: [sle][functional][u]write documentation for lib/rescuecdstep.pmResolvedzluo

action #57365: [sle][functional][u] write documentation for lib/service_check.pmResolvedzluo

action #57428: [sle][functional][u] write documentation for lib/s390base.pmResolvedzluo

action #57449: [sle][functional][u] extend and correct documentation for lib/data_integrity_utils.pmResolvedzluo

action #57458: [sle][functional][u] correct documentation for lib/network_utils.pmResolvedzluo

action #57518: [sle][functional][u] extend and correct documentation for lib/xml_utils.pmResolvedzluo

action #57566: [sle][functional][u] extend documentation for lib/y2lan_restart_common.pmResolvedzluo

action #57572: [functional][u] write doc for lib/networkdbase.pmResolveddheidler

action #57581: [functional][u] write doc for lib/thunderbird_common.pmResolveddheidler

action #57740: [sle][functional][u] write documentation for lib/bootloader_spvm.pmResolvedzluo

action #57752: [sle][functional][u] write documentation for lib/partition_setupResolvedjorauch

action #57761: [sle][functional][u] Extend documentation for lib/power_action_utils.pmResolvedzluo

action #57800: [sle][functional][u] extend documentation for lib/y2_module_basetest.pmResolvedzluo

action #57824: [sle][functional][u] correct and extend documentation for lib/y2_module_guitest.pmResolvedzluo

action #57839: [sle][functional][u] correct documentation for lib/yast2_widget_utils.pmResolvedzluo

action #57917: [sle][functional][u] extend documentation for lib/partition_setup.pmResolvedzluo

action #58136: [functional][u] write documentation for lib/x11utilsResolvedjorauch

action #58142: [functional][u] write documentation for lib/y2snapper_common.pmResolvedzluo

action #58190: [functional][u] document lib/web_browserResolvedjorauch

action #58202: [functional][u] write documentation for lib/y2_mm_common.pmResolvedzluo

action #58271: [functional][u] Write documentation for lib/xen.pmResolvedzluo

action #50519: [functional][u] extend utils documentation to all lib/functionsResolvedzluo

action #51272: [functional][u] fix travis deployment conditionResolveddheidler

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


Related issues

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

History

#1 Updated by jorauch over 2 years ago

  • Related to action #30862: [functional][u] render documentation of lib/utils added

#2 Updated by jorauch over 2 years ago

  • Description updated (diff)

#3 Updated by SLindoMansilla over 2 years ago

  • Category set to Enhancement to existing tests

#4 Updated by SLindoMansilla over 2 years ago

  • Description updated (diff)
  • Target version changed from Milestone 24 to Milestone 25

#5 Updated by jorauch over 2 years ago

  • Due date set to 2019-05-20

due to changes in a related task

#6 Updated by SLindoMansilla over 2 years ago

  • Description updated (diff)
  • Status changed from New to Workable

A workable epic without assignee mean that anyone can create sub tickets to cover each undocumented module. (Please assign sub tickets to yourself when working on them)

Once that all items in the checklist are checked, I will review the epic resolving it if nothing else needs to be done, assigning it to me.

#7 Updated by SLindoMansilla over 2 years ago

  • Checklist set to [ ] 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

#8 Updated by SLindoMansilla over 2 years ago

  • Checklist set to [x] enable gh-pages on os-autoinst-distri-opensuse

#9 Updated by SLindoMansilla over 2 years ago

  • Checklist set to [x] adapt travis to create and deploy documentation to gh-pages

#10 Updated by mgriessmeier about 2 years ago

  • Target version changed from Milestone 25 to Milestone 26

#11 Updated by mgriessmeier about 2 years ago

  • Target version changed from Milestone 26 to Milestone 27

#12 Updated by SLindoMansilla about 2 years ago

  • Assignee set to mgriessmeier

#13 Updated by dheidler about 2 years ago

  • Due date set to 2019-05-21
  • Start date changed from 2019-04-17 to 2019-05-08

due to changes in a related task

#14 Updated by dheidler about 2 years ago

  • Subject changed from [functional][u][epic] document lib/ functions to [functional][u][saga] document lib/ functions

#15 Updated by mgriessmeier about 2 years ago

  • Target version changed from Milestone 27 to Milestone 28

#16 Updated by mgriessmeier over 1 year ago

  • Target version changed from Milestone 28 to Milestone 31

#17 Updated by SLindoMansilla over 1 year ago

  • Assignee changed from mgriessmeier to SLindoMansilla

#18 Updated by szarate 11 months ago

  • Tracker changed from action to coordination
  • Status changed from Workable to New
  • Difficulty deleted (medium)

#20 Updated by tjyrinki_suse 11 months ago

  • Subject changed from [functional][u][saga] document lib/ functions to [qe-core][functional][saga] document lib/ functions

#21 Updated by SLindoMansilla 6 months ago

  • Assignee deleted (SLindoMansilla)

No time to work on this :(

Also available in: Atom PDF