Uploaded image for project: 'Modules'
  1. Modules
  2. MODULES-10984

scheduled_task : slightly misleading `Reference` in README.md docs

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: scheduled_task
    • Labels:
      None
    • Template:
    • QA Risk Assessment:
      Needs Assessment

      Description

      Basic Info
      Module Version: 3.0.0
      Puppet Version: 7.4.1 (not relevant)
      OS Name/Version: Ubuntu 20.04 (not relevant)**

      The docs for puppetlabs/scheduled_task have some inconsistent duplication that makes it easy to misunderstand (and misuse) the scheduled_task resource type. 

      There is a 'Reference' section in README: https://forge.puppet.com/modules/puppetlabs/scheduled_task/

      There is a 'Reference' title on REFERENCE.md: https://forge.puppet.com/modules/puppetlabs/scheduled_task/reference

      For example, here are some inconsistencies I noticed:

      • In README.md, `user` has no mention of password/Run only when user is logged on, whereas that is documented in REFERENCE.md.
      • In README.md, `name` shows the sub-folder format as `subfolder
        mytaskname`, whereas REFERENCE.md says `subfolder/mytaskname`

      Recommendation: remove 'Reference' heading under README.md and instead just use the version in the 'Reference' tab (REFERENCE.md).

      Desired Behavior: Single clear place for attribute documentation OR reliably duplicated information in both places.

      Actual Behavior: Different information for the same attribute in two parts of the documentation.

      No logs attached because this is a documentation issue.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            alex_stanhope Alex Stanhope
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Zendesk Support