Project

General

Profile

Actions

coordination #50507

open

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

Added by jorauch almost 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/


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 open34 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 open1 closed)

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

Actions
Actions #1

Updated by jorauch almost 5 years ago

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

Updated by jorauch almost 5 years ago

  • Description updated (diff)
Actions #3

Updated by SLindoMansilla almost 5 years ago

  • Category set to Enhancement to existing tests
Actions #4

Updated by SLindoMansilla almost 5 years ago

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

Updated by jorauch almost 5 years ago

  • Due date set to 2019-05-20

due to changes in a related task

Actions #6

Updated by SLindoMansilla almost 5 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.

Actions #7

Updated by SLindoMansilla almost 5 years ago

  • Checklist item changed from 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
Actions #8

Updated by SLindoMansilla almost 5 years ago

  • Checklist item changed from to [x] enable gh-pages on os-autoinst-distri-opensuse
Actions #9

Updated by SLindoMansilla almost 5 years ago

  • Checklist item changed from to [x] adapt travis to create and deploy documentation to gh-pages
Actions #10

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 25 to Milestone 26
Actions #11

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 26 to Milestone 27
Actions #12

Updated by SLindoMansilla over 4 years ago

  • Assignee set to mgriessmeier
Actions #13

Updated by dheidler over 4 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

Actions #14

Updated by dheidler over 4 years ago

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

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 27 to Milestone 28
Actions #16

Updated by mgriessmeier about 4 years ago

  • Target version changed from Milestone 28 to Milestone 31
Actions #17

Updated by SLindoMansilla almost 4 years ago

  • Assignee changed from mgriessmeier to SLindoMansilla
Actions #18

Updated by szarate over 3 years ago

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

Updated by tjyrinki_suse over 3 years ago

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

Updated by SLindoMansilla almost 3 years ago

  • Assignee deleted (SLindoMansilla)

No time to work on this :(

Actions #22

Updated by slo-gin over 1 year ago

This ticket was set to Normal priority but was not updated within the SLO period. Please consider picking up this ticket or just set the ticket to the next lower priority.

Actions

Also available in: Atom PDF