Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCUMENT-869

Puppet Server documentation uses needlessly confusing terms

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Normal
    • Resolution: Done
    • Component/s: None
    • Labels:
      None
    • Template:
    • QA Risk Assessment:
      Needs Assessment

      Description

      I'll be honest, I'm creating this ticket out of annoyance rather than any real "bug" in the documentation. But the bug is this:

      Any time documentation requires an experienced sysadmin to look up the meaning of a word when there is a much simpler synonym for the same term in much more common use, that is a documentation bug.

      I've been working in IT for nearly 20 years and have never encountered the word "solidus" before. But for some reason, the document here: https://puppet.com/docs/puppetserver/5.3/config_file_auth_migration.html uses the word "solidus" when the word "slash" would be much better.

      Recommendation: Change word "solidus" to "slash"

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              garrett.guillotte Garrett Guillotte
              Reporter:
              jeff@blispay.com Jeff Silverman
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support