coordination #50507
open[qe-core][functional][saga] document lib/ functions
75%
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
Updated by jorauch about 5 years ago
- Related to action #30862: [functional][u] render documentation of lib/utils added
Updated by SLindoMansilla almost 5 years ago
- Category set to Enhancement to existing tests
Updated by SLindoMansilla almost 5 years ago
- Description updated (diff)
- Target version changed from Milestone 24 to Milestone 25
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.
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
Updated by SLindoMansilla almost 5 years ago
- Checklist item changed from to [x] enable gh-pages on os-autoinst-distri-opensuse
Updated by SLindoMansilla almost 5 years ago
- Checklist item changed from to [x] adapt travis to create and deploy documentation to gh-pages
Updated by mgriessmeier almost 5 years ago
- Target version changed from Milestone 25 to Milestone 26
Updated by mgriessmeier over 4 years ago
- Target version changed from Milestone 26 to Milestone 27
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
Updated by dheidler over 4 years ago
- Subject changed from [functional][u][epic] document lib/ functions to [functional][u][saga] document lib/ functions
Updated by mgriessmeier over 4 years ago
- Target version changed from Milestone 27 to Milestone 28
Updated by mgriessmeier over 4 years ago
- Target version changed from Milestone 28 to Milestone 31
Updated by SLindoMansilla almost 4 years ago
- Assignee changed from mgriessmeier to SLindoMansilla
Updated by szarate over 3 years ago
- Tracker changed from action to coordination
- Status changed from Workable to New
- Difficulty deleted (
medium)
Updated by szarate over 3 years ago
See for the reason of tracker change: http://mailman.suse.de/mailman/private/qa-sle/2020-October/002722.html
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
Updated by SLindoMansilla about 3 years ago
- Assignee deleted (
SLindoMansilla)
No time to work on this :(
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.