Uploaded image for project: 'Puppet Server'
  1. Puppet Server
  2. SERVER-1994

Ambiguity in docs about the purpose of environment_timeout

    Details

    • Type: Improvement
    • Status: Accepted
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: SERVER 5.1.0
    • Fix Version/s: None
    • Component/s: DOCS
    • Labels:
      None
    • CS Priority:
      Trivial
    • CS Frequency:
      1 - 1-5% of Customers
    • CS Severity:
      2 - Annoyance
    • CS Business Value:
      1 - ?
    • CS Impact:
      These docs are confusing. It may be better to just remove them. Attempting to explain the differences between the two is incredibly confusing even to people who know the code bases involved.
    • QA Risk Assessment:
      Needs Assessment

      Description

      When read together the following two links create an ambiguity as to what the environment_timeout does and whether the resource api is still in use? it is documented as not in use, but referred to in the document as being the subject of the environment_timeout!

      Needs clarification, was asked in Puppet Slack and confused me as i thought i knew the answer.

      https://puppet.com/docs/puppetserver/5.1/puppet-api/v3/environment_classes.html#changes-class-information-caching-behavior

      https://puppet.com/docs/puppet/5.2/environments_creating.html#configuring-environmenttimeout

        Attachments

          Activity

            People

            • Assignee:
              adam.buxton Adam Buxton
              Reporter:
              adam.buxton Adam Buxton
            • Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:

                Zendesk Support