{ "projects": [ { "components": [ { "description": "Command line interface", "name": "CLI" }, { "description": "", "name": "DOCS" }, { "description": "", "lead": "557058:8f2288c8-aafd-4043-8c36-5121d7f0a7df", "name": "UX" } ], "description": "", "externalName": "Puppet Strings", "issues": [ { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "DOCS" ], "created": "2025-03-10T00:22:00.000000", "creator": "6220dbe7932f0f0071677f27", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3ba1e198" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m5vd:" } ], "description": " It mentioned that only the listed are tested but did not specifically mentioned that Solaris and AIX is not supported for the patching under \u201cConfiguring Patch Management\u201d section", "duedate": "2025-03-31T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63986", "fixedVersions": [], "id": "63986", "issueType": "Bug", "key": "PDOC-306", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "6220dbe7932f0f0071677f27", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "10/Mar/25 12:22 AM", "summary": "Puppet Enterprise Doc under \"Configuring Patch Management\" OS support is not clear regarding the support for Solaris and AIX.", "timeSpent": "PT0S", "updated": "2025-03-10T00:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "These docs are generated from the Puppet code and I think this is a puppet strings issue:\nWhen I run puppet strings in the puppet repo with \n{code:bash}\npuppet strings generate --emit-json file.json\n{code}\n\nI get:\n\n{code:json}\n{\n \"name\": \"checksum\",\n \"description\": \"The checksum type to use when determining whether to replace a file's contents.\\n\\nThe default checksum type is\",\n \"values\": [\n \"Puppet::Util::Checksums.known_checksum_types\"\n ]\n}\n{code}\n\nLooks like it should probably be expanding known_checksum_types here: https://github.com/puppetlabs/puppet/blob/2f14ddd269c26cba36771d9b3464c2c29422e46a/lib/puppet/util/checksums.rb#L10-L24\nAlso, https://github.com/puppetlabs/puppet/blob/2f14ddd269c26cba36771d9b3464c2c29422e46a/lib/puppet/type/file/checksum.rb#L10 is returning nil, so the docs just say \u201cThe default checksum type is \u201d", "created": "2022-02-10T13:30:00.000000" } ], "components": [], "created": "2022-01-14T09:29:00.000000", "creator": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a8b1f38" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0djko:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Feb/22" } ], "description": "The docs page for the file type lists the following allowed values for the {{checksum}} parameter:\n\n{quote}\nAllowed values:\n\n * Puppet::Util::Checksums.known_checksum_types\n{quote}\n\nhttps://puppet.com/docs/puppet/6/types/file.html#file-attribute-checksum\nhttps://puppet.com/docs/puppet/7/types/file.html#file-attribute-checksum\n\nSelecting the right checksum has a huge impact on the performance of file server operations and can be the difference between a Puppet Server handling agent load or getting pounded into dust by file metadata requests.\n\nBecause of the extreme effect on performance, we must enumerate the available values in the docs:\n\n* sha256\n* sha256lite\n* md5\n* md5lite\n* sha1\n* sha1lite\n* sha512\n* sha384\n* sha224\n* mtime\n* ctime\n* none\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32524", "fixedVersions": [], "id": "32524", "issueType": "Bug", "key": "PDOC-305", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet docs for the file type are missing available checksum choices", "timeSpent": "PT0S", "updated": "2022-02-10T13:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2021-05-27T13:18:00.000000", "creator": "6220db96c4d0fe0069535219", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@11cb8a4d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08rxv:" } ], "description": "Hello, It seems the pdk puppet strings command is able to detect a missing param tag, but the output shows as 100% documented.\n\nSteps to reproduce:\n\n\u00a0\n{code:java}\npdk --version\n2.1.0\n\u00a0\npdk new module puppet-foo --skip-interview\n\u00a0\ncd foo; pdk new class foo\n{code}\nAdd a param without documentation, such as \"String $foo = 'bar',\" to manifests/init.pp, and run:\n\n\u00a0\n{code:java}\npdk bundle exec puppet strings generate --format markdown\npdk (INFO): Using Ruby 2.7.2\npdk (INFO): Using Puppet 7.5.0\n[warn]: Missing @param tag for parameter 'foo' near manifests/init.pp:7.\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nAttributes: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 1 ( 0 undocumented)\nPuppet Data Types: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Data Type Aliases: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\nPuppet Functions: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Plans: 0 ( 0 undocumented)\nPuppet Tasks: 0 ( 0 undocumented)\n 100.00% documented{code}\nBut the output shows 100.00% documented. Is this expected?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32414", "fixedVersions": [], "id": "32414", "issueType": "Bug", "key": "PDOC-304", "labels": [ "customer0" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "6220db96c4d0fe0069535219", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings Undocumented Param Detection", "timeSpent": "PT0S", "updated": "2021-06-02T17:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "6220db7d49c90000701fd08b", "body": "Created in error", "created": "2020-12-10T04:06:00.000000" } ], "components": [], "created": "2020-12-10T04:05:00.000000", "creator": "6220db7d49c90000701fd08b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56ec3252" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05g9s:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_64896_*|*_6_*:*_1_*:*_0" } ], "description": "Currently the plan_run call does not support scope filtering and the target parameter is hard coded to point at the pe server.\n\nOnce this has been integrated, remove the line below the todo in ;\n*file* - teamsui/src/ui/views/Orchestration/views/NewRunTask/NewRunTask.jsx\n*function* -\u00a0validateFormData\nthen uncomment the code above it\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32492", "fixedVersions": [ "connectLA" ], "id": "32492", "issueType": "Story", "key": "PDOC-302", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "6220db7d49c90000701fd08b", "resolution": "Fixed", "resolutionDate": "2020-12-10T04:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "[Task view] Initiate plan run scope", "timeSpent": "PT0S", "updated": "2021-04-16T12:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2020-03-11T03:09:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2d26dcc0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o00c88:" } ], "description": "Hi,\nI think it makes sense to enhance puppet-strings with at lease those two tags:\n* license\n* author\n\nIn big modules it's possible that certain files come from external contributors with a different license than the one listed in the metadata.json.\n\nTo properly give credit to authors it also makes sense to list them in a file if they contributed the whole file.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32523", "fixedVersions": [], "id": "32523", "issueType": "Improvement", "key": "PDOC-300", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for additional tags like author/license", "timeSpent": "PT0S", "updated": "2020-03-11T03:09:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2020-02-04T18:56:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@501284ec" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzx3z:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1550845896_*|*_5_*:*_1_*:*_0" } ], "description": "A release might be nice. We can release the @enum tag, at least. \n\nInstructions: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md#cutting-a-release", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32355", "fixedVersions": [], "id": "32355", "issueType": "Task", "key": "PDOC-298", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2020-02-22T17:43:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release 2.4.0", "timeSpent": "PT0S", "updated": "2020-02-22T17:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "Ping [~accountid:623c100c4a57610068e74585]", "created": "2020-02-04T07:47:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Can we stay away from the word \"advanced\"? It doesn't carry a lot of useful meaning: How do I know if my use case is advanced? I am a smart person and/or I know a lot about Puppet, I think I should use this advanced feature. Or conversely, I do not feel like I am \"advanced\" at Puppet, so even if I do need this parameter, maybe I should leave it alone.\n\nIf it's for edge cases or special specific uses, or if it's dangerous and can make things go sideways, it should say that in the description. But advanced doesn't tell you very much.\n\n", "created": "2020-02-04T08:51:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "I agree with\u00a0[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79]'s point that this really seems better addressed with words in the parameter description. \"advanced\" is really subjective and not really useful on it's own.", "created": "2020-02-04T18:04:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "Initially I opened https://puppet.atlassian.net/browse/PDOC-267 which is more generic. Advanced is just one possible group. Should this be closed as a duplicate?", "created": "2020-06-03T12:09:00.000000" } ], "components": [], "created": "2020-02-04T07:45:00.000000", "creator": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6977c4d6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzwkf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Feb/20" } ], "description": "It would be nice to be able to differentiate the parameters that are recommended to use and those that are advanced and should rarely be used. Or arbitrary named groups in the docs.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32573", "fixedVersions": [], "id": "32573", "issueType": "Bug", "key": "PDOC-297", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add tag for marking class parameters as \"advanced\"", "timeSpent": "PT0S", "updated": "2020-06-03T12:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4a827910a200718ac35d", "body": "A PR which I believe implements this correctly is up here for consideration: [https://github.com/puppetlabs/puppet-strings/pull/215]\n\nThanks!", "created": "2019-10-20T08:08:00.000000" } ], "components": [], "created": "2019-10-20T08:06:00.000000", "creator": "623a4a827910a200718ac35d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2b600950" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzw89z:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_812710496_*|*_10009_*:*_1_*:*_9957620608_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5750_*|*_10005_*:*_1_*:*_20847" } ], "description": "Puppet Strings currently supports, via YARD, the ability to add extended documentation to a parameter which expects a hash to document the various keys expected using the {{@option}} tag. This is quite useful.\n\nParameters that are of the Puppet {{Enum}} type would also benefit from this type of extended option documentation. However, the {{@option}} tag is not suitable as it expects a data type to be provided, which makes no sense in the context of an {{Enum}}. You can put an arbitrary value as the datatype, but it results in a poor user experience for both the person documenting and the person reading the documentation.\n\nInstead I propose adding a new tag, {{@enum}}, that behaves similarly to {{@option}} but does not expect a data type to be passed and renders the results accordingly (but otherwise similarly to {{@option}}).\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32353", "fixedVersions": [], "id": "32353", "issueType": "New Feature", "key": "PDOC-295", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4a827910a200718ac35d", "resolution": "Fixed", "resolutionDate": "2020-02-21T22:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for @enum tag ", "timeSpent": "PT0S", "updated": "2020-02-21T22:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "body": "I think you may have used the wrong template for this ticket... This template is for requesting a performance experiment. Let me know if I am wrong, otherwise I will clear out the stuff that is making this show up on SLV.", "created": "2020-01-09T17:00:00.000000" }, { "author": "557058:c6973327-1553-427a-99b1-d873fe72306c", "body": "AFAIR I didn't pick any template when creating this ticket, so i'm not sure what is/isn't needed.\u00a0\n\n\u00a0", "created": "2020-01-10T08:46:00.000000" }, { "author": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "body": "Sometimes Jira saves settings from the previous ticket you used, or in really fun cases, that someone else used... Anyway, I removed the things the template did that made this show up on the SLV board, but I don't know if there is anything that needs to be done to get this seen by the right people (every team does it differently). And I can't remove the template, but that shouldn't really matter.", "created": "2020-01-10T09:32:00.000000" } ], "components": [ "DOCS" ], "created": "2019-10-11T20:38:00.000000", "creator": "557058:c6973327-1553-427a-99b1-d873fe72306c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73e48146" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxlpj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Jan/20" } ], "description": "*As a*\u00a0Module Developer\n *I want* to be able to document my type alias struct parameters\n *So that* my module consumers can understand the purpose of the struct and each parameter within it.\n\nPossibly related to PDOC-226 & PDOC-215\n\n[~accountid:557058:6713b848-54a4-4f2e-9636-a24860d9c3f2] asked me to C/P our slack discussion so that there would be context of the desired feature capability. (see Below).\n\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:07 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846078031300]\nI was thinking that the\u00a0{{alias}}\u00a0could/should be replaced if i provide any\u00a0{{@param}}\u00a0directives. And maybe then pdk can raise a warning about not having any custom param descriptions for\u00a0{{type => structs}}\u00a0and an error if one param description is provided but not\u00a0_all_\u00a0\u00a0are defined? WDYT?\n[10:09 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846151033100]\nthe alias is informational but not very useful to consumers - module developers should be providing meaningful docs on the params in the structs\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:09 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846155033200]firstly, I think I understand your concern...what I'm thinking is, that\u00a0_technically_\u00a0those are data type aliases.\u00a0\u00a0So I'm trying to figure out what the ramifications are\n[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846206033900]\nI wonder if Yard even cares ...\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846210034000]maybe i\u2019m abusing the type aliases\u00a0!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-medium/1f604@2x.png!\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846217034300]Nah... you're not\n[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846223034500]\nas in what you're doing is legit\n[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846227034700]\n!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-large/1f642@2x.png!\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846235035200]!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-large/1f44d@2x.png!\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846241035500]it's that this isn't the only case\n[10:10 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846252036000]\nStruct, Object and I think another one will have the same problem\n[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846271036800]\nbut parsing that it going to be a major pain in the bum\u00a0(edited)\u00a0\n[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846282037300]\ne.g. what if you had nested structs\u00a0!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-medium/1f4a5@2x.png!\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846288037400]makes sense - i am trying to figure out how I should be provding guidance to my module consumers about the structs, so they know what/how to build their hiera data correclty\n[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846313038200]\nboo, Nest structs, while valid, are probably a code smell\n[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846318038500]\nIMHO\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:11 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846319038600]does\u00a0{{Variant[String, Struct[....]]}}\n[10:12 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846329039000]\nHow would I express that ... hrmm\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:12 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846341039200]Ahh. i see your point.\n[10:12 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846370040000]\nbut that isn\u2019t a\u00a0_named_\u00a0struct, so does it have the same consideration?\u00a0(edited)\u00a0\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:13 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846381040400]!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-large/1f937@2x.png!\n[10:13 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846387040600]\nJust spitballing edge cases\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:13 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846403041100]no, makes sense to consider all the possibiliites\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:13 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846417041500]that's why for my Version 1 implementation just went \"Spit out a string\"\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:13 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846428041700]!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-large/1f604@2x.png!\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:14 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846441041900]Better than before -\u00a0!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-medium/1f642@2x.png!\n[10:14 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846462042700]\nI wonder if Yard tagging could be interspersed into the type definition\n[10:14 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846473043100]\nPuppet may not like that\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:14 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846474043200]maybe v 1.5 a reordering? - eg: i put the params on the docs, and it spit out yard info, here\u2019s what the markdown looks like:\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:15 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846521044200]So something like\nType xxx = Variant[\n \u00a0 String,\n \u00a0 Struct[\n \u00a0 \u00a0 \u00a0 # @param ....\n \u00a0 \u00a0 \u00a0 blah =>\n \u00a0 ]\n]\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:15 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846524044300]\nEntry.\u00a0\n{{### Dispatcher::Farm::Renderer}}{{\u200b}}{{Renderer attributes hash. Defines the parameters used to configure the */renderer* directive of a farm.}}{{\u200b}}{{Alias of `Struct[{}}\nClick to expand inline (22 lines)\n\u00a0\n[10:15 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846534044800]\noh, i didn\u2019t do it that way, i was doing it like\u2026.\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:15 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846545045100]I know I don't have the code for that\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:16 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846564045300]\n\u00a0\n{quote}# Renderer attributes hash. Defines the parameters used to configure the */renderer* directive of a farm.\n#\n# @summary A hash of renderer attributes.\n# Used to configure the `/renderer` parameter instance of a Farm.\n#\n# @param hostname\n# The hostname for the renderer.\n#\ntype Dispatcher::Farm::Renderer = Struct[{quote}\n\u00a0\n\u00a0\n[10:16 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846589046200]\npuppet strings did the rest - i was just seeing what happend when i did this -\u00a0!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-medium/1f937@2x.png!\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:16 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846599046400]That example you give is fine if and only if it's an alias of Struct\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:16 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846619046900]Yeah i think you just lost me\u00a0!https://a.slack-edge.com/production-standard-emoji-assets/10.2/apple-medium/1f604@2x.png!\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846630047300]S'all good\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846631047600]ooh, i get you\n[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846642048000]\nyour type is either a string\u00a0_or_\u00a0a struct\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846647048200]Yeah\n\u00a0\n[bstopp|https://app.slack.com/team/U7C8ALC4T]\u00a0[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846654048500]Huh. Never thought of doing that\n\u00a0\n[Glenn Sarti|https://app.slack.com/team/U1154M24W]\u00a0[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846656048700]which wouldn't be\u00a0_that_\u00a0common ... but\n[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846660048900]\nit's still legit\n[10:17 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846677049400]\nor\u00a0{{Optional[Struct...]}}\n[10:18 PM|https://puppetcommunity.slack.com/archives/C11LCKKQ9/p1570846681049600]\nwhich would be more common\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32572", "fixedVersions": [], "id": "32572", "issueType": "Improvement", "key": "PDOC-294", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c6973327-1553-427a-99b1-d873fe72306c", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Improve Type Alias Docs - Parameter Support", "timeSpent": "PT0S", "updated": "2020-02-18T17:47:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "6243b7b74fe01d006ba5c73e", "body": "+1 for this!", "created": "2019-10-04T12:28:00.000000" }, { "author": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "body": "This could probably be easily put into puppet-lint with auto-correct.", "created": "2020-02-05T06:30:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:9524215b-1a7d-407b-b7d2-e020f3970c4d] what do you think about an puppet-lint plugin that could do this? Does that seem like a good fit?", "created": "2020-02-18T17:52:00.000000" } ], "components": [], "created": "2019-10-04T12:27:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@74b14879" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxgr3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Oct/19" } ], "description": "It is time consuming to repeat all of the parameters for a given module in the header of the module when first creating documentation.\n\nIt would be great if there could be a command such as {{puppet strings --generate-header}} that would output an appropriate header template to STDOUT.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32489", "fixedVersions": [], "id": "32489", "issueType": "Improvement", "key": "PDOC-293", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Would like a documentation header generation function for puppet strings", "timeSpent": "PT0S", "updated": "2020-02-18T17:52:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "This would be incredibly useful. I can see the output getting *VERY* long though, especially if we iterate supported platforms. I wonder if this is worth another {{PARAMETER_DEFAULTS.md}} doc?", "created": "2019-10-01T11:41:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Would also need to understand the hiera.yaml to ensure all is based on data files inside the module. When using hiera to obtain the values (could be using deep merges etc) it needs to evaluate puppet code - and puppet code can call functions so you would need to make sure it is safe to evaluate logic when generating documentation (which was a problem before PDOC as you needed to load the code to get the docs).\n\nI think it would be better to have a separate tool that generates the default parameters part as data and that PDOC can make use of that when producing the docs. This way it is up to the publisher to run it in a safe manner whereas anyone else can generate docs without risking evaluating user code.", "created": "2019-10-01T12:23:00.000000" } ], "components": [], "created": "2019-10-01T09:00:00.000000", "creator": "557058:8ed100be-9a13-4ed1-92d2-88ac897d6774", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5f30f536" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxcun:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/19" } ], "description": "I'm wondering if it would make sense to pull parameter defaults from a module's \n{{data}} directory.\n\nThis would require to\n\n- either query the data using *no* facts, to ensure that these are platform agnostic defaults, *or*\n- query the data while iterating thru {{on_supported_platform}} and provide a list of defaults ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32552", "fixedVersions": [], "id": "32552", "issueType": "New Feature", "key": "PDOC-292", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:8ed100be-9a13-4ed1-92d2-88ac897d6774", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Pull defaults from data directory", "timeSpent": "PT0S", "updated": "2019-10-01T12:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] to verify if this is still an issue.", "created": "2020-02-18T17:55:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I think Kris Bosland and I might have fixed this as we completed other work", "created": "2020-04-14T17:11:00.000000" } ], "components": [], "created": "2019-08-30T14:53:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a73ed15" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwr3j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14875357307_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_4832103114" } ], "description": "When you run Strings on a Ruby function that includes correctly formatted tags and text, the text is not included in the HTML, even though it is present in the JSON output.\n\nIn the docs tooling that is not a part of strings, but uses strings code for part of it's operation:\n * text is included in the json dumped from puppet strings if the tags are correctly formatted, indicating that it is parsed correctly but not output in the HTML ERB file.\n * text of params is included in generated docs\n * examples are not included in generated docs, but this seems to be a problem with docs' ERB (separate from puppet strings ERB files)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32351", "fixedVersions": [], "id": "32351", "issueType": "Task", "key": "PDOC-290", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Cannot Reproduce", "resolutionDate": "2020-04-14T17:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings HTML output for functions does not include text from JSON", "timeSpent": "PT0S", "updated": "2020-04-14T17:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-08-20T17:41:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71d64a45" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-96" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwihj:" } ], "epicLinkSummary": "Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)", "estimate": "PT0S", "externalId": "32484", "fixedVersions": [], "id": "32484", "issueType": "New Feature", "key": "PDOC-289", "labels": [], "originalEstimate": "PT0S", "parent": "32433", "parentSummary": "Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Generate reference docs for core configuration", "timeSpent": "PT0S", "updated": "2019-08-20T17:41:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-08-18T03:53:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4e1fac3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwgrz:" } ], "description": "The summary / index for functions that is generated when producing markdown contains too much text and truncates it.\n\nFor example:\n{code}\ntahu::attributes: Returns the instance attributes of an Object or Type. An instance attribute is an attribute of a value. Only Object values have inst\n{code}\nFor documentation that looks like this:\n{code}\n# Returns the instance attributes of an `Object` or `Type`.\n#\n# An *instance attribute* is an attribute of a value. Only `Object` values have\n# instance attributes; for example the `name` of a `Person`. Contrast this\n# with a *type attribute* which is an attributes of a `Type`. The type attributes\n{code}\n\nI expected that it would only use only the first sentence, or at least stop at the first blank line.\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32450", "fixedVersions": [], "id": "32450", "issueType": "Bug", "key": "PDOC-288", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "status": "Ready for Engineering", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "markdown summary uses too much summary text and truncates", "timeSpent": "PT0S", "updated": "2020-02-18T17:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Example that results in bad output:\n{code}\n# Converts a value from a `RichData` compliant data structure to the actual runtime values.\n#\n# This function is useful as deserialization of a rich data structure - for example something read from\n# a yaml file. This is the reverse of `tahu::convert_to_rich_data()`.\n#\n# See\n# * `tahu::convert_to_rich_data` for how to serialize.\n# * [Pcore Data Representation Specification](https://github.com/puppetlabs/puppet-specifications/blob/master/language/data-types/pcore-data-representation.md)\n#\n#\n# @example Deserializing a value\n# $r = /this is a regexp/\n# $serialized = tahu::convert_to_rich_data($r)\n# $deserialized = tahu::convert_from_rich_data($serialized)\n# notice( $deserialized == $r)\n# # would notice: true\n#\nPuppet::Functions.create_function(:'tahu::convert_from_rich_data', Puppet::Functions::InternalFunction) do\n\n # @param value - The rich data value to convert from\n dispatch :from_rich_data do\n scope_param\n required_param 'RichData', :value\n return_type 'Any'\n end\n\n def from_rich_data(scope, val)\n Puppet::Pops::Serialization::FromDataConverter.convert(val)\n end\nend\n{code}", "created": "2019-08-18T03:19:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]! I'm wondering if this is a formatting issue. For a Ruby function, tags should go before the dispatch call. Also, I _believe_ that there should be no lines between the `Puppet::Function...` and the following Strings tags. Can you please check to see if that fixes the issue, and let us know here?\n\nSo:\n\n{code}\n# Converts a value from a `RichData` compliant data structure to the actual runtime values.\n# This function is useful as deserialization of a rich data structure - for example something read from\n# a yaml file. This is the reverse of `tahu::convert_to_rich_data()`.\n#\n# See\n# * `tahu::convert_to_rich_data` for how to serialize.\n# * [Pcore Data Representation Specification](https://github.com/puppetlabs/puppet-specifications/blob/master/language/data-types/pcore-data-representation.md)\nPuppet::Functions.create_function(:'tahu::convert_from_rich_data', Puppet::Functions::InternalFunction) do\n # @example Deserializing a value\n # $r = /this is a regexp/\n # $serialized = tahu::convert_to_rich_data($r)\n # $deserialized = tahu::convert_from_rich_data($serialized)\n # notice( $deserialized == $r)\n # # would notice: true\n # @param value - The rich data value to convert from\n dispatch :from_rich_data do\n scope_param\n required_param 'RichData', :value\n return_type 'Any'\n end\n\n def from_rich_data(scope, val)\n Puppet::Pops::Serialization::FromDataConverter.convert(val)\n end\nend\n{code}", "created": "2019-08-19T10:26:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] None of the suggested changes make any difference - the output is identical.", "created": "2019-08-19T10:50:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you for checking [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]!", "created": "2019-08-19T11:03:00.000000" } ], "components": [], "created": "2019-08-18T03:09:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@663085f0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-96" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwgrr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Aug/19" } ], "description": "For a 4.x function with a single dispatch and where there is documentation for the entire function, then the entire documentation is output twice - once for the function and once for the single dispatch signature.\n\nAdding a second dispatch results in the function level documentation to be output only once.\nTested with markdown format output.", "epicLinkSummary": "Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)", "estimate": "PT0S", "externalId": "32380", "fixedVersions": [], "id": "32380", "issueType": "Bug", "key": "PDOC-287", "labels": [], "originalEstimate": "PT0S", "parent": "32433", "parentSummary": "Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ruby 4.x function with single dispatch gets docs generated twice", "timeSpent": "PT0S", "updated": "2019-08-30T15:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-08-06T17:56:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e233a41" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-262" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzw89r:" } ], "description": "Step one of resolving these issues is breaking down all the individual bugs here into their own tickets. It may end up being that some of the resulting tickets are duplicates of one another but we can figure that out as we triage them.", "epicLinkSummary": "Puppet Strings output of Puppet types is inconsistent with puppet doc", "estimate": "PT0S", "externalId": "32571", "fixedVersions": [], "id": "32571", "issueType": "Task", "key": "PDOC-286", "labels": [], "originalEstimate": "PT0S", "parent": "32565", "parentSummary": "Puppet Strings output of Puppet types is inconsistent with puppet doc", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Ready for Engineering", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Break down PDOC-262 description into individual issues", "timeSpent": "PT0S", "updated": "2019-08-06T17:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "attachments": [], "comments": [ { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "PR is at https://github.com/puppetlabs/puppet-strings/pull/209\n\nIn the example above, it was missing a comma in the interface spec. This PR will fix that issue.", "created": "2019-07-30T07:19:00.000000" } ], "components": [], "created": "2019-07-30T06:04:00.000000", "creator": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4676f76f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzw1on:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4475996_*|*_10007_*:*_1_*:*_642053797_*|*_5_*:*_1_*:*_0" } ], "description": "Given a manifest of\n{code}\n# A Puppet Data Type in Ruby.\n#\n# @param arg1 [String] String A message parameter.\n# @param arg2 An Optional Numeric parameter.\nPuppet::DataTypes.create_type('ValidModuleDataType') do\n interface <<-PUPPET\n attributes => {\n arg1 => { type => String, value => \"defaultvalue\" }\n arg2 => { type => Optional[Numeric], value => -1 }\n }\n PUPPET\nend\n{code}\n\nThe arg2 type should be automatically inferred as Optional[Numeric] however currently Puppet-Strings (2.3.0) thinks there is no type information for arg2.\n\nWhile not critical, this should be fixed.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32413", "fixedVersions": [], "id": "32413", "issueType": "Improvement", "key": "PDOC-285", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "resolution": "Fixed", "resolutionDate": "2019-08-06T17:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Infer missing docs types from arguments", "timeSpent": "PT0S", "updated": "2019-08-06T17:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-07-15T15:16:00.000000", "creator": "5fff7df991bb2e01082cf9b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60d45022" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvpqf:" } ], "description": "Currently Bolt is pinning the yard gem to 0.9.19 due to an update in 0.9.20 that changes how symbols are parsed. A security alert was recently sent out concerning a vulnerability with 0.9.19, and being able to unpin from 0.9.19 would resolve this issue.\n\nSince the issue caused by 0.9.20 was corrected by a recent PR to puppet-strings ([https://github.com/puppetlabs/puppet-strings/pull/206]), making a release would allow Bolt to unpin the yard gem.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32449", "fixedVersions": [], "id": "32449", "issueType": "Improvement", "key": "PDOC-284", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "5fff7df991bb2e01082cf9b7", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release dyna_symbols fix", "timeSpent": "PT0S", "updated": "2019-07-15T15:16:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "Commit that caused the issue - https://github.com/lsegal/yard/commit/225ded9ef38c6d2be5a3b0fc7effbc7d6644768d\n\n", "created": "2019-06-29T02:28:00.000000" }, { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "WIP PR https://github.com/puppetlabs/puppet-strings/pull/205", "created": "2019-06-29T02:29:00.000000" }, { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "PR is ready for merge. https://github.com/puppetlabs/puppet-strings/pull/205", "created": "2019-06-30T19:45:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Fixed by:\u00a0\n\n[https://github.com/puppetlabs/puppet-strings/pull/205]\n\n[https://github.com/puppetlabs/puppet-strings/pull/206]\n\n[https://github.com/puppetlabs/puppet-strings/pull/207]", "created": "2019-07-09T17:59:00.000000" } ], "components": [], "created": "2019-06-28T14:44:00.000000", "creator": "5ade3a9f91bc312e6a4a30f3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6410d463" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvgvj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_962101905_*|*_5_*:*_1_*:*_0" } ], "description": "Previously a function definition like {{Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFunction) do}} (https://github.com/puppetlabs/bolt/blob/2fc9eb44f0b743c8a07d7f165bf5c646aa142076/bolt-modules/file/lib/puppet/functions/file/exists.rb#L4) would have a function name of {{file::exists}}. With yard 0.9.20 and puppet strings 2.2.0 the function name renders as {{:'file::exists'}}. For example a call like https://github.com/puppetlabs/bolt/blob/2fc9eb44f0b743c8a07d7f165bf5c646aa142076/Rakefile#L62 will result in json like: \n{code}\n \"puppet_functions\": [\n {\n \"name\": \":'ctrl::do_until'\",\n \"file\": \"bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb\",\n \"line\": 4,\n \"type\": \"ruby4x\",\n \"signatures\": [\n {\n \"signature\": \":'ctrl::do_until'(Callable &$block)\",\n \"docstring\": {\n \"text\": \"Repeat the block until it returns a truthy value. Returns the value.\",\n \"tags\": [\n {\n \"tag_name\": \"example\",\n \"text\": \"ctrl::do_until() || {\\n run_task('test', $target, _catch_errors => true).ok?\\n}\",\n \"name\": \"Run a task until it succeeds\"\n },\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"Callable\"\n ],\n \"name\": \"&block\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Any\"\n ]\n }\n ]\n }\n }\n ],\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32588", "fixedVersions": [], "id": "32588", "issueType": "Bug", "key": "PDOC-283", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "5ade3a9f91bc312e6a4a30f3", "resolution": "Fixed", "resolutionDate": "2019-07-09T17:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Yard gem 0.9.20 causes name spaced puppet functions to render wrong", "timeSpent": "PT0S", "updated": "2019-07-09T17:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-06-25T13:33:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@70c943d0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvdef:" } ], "description": "The documentation for `puppet strings generate` states:\n{noformat}\n--out PATH - Write selected format to PATH. If no path is\n designated, strings prints to STDOUT.{noformat}\nHowever when `\u2013format markdown` is specified, the output is written to REFERENCE.md rather than STDOUT and there appears to be no way to override that behavior through the CLI.\n\nI think the offending code is\u00a0[https://github.com/puppetlabs/puppet-strings/blob/master/lib/puppet-strings.rb#L39]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32570", "fixedVersions": [], "id": "32570", "issueType": "Bug", "key": "PDOC-282", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "No way to output markdown format to stdout", "timeSpent": "PT0S", "updated": "2019-06-25T13:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This sounds more like a task for puppet-lint where it is possible to add \"auto corrections\".", "created": "2019-06-05T06:13:00.000000" } ], "components": [], "created": "2019-06-05T03:45:00.000000", "creator": "623a4603761efb0069cd34da", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@398970a2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuykn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Jun/19" } ], "description": "Given the following scenario (which I think is quite common):\n\nA user already has a working module, but the puppet strings documentation is missing/documented in other format. It would be great if puppet-strings could automatically generate the necessary header block (`# @params $parameter`, ...) for the user which then only had to fill out the missing things.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32350", "fixedVersions": [], "id": "32350", "issueType": "New Feature", "key": "PDOC-281", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4603761efb0069cd34da", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add header autogeneration", "timeSpent": "PT0S", "updated": "2019-06-05T06:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4a827910a200718ac35d", "body": "I think this would be great, but I'd like to suggest that it flag puppet-strings warnings of any kind, not just coverage.", "created": "2019-06-05T05:16:00.000000" } ], "components": [], "created": "2019-06-05T03:41:00.000000", "creator": "623a4603761efb0069cd34da", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@39f58b12" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuyk7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Jun/19" } ], "description": "It would be great if puppet-strings would support a Rake task which checks for documentation converge. This would allow a CI jobs which verifies that all parameters are documented.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32587", "fixedVersions": [], "id": "32587", "issueType": "New Feature", "key": "PDOC-280", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4603761efb0069cd34da", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Rake Task for coverage", "timeSpent": "PT0S", "updated": "2019-06-05T05:16:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "DOCS" ], "created": "2019-05-30T19:49:00.000000", "creator": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Users can find reliable, updated documentation that explains how to generate Puppet module documentation." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5a5321d1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Customer Feedback" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuw07:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "35068" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/May/19" } ], "description": "*Problem statement*\n\nFollowing the instructions at [https://puppet.com/docs/puppet/6.4/puppet_strings.html] does not result in a functional {{puppet strings}} command. Users following this documentation cannot use {{puppet strings}} to generate module documentation.\n\n*Expected result*\n\nEither following the documented installation instructions works, or if installing and invoking {{puppet strings}} directly is no longer recommended, we point users to PDK or whatever the preferred module docs generation method is now.\n\n*Observed result*\n\nFollowing these instructions on that page to install on a Puppet Inc.-provisioned Mojave MacBook Pro with Puppet agent 4.10.2:\n{quote} - If you don't have the yard gem installed yet, install it by running {{gem install yard}}\n - Install the puppet-strings gem by running {{gem install puppet-strings}}{quote}\nresults in Puppet being unable to locate the {{puppet agent}} command:\n{code}garrettottesmbp:Downloads gguillotte$ gem install yard\nFetching: yard-0.9.19.gem (100%)\n--------------------------------------------------------------------------------\nAs of YARD v0.9.2:\n\nRubyGems \"--document=yri,yard\" hooks are now supported. You can auto-configure\nYARD to automatically build the yri index for installed gems by typing:\n\n $ yard config --gem-install-yri\n\nSee `yard config --help` for more information on RubyGems install hooks.\n\nYou can also add the following to your .gemspec to have YARD document your gem\non install:\n\n spec.metadata[\"yard.run\"] = \"yri\" # use \"yard\" to build full HTML docs.\n\n--------------------------------------------------------------------------------\nSuccessfully installed yard-0.9.19\nParsing documentation for yard-0.9.19\nInstalling ri documentation for yard-0.9.19\nDone installing documentation for yard after 2 seconds\n1 gem installed\n\ngarrettottesmbp:Downloads gguillotte$ gem install puppet-strings\nFetching: rgen-0.8.2.gem (100%)\nSuccessfully installed rgen-0.8.2\nFetching: puppet-strings-2.2.0.gem (100%)\nSuccessfully installed puppet-strings-2.2.0\nParsing documentation for rgen-0.8.2\nInstalling ri documentation for rgen-0.8.2\nParsing documentation for puppet-strings-2.2.0\nInstalling ri documentation for puppet-strings-2.2.0\nDone installing documentation for rgen, puppet-strings after 2 seconds\n2 gems installed\n\ngarrettottesmbp:Downloads gguillotte$ puppet strings\nError: Unknown Puppet subcommand 'strings'\nSee 'puppet help' for help on available puppet subcommands\ngarrettottesmbp:Downloads gguillotte$ puppet-strings\n-bash: puppet-strings: command not found\n\ngarrettottesmbp:ntp gguillotte$ sudo puppet strings\nError: Unknown Puppet subcommand 'strings'\nSee 'puppet help' for help on available puppet subcommands\n{code}\nThe gem is installed to my rbenv home gem directory:\n{code}puppet-strings (2.2.0)\n Author: Puppet Inc.\n Homepage: https://github.com/puppetlabs/puppet-strings\n License: Apache-2.0\n Installed at: /Users/gguillotte/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0\n\n Puppet documentation via YARD\n{code}\nbut the same behavior occurs without {{rbenv}}.\n\n*Workaround*\n\nInstalling the gem using Puppet's vendored binary as root works:\n{code}garrettottesmbp:ntp gguillotte$ sudo /opt/puppetlabs/puppet/bin/gem install puppet-strings\nPassword:\nFetching: yard-0.9.19.gem (100%)\n--------------------------------------------------------------------------------\nAs of YARD v0.9.2:\n\nRubyGems \"--document=yri,yard\" hooks are now supported. You can auto-configure\nYARD to automatically build the yri index for installed gems by typing:\n\n $ yard config --gem-install-yri\n\nSee `yard config --help` for more information on RubyGems install hooks.\n\nYou can also add the following to your .gemspec to have YARD document your gem\non install:\n\n spec.metadata[\"yard.run\"] = \"yri\" # use \"yard\" to build full HTML docs.\n\n--------------------------------------------------------------------------------\nSuccessfully installed yard-0.9.19\nFetching: rgen-0.8.2.gem (100%)\nSuccessfully installed rgen-0.8.2\nFetching: puppet-strings-2.2.0.gem (100%)\nSuccessfully installed puppet-strings-2.2.0\nParsing documentation for puppet-strings-2.2.0\nInstalling ri documentation for puppet-strings-2.2.0\nParsing documentation for rgen-0.8.2\nInstalling ri documentation for rgen-0.8.2\nParsing documentation for yard-0.9.19\nInstalling ri documentation for yard-0.9.19\nDone installing documentation for puppet-strings, rgen, yard after 16 seconds\n3 gems installed\n\ngarrettottesmbp:ntp gguillotte$ pwd\n/Users/gguillotte/.puppetlabs/etc/code/modules/ntp\n\ngarrettottesmbp:ntp gguillotte$ puppet strings\nFiles: 4\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nAttributes: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 4 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\nPuppet Functions: 0 ( 0 undocumented)\nPuppet Tasks: 0 ( 0 undocumented)\n 100.00% documented\n{code}\n*Suggested improvement*\n\nEither:\n * Strings developers help update the installation documentation. It's unclear which development team owns Strings now. PDOC and Strings are not listed as a Coremunity team project.\n\nor\n * The installation docs move back to the Strings GitHub repository so open source contributors can maintain them.\n\nor\n * The Strings docs are removed in favor of using PDK, and {{pdk build}} is both capable of building the module documentation and is documented as doing so.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32569", "fixedVersions": [], "id": "32569", "issueType": "Bug", "key": "PDOC-279", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "\"puppet strings\" command unavailable after following installation docs", "timeSpent": "PT0S", "updated": "2019-12-10T08:38:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-05-02T14:05:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "* Puppet code objects tagged with \"@api private\" are rendered appropriately in puppet-string's HTML format output." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6f1042b8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzude7:" } ], "description": "[https://github.com/puppetlabs/puppet-strings/pull/157]\u00a0added basic support for the \"@api private\" tag to the Puppet code objects in puppet-strings and updated the markdown rendering templates to be aware of private code objects.\n\nHowever the HTML templates have not been updated accordingly, we should update those templates so that the generated HTML documentation indicates which Puppet code objects are private versus public.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32586", "fixedVersions": [], "id": "32586", "issueType": "Improvement", "key": "PDOC-278", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Update HTML templates to reflect \"@api private\" resources", "timeSpent": "PT0S", "updated": "2019-05-02T14:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The formatting in the example above has been fixed, but we are still seeing issues in generated docs. It's possible the issue here is in the docs tooling rather than in Strings. I'll investigate this as far as I can, but I may wind up looking for help on it.", "created": "2019-08-12T18:18:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Per 30 Aug 2019 meeting with [~accountid:557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116], this looks like an issue that might exist in the Docs' ERB template, not in Strings.", "created": "2019-08-30T15:17:00.000000" } ], "components": [ "DOCS" ], "created": "2019-05-01T16:53:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@13931a4d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzucov:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Aug/19" } ], "description": "Follow up to PDOC-265\n\nFrom Henrik's comment on that issue:\n\nExamples in {{regsubst.rb}} (the 4.x implementation) looks like this:\n{code}# @example Get the third octet from the node's IP address:\n#\n# ```puppet\n# $i3 = regsubst($ipaddress,'^(\\\\d+)\\\\.(\\\\d+)\\\\.(\\\\d+)\\\\.(\\\\d+)$','\\\\3')\n# ```\n#\n# @example Put angle brackets around each octet in the node's IP address:\n#\n# ```puppet\n# $x = regsubst($ipaddress, /([0-9]+)/, '<\\\\1>', 'G')\n# ```\n{code}\nNote that the example body is one blank line away and not indented. Is that what is causing Puppet Strings to not pick it up? Or is it something else?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32447", "fixedVersions": [], "id": "32447", "issueType": "Bug", "key": "PDOC-277", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ensure that multiline examples are correctly parsed", "timeSpent": "PT0S", "updated": "2019-08-30T15:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5caf5082c75c532928c11f7b", "body": "I see that this issue has been tagged as \"Needs Information\" by \"GreenHopper\".\n\nIf someone would tell me what information is needed, I shall endeavor to supply it.", "created": "2019-12-30T09:08:00.000000" } ], "components": [], "created": "2019-05-01T14:21:00.000000", "creator": "5caf5082c75c532928c11f7b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@52dfccd3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuckn:" } ], "description": "Puppet strings fails to capture complex default values:\n\n* {{$foo = $bar ? \\{'one' => 'special', default => 'normal'\\}}}\n gets captured as:\n {{Default value: $bar}}\n* {{$foo = $bar.regsubst(/\\A([a-z]+) ([0-9]+)\\z/, '\\1')}}\n gets captured as\n {{Default value: $bar}}\n* {{$foo = regsubst($bar, /\\A([a-z]+) ([0-9]+)\\z/, '\\2')}}\n gets captured as\n {{Default value: regsubst($bar, /\\A([a-z]+) \\z/, '\\2')}}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32412", "fixedVersions": [], "id": "32412", "issueType": "Bug", "key": "PDOC-276", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "5caf5082c75c532928c11f7b", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings fails with complex default values.", "timeSpent": "PT0S", "updated": "2019-12-30T09:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-04-17T06:31:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@32182eac" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzu2kf:" } ], "description": "if you create a class as follows\n{code:puppet}# classname# @tag# class classname{code}\nWhen running `Puppet string generate` a [warn] message is generated.\u00a0\n\n[warn]: Missing documentation for Puppet class 'classname' at\u00a0\nmanifests/init.pp:linenumber.\nthe error message identifies the line number of the line with no comment or code, and declares it as undocumented\u00a0\n\nQuestion? does the line really matter at all? \nif so can the error be clearer 'remove or comment empty lines for reason x'\n\nif not can the error be quashed.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32343", "fixedVersions": [], "id": "32343", "issueType": "Improvement", "key": "PDOC-275", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "As a end user, the error message for empty string line could be better", "timeSpent": "PT0S", "updated": "2019-04-17T06:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-02-21T06:50:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76f619fe" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsx13:" } ], "description": "To make use of the new Resource API transport schema information, puppet-strings should read and render the information from {{register_transport}} to the REFERENCE.md.\n\nThe existing code for parsing {{register_type}} can be used as a template.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32568", "fixedVersions": [], "id": "32568", "issueType": "Improvement", "key": "PDOC-291", "labels": [ "resource-api" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Build reference doc for transport schemas", "timeSpent": "PT0S", "updated": "2019-09-24T04:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "attachments": [], "comments": [ { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "Seems to have been addressed in https://github.com/puppetlabs/puppet-strings/pull/231", "created": "2021-01-18T03:04:00.000000" } ], "components": [ "DOCS" ], "created": "2019-02-08T16:37:00.000000", "creator": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Add provider attribute to docs output.\u00a0 This parameter is a base part of all types.\u00a0 It does not show up in the documentation because it is defined in type.rb, instead of the individual type code files." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d21dd87" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-301" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsphb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_37759464983_*|*_3_*:*_1_*:*_23535735784_*|*_5_*:*_1_*:*_0" } ], "description": "Add provider attribute to docs output", "epicLinkSummary": "Docs Process Improvements", "estimate": "PT0S", "externalId": "32348", "fixedVersions": [], "id": "32348", "issueType": "Bug", "key": "PDOC-274", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": "32481", "parentSummary": "Docs Process Improvements", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "resolution": "Fixed", "resolutionDate": "2021-01-18T03:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add provider attribute to docs output", "timeSpent": "PT0S", "updated": "2021-01-18T03:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "attachments": [], "comments": [ { "author": "557058:d266d245-5cba-4a99-842a-d1e061513459", "body": "An example of a module where parts of it get documented and others don't is [https://github.com/ploperations/ploperations-classification]\u00a0\n\nAn example of puppet strings providing zero help is [https://github.com/ploperations/ploperations-consul_data]\u00a0", "created": "2019-02-04T08:00:00.000000" }, { "author": "557058:d266d245-5cba-4a99-842a-d1e061513459", "body": "Pinging [~accountid:557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116]", "created": "2019-02-04T10:50:00.000000" }, { "author": "557058:d266d245-5cba-4a99-842a-d1e061513459", "body": "I have been updating the docs for another module and noticed that not all the tags listed in [https://puppet.com/docs/puppet/6.0/puppet_strings.html]\u00a0are actually picked up from ruby functions.\u00a0", "created": "2019-02-08T19:33:00.000000" }, { "author": "557058:d266d245-5cba-4a99-842a-d1e061513459", "body": "[~accountid:557058:8f1e0495-1d4a-4123-bbad-727b7f49f370] - I saw that you made a small edit on this and was curious where it sat on the priority list.", "created": "2019-09-06T13:11:00.000000" }, { "author": "557058:8f1e0495-1d4a-4123-bbad-727b7f49f370", "body": "Hi [~accountid:557058:d266d245-5cba-4a99-842a-d1e061513459], we removed this from our active sprint because it's not currently being worked on, and right now we're focusing our efforts on higher priority bugs and features. Kris will update the ticket when he's actively working on it again.", "created": "2019-09-06T14:50:00.000000" }, { "author": "557058:d266d245-5cba-4a99-842a-d1e061513459", "body": "Thanks for the info [~accountid:557058:8f1e0495-1d4a-4123-bbad-727b7f49f370]!", "created": "2019-09-06T14:51:00.000000" } ], "components": [], "created": "2019-02-04T07:59:00.000000", "creator": "557058:d266d245-5cba-4a99-842a-d1e061513459", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@36c5d99f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzskb3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Sep/19" } ], "description": "As a module author I write my documentation in a format compatible with puppet strings. I expect that when I run puppet strings generate that all that documentation will end up in REFERENCE.md however none of the docs that I write on the ruby files in the lib folder are processed. The end result of this is a need to manually document part of my module while having the rest of the docs auto-generated.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32551", "fixedVersions": [], "id": "32551", "issueType": "Bug", "key": "PDOC-273", "labels": [ "customer0" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:d266d245-5cba-4a99-842a-d1e061513459", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings should pull documentation from the lib folder too", "timeSpent": "PT0S", "updated": "2020-01-21T23:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "attachments": [], "comments": [], "components": [], "created": "2019-01-11T16:57:00.000000", "creator": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "\"puppet describe user\" includes these Requires Features results which are not in \"puppet strings describe user\":\n\nRequires features manages_aix_lam.\nRequires features manages_solaris_rbac.\n Requires features manages_expiry.\n Requires features libuser.\n Requires features manages_aix_lam.\n... etc\n\nThese come from param and property declarations such as:\n\nlib/puppet/type/user.rb:616: newparam(:ia_load_module, :required_features => :manages_aix_lam)\nlib/puppet/type/user.rb:620: newproperty(:attributes, :parent => Puppet::Property::KeyValue, :required_features => :manages_aix_lam)\n\nThese results should be parsed by puppet strings and added to puppet strings describe output.\n\n\u00a0" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a5f74b2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-301" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyl26f:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Enhancement" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "puppet strings describe will now include information on Required features." }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2915736742_*|*_10007_*:*_1_*:*_5347546005_*|*_3_*:*_1_*:*_437861812_*|*_5_*:*_1_*:*_0" } ], "description": "Parse required_feature attributes and add to strings describe", "epicLinkSummary": "Docs Process Improvements", "estimate": "PT0S", "externalId": "32521", "fixedVersions": [], "id": "32521", "issueType": "Improvement", "key": "PDOC-272", "labels": [], "originalEstimate": "PT0S", "parent": "32481", "parentSummary": "Docs Process Improvements", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "resolution": "Fixed", "resolutionDate": "2019-04-22T10:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Parse required_feature attributes and add to strings describe", "timeSpent": "PT0S", "updated": "2019-04-22T10:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-01-10T15:04:00.000000", "creator": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Goal: Replace outdated docs process with more modern tools.\n\nMitigate or Eliminate extra docs team effort.\n\nRemove unmaintainable code.\n\nCurrently the best tool for managing data related to docs is puppet strings\n\nFacter doc generation is a separate process.\n\nSome known issues to solve:\n # required_features is not included in string output (now in PUP-9451)\n # supported features? missing\n # Some properties are copied from old output to new (strings) output - are they still needed?\n ## In some cases, these are edits for clarity, which may not translate well into tooling.\n ## (actually, no known formatting issues - heredocs should have markdown syntax for formatting)\n ## 'provider' attribute missing - is this just no longer in Puppet 6\n\nQuestions for Jean:\n\n1. Do you have any tool flow issues, e.g. confusing or difficult setup, inconvenient requirements, bad caching?" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3c893fdc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-4" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Docs Process Improvements" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_blue" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzs41j:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_58630220151_*|*_6_*:*_1_*:*_0_*|*_10010_*:*_1_*:*_39292784393" } ], "description": "Docs Process improvements", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32481", "fixedVersions": [], "id": "32481", "issueType": "Epic", "key": "PDOC-301", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "resolution": "Done", "resolutionDate": "2022-02-16T23:54:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Docs Process Improvements", "timeSpent": "PT0S", "updated": "2022-02-16T23:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623c11ebee1b5a0070293512", "created": "2018-12-06T12:06:00.000000", "name": "puppet_example.tar.gz", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12383" } ], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Sorry for the delayed response, but this appears to be an issue in the underlying YARD gem's ability to detect documentation tags that include non-standard whitespace characters. I would suggest following up with https://github.com/lsegal/yard if this continues to be an issue for you.\n\nPlease feel free to re-open this issue if you are sure it is a problem specific to puppet-strings.\n\nThanks!", "created": "2019-06-11T17:59:00.000000" } ], "components": [ "CLI" ], "created": "2018-12-06T12:05:00.000000", "creator": "623c11ebee1b5a0070293512", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@58c07d5d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrjk7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_16174424525_*|*_6_*:*_1_*:*_0" } ], "description": "[~accountid:623c100c4a57610068e74585] noticed that [https://github.com/voxpupuli/puppet-rabbitmq/blob/24abdd6b9934167d10f7ebc30fbc07cd654e6f81/manifests/init.pp#L192] had an odd unicode character that renders as a space for me (even with {{cat -vet}}) ([https://github.com/voxpupuli/puppet-rabbitmq/pull/744#issuecomment-444942295] )\n\nThis seemed to be causing other weird spacing / rendering as well\n\nod -c shows\n{noformat}\n0026020 a d m i n f i l e \\n # ** @ p\n0026040 a r a m l o o p b a c k _ u s\n0026060 e r s T h i s o p t i o n \n {noformat}\nAttached is a pretty self contained repo case, tho haven't been able to replicate the case (probably can be replicated with above config) where some examples don't get rendered. If you add a \"# foo\" at the top, you'll see the missing docs line end up there.\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32478", "fixedVersions": [], "id": "32478", "issueType": "Bug", "key": "PDOC-271", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c11ebee1b5a0070293512", "resolution": "Won't Do", "resolutionDate": "2019-06-11T17:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "unicode space causes oddly formatted output / missing text", "timeSpent": "PT0S", "updated": "2019-06-11T17:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "CLI" ], "created": "2018-10-24T08:27:00.000000", "creator": "623c12399b54ec0068b143b3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@48eda4c0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqr5z:" } ], "description": "It should be possible to use parameters provided by the `yard server` command also with the `puppet strings server` command.\n\n\u00a0For example the --bind and the --port option to allow binding to different addresses and ports.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32550", "fixedVersions": [], "id": "32550", "issueType": "New Feature", "key": "PDOC-270", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c12399b54ec0068b143b3", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Allow yard-server cli options to be passed to puppet-strings-server", "timeSpent": "PT0S", "updated": "2019-06-11T17:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "This is an interesting idea, can you give us some examples of what type of code you are documenting where this would be useful? Is it that you just want more granularity than is expressed in the metadata.json dependencies of a module or are you using this to document role and profile code?", "created": "2019-06-11T17:50:00.000000" } ], "components": [], "created": "2018-10-18T02:54:00.000000", "creator": "62439c7ba629c30068a3ea28", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@38fdf6e0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqmpj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jun/19" } ], "description": "It would be great if there was a tag to document forge modules that are used by the current class or type.\n\nI'd suggest a @uses-module:\n{code:java}\n# @uses puppetlabs-stdlib {code}\nThis would render a link to the forge site of the puppetlabs-stdlib module.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32567", "fixedVersions": [], "id": "32567", "issueType": "New Feature", "key": "PDOC-269", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62439c7ba629c30068a3ea28", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support documenting required modules", "timeSpent": "PT0S", "updated": "2019-06-11T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Looks like we need to make the Table of Contents anchors use the same disambiguation algorithm as the Forge does for multiple headings with the same text value. We should also investigate if there is a standard for this so we can safely predict what the anchor values will be ahead of time.", "created": "2019-06-11T17:45:00.000000" }, { "author": "63d2e1780d930a766df1296b", "body": "I fixed this in Puppet Strings: [PR #303|https://github.com/puppetlabs/puppet-strings/pull/303] ([Issue #300|https://github.com/puppetlabs/puppet-strings/issues/300]). See the PR for a description of the change (pasting it here doesn\u2019t work well), or look at these two changes: [param link|https://github.com/puppetlabs/puppet-strings/pull/303/files#diff-d839a9e39b18a1d882ec8ee5ca04eef5059d855e29cedde26073615aef6a3090R99], [fragment normalization|https://github.com/puppetlabs/puppet-strings/pull/303/files#diff-d839a9e39b18a1d882ec8ee5ca04eef5059d855e29cedde26073615aef6a3090R203-R213]\n\nUnfortunately, it appears that Forge strips the\u00a0{{}} elements out of the generated documentation, so they are still broken there. For example, https://forge.puppet.com/modules/dp/golang/reference#golang\u2013from_tarball\n\nWould you like me to file a new ticket for that? It\u2019s arguably a separate issue.", "created": "2022-10-04T20:57:00.000000" } ], "components": [], "created": "2018-10-17T04:07:00.000000", "creator": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a7adf1b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt6n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jun/19" } ], "description": "When different elements have parameters with the same name, the internal anchors can collide. This means, for example, that the documentation on the Forge provides links that go to the wrong place.\n\nExample: Load the [puppetlabs/mysql|https://forge.puppet.com/puppetlabs/mysql/reference] reference page. Scroll down to see the [{{sql}} task|https://forge.puppet.com/puppetlabs/mysql/reference#sql] entry in the table of contents and click it. Observe that you're now looking at the {{sql}} parameter of the {{mysql::db}} defined type.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32379", "fixedVersions": [], "id": "32379", "issueType": "Bug", "key": "PDOC-268", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Colliding internal anchors on autogenerated pages", "timeSpent": "PT0S", "updated": "2022-10-04T20:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:623c100c4a57610068e74585] sorry for the delay in responding to this request! Could you confirm if this is still something you would find useful and if so, provide a concrete example of some code that makes use of a parameter grouping syntax?\n\nIf this is something that would require extensive customization to YARD, we probably won't have the bandwidth to address it any time soon, but given an example we might be able to come up with something that would work for you.\n\nThanks!", "created": "2019-05-28T17:04:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "Yes, this is still an important use case for us.\n\nI have played around a bit, but couldn't find an easy way to implement it.", "created": "2019-05-29T02:03:00.000000" } ], "components": [], "created": "2018-09-13T16:16:00.000000", "creator": "623c100c4a57610068e74585", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@26bf1404" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpv2f:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" } ], "description": "Currently we have a [kafo_parsers gem|https://github.com/theforeman/kafo_parsers] that also has RDoc support. RDoc has the option to group parameters. In our installer we use this to hide advanced groups with --help but do show them with --full-help. I would like to fully move to puppet-strings so we can drop our RDoc backend but then we need such a feature.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32566", "fixedVersions": [], "id": "32566", "issueType": "New Feature", "key": "PDOC-267", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c100c4a57610068e74585", "status": "Needs Information", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Grouping of parameters", "timeSpent": "PT0S", "updated": "2020-06-03T12:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "[~accountid:623a4a827910a200718ac35d], how big is the impact here? Is this only annoying, or does it break doc generation? If the latter, how hard?", "created": "2018-09-17T02:33:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "It breaks doc generation for the type containing title_patterns - nothing is generated. The other types generate okay.\n\nIn order to try to ensure comprehensive documentation on everything that we release we do default our pipeline to prohibiting anything though where Strings reports any warnings or any missing coverage (classes, parameters, etc.), but we also have a toggle to enable docs with failures to continue though so I can work around that.\n\nI did fiddle around with Strings enough to get a patch that has it continue without any warning, but I wasn't sure if it was a valid approach or not so I stopped working on it.", "created": "2018-09-17T05:01:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "I'm glad it's not a \"everything on fire\" situation. That said, it should definitely not swallow the docs for types using title_patterns. Can you post the patch somewhere, even if we don't think it'll be the right solution. It's at least a pointer to the offending code :-)\n", "created": "2018-09-17T05:08:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "Sure, here it is: [https://github.com/seanmil/puppet-strings/commit/c0165422d677d0f861d6e889e3cc27f8cb109978]\n\n\u00a0", "created": "2018-09-17T05:48:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "That looks like a sensible approach to solve this. Anything speaking against getting that merged right now?", "created": "2018-09-17T06:24:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "No reason I have. Here is a PR: [https://github.com/puppetlabs/puppet-strings/pull/189]\n\n\u00a0", "created": "2018-09-17T06:32:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "Thanks!", "created": "2018-09-24T04:13:00.000000" } ], "components": [], "created": "2018-09-12T15:26:00.000000", "creator": "623a4a827910a200718ac35d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Puppet Strings should correctly handle (or at least not throw a warning on) the use of title_patterns in a Resource API type." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4f75293b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDK-525" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Customer Feedback" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpu67:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_996423413_*|*_5_*:*_1_*:*_0" } ], "description": "\u00a0\n\nWhen running Puppet Strings against a type/provider that uses the `title_parameters` option in the Resource API I get this message:\n\n[warn]: in PuppetStrings::Yard::Handlers::Ruby::RsapiHandler: Undocumentable unexpected construct regexp_literal at lib/puppet/type/mytype.rb:5\n\nI've narrowed it down to not liking the `title_patterns` parameter and, in particular, the regex value in it.", "epicLinkSummary": "Resource API Backlog", "estimate": "PT0S", "externalId": "32446", "fixedVersions": [], "id": "32446", "issueType": "Bug", "key": "PDOC-266", "labels": [], "originalEstimate": "PT0S", "parent": "31265", "parentSummary": "Resource API Backlog", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4a827910a200718ac35d", "resolution": "Fixed", "resolutionDate": "2018-09-24T04:13:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Getting \"unexpected construct regexp_literal\" when using resource API title_patterns", "timeSpent": "PT0S", "updated": "2018-09-24T04:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "body": "Affects-version should be 2.1.0, but that wasn't available in the dropdown.", "created": "2018-09-07T09:47:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Have you tried placing the @example above the @param ? (not sure it helps, but just a thought).\n\nThis needs to be fixed - we were looking at the output for the {{regsubst}} function in puppet, and documentation for it is not coming out right either (it has @example tags as well)", "created": "2018-09-07T14:44:00.000000" }, { "author": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] I have now, and it didn't make any difference.", "created": "2018-09-08T04:16:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:054fa98a-5e29-48e7-aeca-d5542926f8ba] Thanks for testing.", "created": "2018-09-08T10:19:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "Yes, the {{regsubst}} [docs on the docs site|https://puppet.com/docs/puppet/6.4/function.html#regsubst] are in pretty poor state. What do we need to do to prioritize fixing this?\n\nCompare that to the [same listing for 5.3|https://puppet.com/docs/puppet/5.3/function.html#regsubst].", "created": "2019-04-05T16:55:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] do you have any status on the strings work?", "created": "2019-04-05T17:00:00.000000" }, { "author": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "body": "This is fixed in the recently released puppet strings 2.2\n\n[https://github.com/puppetlabs/puppet-strings/pull/188]\n\nI'm interested to see how the core function documentation is affected.\u00a0 I think the problem will be that because puppet-strings was missing the functionality, people have been trying their best to work around the limitations.\n\neg.\n\n[https://github.com/puppetlabs/puppet/blob/80e14013537dd238862cb0d97db5952e840f0f48/lib/puppet/functions/regsubst.rb#L29-L40]", "created": "2019-04-07T10:37:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I'm hoping this recent release fixes the function issue in the core function docs. I'm assigning myself to this ticket for testing.", "created": "2019-04-09T14:17:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "This does not appear to have fixed the issue with core docs generation. It may be a Strings thing or it may be an issue with the docs scripts.\n\nThe function in Puppet code contains a lot of comment text that is seen in the 5.3 example ([https://puppet.com/docs/puppet/5.3/function.html#regsubst]) but is not showing up in the 6.4 generated docs ([https://puppet.com/docs/puppet/6.4/function.html#regsubst]). This includes, but is not limited to, the descriptions of the examples.\n\nWhen I generate docs, I get two files for functions:\n * function_strings_prefer_v3.md: this contains the comment text and @example descriptions from the function.\n * function_strings_prefer_v4.md: this... doesn't.\n\nIt's the function_strings_prefer_v4.md file that becomes functions.html. I'm a little vague on what the difference is between the two files (Puppet 3 vs Puppet 4, I imagine?) because I'm still learning about how the generated docs work. Anyway, pinging [~accountid:557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116], as he's been helping recently on working out some of the bugs with generated docs.\n\n\u00a0\n\neta: I'm also unassigning myself for the time being, because there's eng work that needs to be done here.", "created": "2019-04-11T14:32:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Examples in {{regsubst.rb}} (the 4.x implementation) looks like this:\n{code}\n# @example Get the third octet from the node's IP address:\n#\n# ```puppet\n# $i3 = regsubst($ipaddress,'^(\\\\d+)\\\\.(\\\\d+)\\\\.(\\\\d+)\\\\.(\\\\d+)$','\\\\3')\n# ```\n#\n# @example Put angle brackets around each octet in the node's IP address:\n#\n# ```puppet\n# $x = regsubst($ipaddress, /([0-9]+)/, '<\\\\1>', 'G')\n# ```\n{code}\n\nNote that the example body is one blank line away and not indented. Is that what is causing Puppet Strings to not pick it up? Or is it something else?\n", "created": "2019-04-12T02:57:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good catch, [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd], that might be part of the issue. I've PR'd a fix to that.\n\nThere's still a lot of other descriptive text not getting picked up, but maybe this will fix the example issue.", "created": "2019-04-12T10:48:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] It sounds like maybe the original issue (that puppet-strings didn't recognize the @example tag at all for 4.x style functions) has been fixed but there may still be a bug in how it's able to capture example content that contains blank lines? If that's the case can we open a new ticket specifically about that issue and close this one?", "created": "2019-05-01T15:23:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7], yes, I think that sounds like the right move to me.", "created": "2019-05-01T15:30:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Original issue has been resolved, PDOC-277 has been opened to track the subsequent issues.", "created": "2019-05-01T16:53:00.000000" } ], "components": [], "created": "2018-09-07T08:22:00.000000", "creator": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b095284" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpr1r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18510896106_*|*_10009_*:*_1_*:*_1663479426_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_173794782_*|*_10006_*:*_1_*:*_72891068" } ], "description": "The [style guide|https://puppet.com/docs/puppet/5.5/puppet_strings_style.html#ruby-function-examples] shows you how you're supposed to use puppet-strings with 4.x functions.\n\n{noformat}\n# An example 4.x function.\nPuppet::Functions.create_function(:example) do\n # @param first The first parameter.\n # @param second The second parameter.\n # @return [String] Returns a string.\n # @example Calling the function\n # example('hi', 10)\n dispatch :example do\n param 'String', :first\n param 'Integer', :second\n end\n\n # ...\nend\n{noformat}\n\nI've tried the example above and multiple other ways of specifying the examples tag, but haven't yet been able to get anything output in either html or markdown docs. It would be great if I could document multiple examples (which works with classes), but at a minimum being able to specify just one would be nice.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32519", "fixedVersions": [], "id": "32519", "issueType": "Bug", "key": "PDOC-265", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "resolution": "Fixed", "resolutionDate": "2019-05-01T16:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@example doesn't work with 4.x functions", "timeSpent": "PT0S", "updated": "2019-05-28T16:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "CLI" ], "created": "2018-08-29T17:07:00.000000", "creator": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2ee5a621" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt6f:" } ], "description": "When puppet strings throws errors, it does so on stdout instead of stderr. If you use `--format json`, then this breaks the json object. ", "environment": "Run `puppet strings generate --format json` in puppetlabs/postgresql version 5.8.0 and look at the first two lines returned, they are not json, but errors. \n", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32378", "fixedVersions": [], "id": "32378", "issueType": "Bug", "key": "PDOC-264", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Errors output on stdout, not stderr", "timeSpent": "PT0S", "updated": "2019-08-06T17:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-08-28T21:13:00.000000", "name": "REFERENCE.md", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12382" }, { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-08-28T21:11:00.000000", "name": "Screenshot_2018-08-29_13-10-41.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12385" }, { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-08-28T23:20:00.000000", "name": "Screenshot_2018-08-29_15-16-36.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12396" }, { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-08-28T21:14:00.000000", "name": "includable.rb", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12376" }, { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-08-28T23:20:00.000000", "name": "includable2.rb", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12373" } ], "comments": [ { "author": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "body": "I've noticed examples doesn't render too. See\u00a0https://github.com/voxpupuli/puppet-extlib/pull/108", "created": "2018-09-02T10:40:00.000000" }, { "author": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "body": "I've also found issues with using multiple `@return` tags. Is it worth creating separate issues, or maybe sub-tasks on this ticket?", "created": "2018-09-02T12:54:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:054fa98a-5e29-48e7-aeca-d5542926f8ba] [~accountid:557058:724f8532-144f-4a06-830b-a614714244e4],\n\nI'm unfortunately not actively working on Strings anymore. I would definitely say the more granular the tickets, the better, Alex. I'll see if I can get these issues in front of someone.", "created": "2018-09-04T09:24:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "There are several issued addressed in this ticket:\n\n* Examples not working has been addressed in PDOC-265\n* Duplicated text is also raised in PDOC-287 and seems to affect functions with a single dispatch call.\n* I couldn't find any place where the docs said not to use @summary ", "created": "2019-08-30T15:13:00.000000" } ], "components": [], "created": "2018-08-28T23:33:00.000000", "creator": "557058:724f8532-144f-4a06-830b-a614714244e4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@243d28c1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt67:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Sep/18" } ], "description": "*Puppet Strings version: puppet-strings (2.1.0) GIT*\n\n*Overview*\nRunning puppet strings against a ruby function seems to produce some strange outputs:\n\n*Doubled-up text*\nDescriptive text placed at the top of the file will be duplicated.\n\nSource: includable.rb\n !Screenshot_2018-08-29_13-10-41.png|thumbnail! \n\n*Missing examples*\nIn all cases, rich examples are lost.\n \n*Lost text*\nRe-positioning to look more like the example at https://puppet.com/docs/puppet/5.5/puppet_strings_style.html#ruby-function-examples results in the text not appearing in the output any more:\nSource: includable2.rb\n !Screenshot_2018-08-29_15-16-36.png|thumbnail! \n\n*@summary fixes TOC formatting*\n@summary seems to work nicely even though the docs say not to use it\n\n*Desired outcome*\nWould like to be able to include rich examples in function definitions along with descriptive text", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32377", "fixedVersions": [], "id": "32377", "issueType": "Bug", "key": "PDOC-263", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:724f8532-144f-4a06-830b-a614714244e4", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings output duplicated on ruby functions", "timeSpent": "PT0S", "updated": "2019-08-30T15:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "CC [~accountid:63d40628f6e1b543161789a7] [~accountid:557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116] [~accountid:5a15cc24b87a44359db09635]", "created": "2018-08-06T12:42:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "CC [~accountid:557058:4b02db91-705f-4691-a56a-9a839ecbce6e] [~accountid:557058:43c81f8c-ae3f-46d9-84b0-c9c65e1da709]", "created": "2018-08-07T18:19:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Going to create an epic and break this down into smaller individual tickets", "created": "2019-05-28T16:20:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Adding another issue here so that it's not lost before this ticket gets broken down:\n\nSlack discussion: [https://puppetcommunity.slack.com/archives/C0W298S9G/p1559694938039700]\n\n\u00a0\n\nfile resource parameters listed at the top of the file.md page:\n{code:java}\nfile { 'resource title':\n path => # (namevar) The path to the file to manage. Must be fully...\n ensure => # Whether the file should exist, and if so what...\n backup => # Whether (and how) file content should be backed...\n checksum => # The checksum type to use when determining...\n checksum_value => # The checksum of the source contents. Only md5...\n content => # The desired contents of a file, as a string...\n ctime => # A read-only state to check the file ctime. On...\n force => # Perform the file operation even if it will...\n group => # Which group should own the file. Argument can...\n ignore => # A parameter which omits action on files matching \n links => # How to handle links during file actions. During \n mode => # The desired permissions mode for the file, in...\n mtime => # A read-only state to check the file mtime. On...\n owner => # The user to whom the file should belong....\n provider => # The specific backend to use for this `file...\n purge => # Whether unmanaged files should be purged. This...\n recurse => # Whether to recursively manage the _contents_ of...\n recurselimit => # How far Puppet should descend into...\n replace => # Whether to replace a file or symlink that...\n selinux_ignore_defaults => # If this is set then Puppet will not ask SELinux...\n selrange => # What the SELinux range component of the context...\n selrole => # What the SELinux role component of the context...\n seltype => # What the SELinux type component of the context...\n seluser => # What the SELinux user component of the context...\n show_diff => # Whether to display differences when the file...\n source => # A source file, which will be copied into place...\n source_permissions => # Whether (and how) Puppet should copy owner...\n sourceselect => # Whether to copy all valid sources, or just the...\n target => # The target for creating a link. Currently...\n type => # A read-only state to check the file...\n validate_cmd => # A command for validating the file's syntax...\n validate_replacement => # The replacement string in a `validate_cmd` that...\n # ...plus any applicable metaparameters{code}\n\nfile resource parameters listed at the top of the file.md page based on Strings output:\n\n{code}file { 'resource title':\n path => # (namevar) The path to the file to manage. Must be fully...\n backup => # Whether (and how) file content should be backed...\n force => # Perform the file operation even if it will...\n ignore => # A parameter which omits action on files matching \n links => # How to handle links during file actions. During \n purge => # Whether unmanaged files should be purged. This...\n recurse => # Whether to recursively manage the _contents_ of...\n recurselimit => # How far Puppet should descend into...\n replace => # Whether to replace a file or symlink that...\n show_diff => # Whether to display differences when the file...\n sourceselect => # Whether to copy all valid sources, or just the...\n validate_cmd => # A command for validating the file's syntax...\n validate_replacement => # The replacement string in a `validate_cmd` that...\n # ...plus any applicable metaparameters.{code}\n\nThe missing parameters are missing from both the code block and the listings/descriptions below the code block.\n", "created": "2019-06-05T14:37:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Thanks [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], this is noted in the ticket description (and also affects exec):\n\n{quote}\nApparent cause: Strings does not include attributes defined externally of the main type file. In other words, only the attributes defined in lib/puppet/type/file.rb are output by Strings, and Strings outputs none of the attributes defined in lib/puppet/type/file/*.\n{quote}\n\nThe missing file attributes are also detailed in DOC-3545, and the missing exec attributes are detailed in DOCUMENT-847.", "created": "2019-06-05T17:41:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "I converted this to an Epic, next I'm going to start going through and extracting the various bits into their own tickets.", "created": "2019-06-12T18:24:00.000000" } ], "components": [ "DOCS" ], "created": "2018-08-06T12:35:00.000000", "creator": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@559edc95" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "puppet strings vs. docs" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "In Progress" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzopjr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" } ], "description": "*Puppet Version:* 5.5.3\n *Puppet Server Version:* N/A\n *OS Name/Version:* N/A\n\nWhen generating resource type docs content from Puppet code with Puppet Strings, there are several formatting issues, some unique to certain types and others consistent across all types. These might not be relevant in Platform 6 when many of these types are moved to modules, but they currently require manual reconciliation when compiling reference docs for Platform 5.\n\n*All Strings output in types*\n * The {{puppet doc}} output lists providers, but the Strings docs do not. For example, this is included in the doc output for the zfs type, but omitted from the Strings output:\n\n{code}

provider

\n\nThe specific backend to use for this `zfs`\nresource. You will seldom need to specify this --- Puppet will usually\ndiscover the appropriate provider for your platform.\n\nAvailable providers are:\n\n* [`zfs`](#zfs-provider-zfs)\n{code} * The {{puppet doc}} output lists supported or required features, but the Strings output does not. For example, this appears in the {{puppet doc}} output for the service type's enable attribute, but not in the Strings output:\n\n{code}Requires features enableable.\n{code}\nThis occurs despite the required feature being listed in the type:\n{code} newproperty(:enable, :required_features => :enableable) do\n{code}\nand features have their own description strings, which aren't output:\n{code} feature :enableable, \"The provider can enable and disable the service\",\n{code} * Defaults in the Strings output are formatted unintuitively, as:\n{code}* Default for: `[\"osfamily\", \"solaris\"] == `\n{code}\nThe {{puppet doc}} output instead generates:\n{code}* Default for `osfamily` == `solaris`.\n{code}\n\n * Neither the doc nor Strings output recognizes when multiple allowed values function identically and should ideally be listed together, such as {{true}} and {{yes}} or {{false}} and {{no}} in types using {{Puppet::Parameter::Boolean}}.\n\n * The provider support table generated at the end of several types is inconsistent between the {{puppet doc}} and Strings output. Specifically, the number of rows per column is inconsistent, and some providers are listed as supported or unsupported differently in each. One especially notable discrepancy is in the mcx type, where the only listed provider (mcxcontent) is listed as supported in the {{puppet doc}} output and as unsupported in the Strings output.\n\n*Issues with specific types:*\n\n*exec, file*\n\nSymptom: Many attributes are missing.\n\nApparent cause: Strings does not include attributes defined externally of the main type file. In other words, only the attributes defined in {{lib/puppet/type/file.rb}} are output by Strings, and Strings outputs none of the attributes defined in {{lib/puppet/type/file/*}}.\n\n*filebucket*\n\nSymptom: The port attribute has no description in the Puppet Strings output, despite having a description in the type:\n{code} newparam(:port) do\n desc \"The port on which the remote server is listening. Defaults to the\n value of the `masterport` setting, which is usually %s.\" % Puppet[:masterport]\n\n defaultto { Puppet[:masterport] }\n{code}\nApparent cause: Unknown, but this might be a unique description that attempts to pass a string value ({{Puppet[:masterport]}}) back into the description.\n\n*yumrepo*\n\nSymptom: The {{ABSENT_DOC}} and {{YUM_BOOLEAN}} strings are not rendered, so \"Set this to `absent` to remove it from the file completely.\" appears in the puppet doc output but not in the Strings output, while the regex representing that Boolean expression instead appears in the Strings output as the word \"YUM_BOOLEAN\".\n\nApparent cause: Puppet Strings does not parse these variables, resulting in missing or incorrect output.\n\n*zone*\n\nSymptom: The {{sysidcfg}} attribute description's output includes the %\\{ ... }% brackets in the code.\n\nApparent cause: {{desc}} strings in types are inconsistently wrapped in double quotes, single quotes, heredoc ({{<<-EOT ... EOT}}) and different types of brackets (such as %q\\{ ... }). {{zone}} is the only type using %\\{ ... }% brackets.\n\n*zpool*\n\nSymptom: Quote-escaping backslashes are visible in the Strings output, but not the {{puppet doc}} output. For example, the raidz attribute in {{puppet doc}} output includes the example:\n{code}raidz => [\"disk1 disk2\", \"disk3 disk4\"],\n{code}\nThe same example rendered by Puppet Strings is:\n{code}raidz => [\\\"disk1 disk2\\\", \\\"disk3 disk4\\\"],\n{code}\nApparent cause: Puppet Strings doesn't necessarily require quotes to be escaped with backslashes.\n\n*Steps to reproduce*\n # Clone the puppetlabs/puppet-docs repository.\n # Generate references from the top level of the repository by running\n{noformat}bundle exec rake references:puppet VERSION=5.5.3{noformat}\n # Compare the resulting type and type_strings output.\n\nDetails and prerequisites for generating reference output is in\u00a0[Confluence|https://confluence.puppetlabs.com/display/DOCS/Generating+References] or in the puppet-docs repository.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32565", "fixedVersions": [], "id": "32565", "issueType": "Epic", "key": "PDOC-262", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings output of Puppet types is inconsistent with puppet doc", "timeSpent": "PT0S", "updated": "2021-06-29T09:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-07-19T11:23:00.000000", "creator": "623c09d27910a200718b903c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3aac302b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt5z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" } ], "description": "When running\u00a0\"puppet strings generate\" on the \"1.8.1\" version of the \"puppetlabs-firewall\" module (https://forge.puppet.com/puppetlabs/firewall), the process errors as shown below (return code is 1).\n\n\n{noformat}\n$ puppet strings generate\n[warn]: Missing @param tag for parameter 'ensure' near manifests/init.pp:14.\n[warn]: Missing @param tag for parameter 'pkg_ensure' near manifests/init.pp:14.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/init.pp:14.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/init.pp:14.\n[warn]: Missing @param tag for parameter 'ensure' near manifests/linux.pp:14.\n[warn]: Missing @param tag for parameter 'pkg_ensure' near manifests/linux.pp:14.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/linux.pp:14.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/linux.pp:14.\n[warn]: Missing documentation for Puppet class 'firewall::params' at manifests/params.pp:1.\n[warn]: Missing @param tag for parameter 'ensure' near manifests/linux/debian.pp:16.\n[warn]: Missing @param tag for parameter 'enable' near manifests/linux/debian.pp:16.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/linux/debian.pp:16.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/linux/debian.pp:16.\n[warn]: Missing @param tag for parameter 'package_ensure' near manifests/linux/debian.pp:16.\n[warn]: Missing @param tag for parameter 'ensure' near manifests/linux/gentoo.pp:16.\n[warn]: Missing @param tag for parameter 'enable' near manifests/linux/gentoo.pp:16.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/linux/gentoo.pp:16.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/linux/gentoo.pp:16.\n[warn]: Missing @param tag for parameter 'package_ensure' near manifests/linux/gentoo.pp:16.\n[warn]: Missing @param tag for parameter 'ensure' near manifests/linux/redhat.pp:15.\n[warn]: Missing @param tag for parameter 'enable' near manifests/linux/redhat.pp:15.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/linux/redhat.pp:15.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/linux/redhat.pp:15.\n[warn]: Missing @param tag for parameter 'package_ensure' near manifests/linux/redhat.pp:15.\n[warn]: Missing @param tag for parameter 'ensure' near manifests/linux/archlinux.pp:16.\n[warn]: Missing @param tag for parameter 'enable' near manifests/linux/archlinux.pp:16.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/linux/archlinux.pp:16.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/linux/archlinux.pp:16.\n[warn]: Missing @param tag for parameter 'package_ensure' near manifests/linux/archlinux.pp:16.\n[warn]: Missing a description for Puppet resource property 'ensure' at lib/puppet/type/firewallchain.rb:29.\nError: undefined method `parts' for nil:NilClass\nError: Try 'puppet help strings generate' for usage\n{noformat}\n", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32549", "fixedVersions": [], "id": "32549", "issueType": "Bug", "key": "PDOC-261", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c09d27910a200718b903c", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "\"undefined method `parts' for Nil:NilClass\" when running strings", "timeSpent": "PT0S", "updated": "2019-08-06T17:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:724f8532-144f-4a06-830b-a614714244e4", "created": "2018-06-25T00:32:00.000000", "name": "find_match.pp", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12381" } ], "comments": [ { "author": "557058:724f8532-144f-4a06-830b-a614714244e4", "body": "Workaround: Make sure there are square brackets around the datatype, eg:\n\n\u00a0\n{noformat}\n# @return [String] representing the regex to match the main config file for\n{noformat}", "created": "2018-08-28T00:33:00.000000" } ], "components": [ "CLI", "UX" ], "created": "2018-06-25T00:31:00.000000", "creator": "557058:724f8532-144f-4a06-830b-a614714244e4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5480bd0d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt5r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" } ], "description": "*Overview*\n\nIf the @return tag is used to document a function written in puppet code, puppet-strings prints a stack trace, although it does seem to be able to continue past this\n\n\u00a0\n\n*Expected result*\n\nNo stack trace. Print a human-readable error if input was not in the correct format\n\n\u00a0\n\n*Actual result*\n\nStacktrace printed while generating documentation:\n\n\u00a0\n\n{{}}{{[error]: Unhandled exception in PuppetStrings::Yard::Handlers::Puppet::FunctionHandler:}}\n{{ in `functions/find_match.pp`:12:}}{{12: function logrotate::find_match($setting) >> String {}}{{[error]: NoMethodError: undefined method `first' for nil:NilClass}}\n{{[error]: Stack trace:}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/bundler/gems/puppet-strings-ab62430c6862/lib/puppet-strings/yard/handlers/puppet/function_handler.rb:40:in `add_return_tag'}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/bundler/gems/puppet-strings-ab62430c6862/lib/puppet-strings/yard/handlers/puppet/function_handler.rb:24:in `block in '}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/yard-0.9.14/lib/yard/handlers/processor.rb:114:in `block (2 levels) in process'}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/yard-0.9.14/lib/yard/handlers/processor.rb:112:in `each'}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/yard-0.9.14/lib/yard/handlers/processor.rb:112:in `block in process'}}\n{{ /home/geoff/.rbenv/versions/2.5.1/lib/ruby/gems/2.5.0/gems/yard-0.9.14/lib/yard/handlers/processor.rb:111:in `each'}}{{Files: 2}}\n{{Modules: 0 ( 0 undocumented)}}\n{{Classes: 0 ( 0 undocumented)}}\n{{Constants: 0 ( 0 undocumented)}}\n{{Attributes: 0 ( 0 undocumented)}}\n{{Methods: 0 ( 0 undocumented)}}\n{{Puppet Classes: 1 ( 0 undocumented)}}\n{{Puppet Defined Types: 0 ( 0 undocumented)}}\n{{Puppet Functions: 1 ( 0 undocumented)}}\n{{Puppet Tasks: 0 ( 0 undocumented)}}\n{{Puppet Plans: 0 ( 0 undocumented)}}\n{{Puppet Types: 0 ( 0 undocumented)}}\n{{Puppet Providers: 0 ( 0 undocumented)}}\n{{ 100.00% documented}}\n\n\u00a0\n\n*Workaround*\n\nRemove any @return tag from comments and the error vanishes. Also tried:\n\n@return String\n\n@return String informative description\n\n\u00a0\n\nBoth result in error\n\n\u00a0\n\n*Testcase*\n\nAttached puppet-based function", "environment": "Latest Puppet Strings loaded in Gemfile via:\n\ngem 'puppet-strings', :git => '[https://github.com/puppetlabs/puppet-strings']\n\n\u00a0", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32476", "fixedVersions": [], "id": "32476", "issueType": "Bug", "key": "PDOC-260", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:724f8532-144f-4a06-830b-a614714244e4", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ruby error when @return used to document puppet function", "timeSpent": "PT0S", "updated": "2019-08-06T17:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02] is this still needed? We would like to actually bump the puppet-strings required ruby version at some point. If it's still needed can you point me to the test cases in the puppet_agent module?", "created": "2019-06-19T12:20:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] I believe (without proof) that we're far enough down the line that everybody who is running puppet-strings *should* do so on the ruby supplied by the PDK.", "created": "2019-06-20T02:29:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "OK, we updated our travis config to only test on >= 2.1.9 now, but have left the .gemspec requirement at >= 2.1.0 for the time being.", "created": "2019-06-20T09:55:00.000000" } ], "components": [], "created": "2018-06-20T07:16:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@292839c2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzns27:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_222398_*|*_10009_*:*_1_*:*_420090002_*|*_5_*:*_1_*:*_0" } ], "description": "* https://github.com/puppetlabs/puppet-module-gems/blob/d3e026481adf1746b5029c201b5351fc832b0a3a/config/dependencies.yml#L27 is causing an install of puppet-strings to all modules \n* puppet_agent needs to test against older rubies to support upgrading from them\n* https://github.com/puppetlabs/puppet-strings/blob/d122b1962b41a5deb187ccedfc8857688d496978/puppet-strings.gemspec#L10 is too tight for puppet_agent testing\n\nPossible solutions:\n* relax puppet-string's ruby requirement to 2.1.0 from 2.1.9 and release 2.0.1\n* Remove puppet-strings from ruby 2.1 dependencies in puppet-module-gems\n\nWhile there is no testing on puppet-strings (or puppet) for older rubies, in the puppet_agent upgrade case, the code is not required to run, and for other configurations we can address issues on a best-effort open source basis if and when they get reported.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32445", "fixedVersions": [], "id": "32445", "issueType": "Improvement", "key": "PDOC-259", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Fixed", "resolutionDate": "2018-06-25T04:01:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "relax ruby requirement to 2.1.0 from 2.1.9", "timeSpent": "PT0S", "updated": "2019-06-20T09:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-06-05T16:21:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1faac104" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznf4f:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_24417_*|*_10007_*:*_1_*:*_4400656_*|*_3_*:*_1_*:*_61510044_*|*_5_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32346", "fixedVersions": [], "id": "32346", "issueType": "Task", "key": "PDOC-258", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-06-06T10:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-ibm_installation_manager", "timeSpent": "PT0S", "updated": "2018-06-06T10:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-06-05T16:20:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5aa172c5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznf47:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_36628_*|*_10007_*:*_1_*:*_175591681_*|*_3_*:*_1_*:*_61591154_*|*_5_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32342", "fixedVersions": [], "id": "32342", "issueType": "Task", "key": "PDOC-257", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-06-08T10:14:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-websphere_application_server", "timeSpent": "PT0S", "updated": "2018-06-08T10:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "This ticket represented the work of adding a CI step to modules to generate reference.md file, was never actually a change to be made to strings.", "created": "2019-05-28T16:06:00.000000" } ], "components": [], "created": "2018-06-04T16:01:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@f8b6cfd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznbwf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_30931475446_*|*_6_*:*_1_*:*_0" } ], "description": "Ticket to track work around getting automation of REFERENCE.md up and running for modules.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32376", "fixedVersions": [], "id": "32376", "issueType": "Task", "key": "PDOC-256", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Won't Do", "resolutionDate": "2019-05-28T16:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "REFERENCE.md in CI", "timeSpent": "PT0S", "updated": "2019-05-28T16:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "created": "2018-05-22T11:23:00.000000", "name": "image-2018-05-22-10-23-49-229.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12389" } ], "comments": [ { "author": "5a15cc24b87a44359db09635", "body": "It might be worth considering mimicking the [style PDK uses|https://github.com/puppetlabs/pdk-templates/blob/376595a63040cc31c0a653daa5261d0d2a99ece9/moduleroot_init/README.md.erb#L14-L23] for the ToC in the README?\n{noformat}#### Table of Contents\n\n1. [Description](#description)\n2. [Setup - The basics of getting started with <%= name %>](#setup)\n * [What <%= name %> affects](#what-<%= name %>-affects)\n * [Setup requirements](#setup-requirements)\n * [Beginning with <%= name %>](#beginning-with-<%= name %>)\n3. [Usage - Configuration options and additional functionality](#usage)\n4. [Limitations - OS compatibility, etc.](#limitations)\n5. [Development - Guide for contributing to the module](#development)\n{noformat}", "created": "2018-05-22T11:28:00.000000" } ], "components": [], "created": "2018-05-22T11:24:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1d61099a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-219" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm767:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1072864832_*|*_10007_*:*_1_*:*_406349316_*|*_5_*:*_1_*:*_0" } ], "description": "Currently, the headers in the table of contents and the section headers are the same level and in modules that only contain Resource types, for example, this looks broken (see attached image). This ticket is for possibly adding a \"table of contents\" heading to the markdown output and moving the table of contents headers down a level.\n\n !image-2018-05-22-10-23-49-229.png|thumbnail! ", "epicLinkSummary": "Puppet Strings 2.1.0", "estimate": "PT0S", "externalId": "32341", "fixedVersions": [], "id": "32341", "issueType": "Bug", "key": "PDOC-255", "labels": [ "markdown" ], "originalEstimate": "PT0S", "parent": "32409", "parentSummary": "Puppet Strings 2.1.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-06-08T14:17:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Differentiate between Table of Contents and Section headers", "timeSpent": "PT0S", "updated": "2018-06-08T14:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "How would that work? Why is a tag required?", "created": "2018-05-22T00:23:00.000000" }, { "author": "557058:41a4e05e-92c3-4b20-af84-c2eb651a5c4f", "body": "that would be nice to have, so i can better document usage of hiera keys that are not based on module parameters. tag would be great to get it out in json as separate key.", "created": "2018-08-07T09:12:00.000000" }, { "author": "623a4603761efb0069cd34da", "body": "What needs to be changed is this line --> https://github.com/puppetlabs/puppet-strings/blob/59428718a0ecbb639027aefc3cc40b7ade89e390/lib/puppet-strings/markdown/templates/classes_and_defines.erb#L41\n\nI see to options:\n1. Make it configurable in the @example\n2. Add a @hiera tag as suggested by [~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de]", "created": "2019-06-05T03:47:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "I like the idea of a @hiera tag. Though making the example syntax style configurable might be more flexible.\n\nI actually think that there may be two Hiera-related opportunities here:\n\n1) Documenting keys which are used in lookup() calls which aren't class parameters similar to the style of \"@param\". Maybe the data type could even be sussed out of the lookup() call parameters, if listed.\n\n2) Documenting example Hiera YAML blocks as they would look in the file. This would be more in keeping with the @example tag.\n\nTo [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]'s question, I'd like to think the value of #1 is self-evident. From a user standpoint \"lookup()\" only based keys are still parameters which are part of the interface. For #2 most of my day-to-day user base is very familiar with making changes in Hiera/YAML, but they are not as familiar (in some cases, not at all) with Puppet class syntax and examples shown in Puppet class parameter declaration style wouldn't be nearly as meaningful/useful to them.", "created": "2019-06-05T05:11:00.000000" }, { "author": "623a4603761efb0069cd34da", "body": "{quote}\nFor #2 most of my day-to-day user base is very familiar with making changes in Hiera/YAML, but they are not as familiar (in some cases, not at all) with Puppet class syntax and examples shown in Puppet class parameter declaration style wouldn't be nearly as meaningful/useful to them.\n{quote}\n\nExactly the same for us! :)", "created": "2019-06-05T05:22:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I would prefer if there was a {{@lookup}} tag, and that it would work more or less as {{@param}}, i.e. you can state a data type and what it means. Then any yaml examples (or whatever is needed given whichever backend examples are provided for, that just uses the {{@example}} tag.\n\nThe reason I want \"lookup\" as tag rather than \"hiera\" is that it is \"lookup\" everywhere else (function, CLI, \"Automatic Parameter Lookup\", etc.) - and that \"hiera\" is a particular implementation of lookup.\n\nWhat remains is to decide on what the output looks like - should for example all @param be included again in the lookup section and mixed with those that are explicitly looked up?\n", "created": "2019-06-05T06:11:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "In my perfect world I'd like @lookup (and yes, you're right, a much better name than @hiera) to look and work more or less exactly like @param, near/in the param section. But maybe just auto-tagged with a \"Not available as a class parameter\" type message. I don't like the re-including all the @param docs again, it seems unnecessarily verbose bordering on confusing for a class with a very large set of parameters.\n\nEven with a @lookup tag, I still feel that there is a need for an additional @example-style tag for YAML-syntax highlighted groups of keys for specific use cases and complex behaviors requiring setting multiple keys to achieve specific results.", "created": "2019-06-05T06:39:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:623a4a827910a200718ac35d] Isn't it possible to just do\n{code}\n@example This is a bit of yaml\n```yaml\n key: value\n```\n{code}\n", "created": "2019-06-05T09:29:00.000000" }, { "author": "623a4603761efb0069cd34da", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Nope it isn't, it breaks syntax highlighting. We currently use the following as a workaround:\n\n{code}\n# @summary My example summary\n#\n# #### Examples\n#\n# ```yaml\n# classes:\n# - my_example_class\n# ```\n#\n# @param first_parameter Very important parameter\n{code}\n\nI'm sure why it works, but i shows up in the generate documentation.", "created": "2019-06-05T09:52:00.000000" } ], "components": [], "created": "2018-05-21T14:46:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73b99bd8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm6f3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/May/18" } ], "description": "Add a @hiera tag for puppet files so example hiera can be displayed with yaml syntax.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32515", "fixedVersions": [], "id": "32515", "issueType": "New Feature", "key": "PDOC-254", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@hiera section for putting example hiera", "timeSpent": "PT0S", "updated": "2019-06-05T09:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-21T14:40:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1c78da73" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt5j:" } ], "description": "We don't really test the server action at all. \n\ncdenneen shared some disturbing output:\nhttps://files.slack.com/files-pri/T0AQJ2CTU-FAT2ZEK4H/screen_shot_2018-05-21_at_4.31.59_pm.png\n\nfrom \nhttps://slack-files.com/T0AQJ2CTU-FATFQTQEP-d6e113b634", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32548", "fixedVersions": [], "id": "32548", "issueType": "Bug", "key": "PDOC-253", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Possible issues with puppet strings server", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-18T16:41:00.000000", "creator": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2880262c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm4lz:" } ], "description": "'puppet docs' is deprecated and 'puppet describe is being deprecated.\u00a0 Puppet strings should cover any missing features and facilitate an improved, easier to understand, and more modular puppet documentation build flow.\n\n\u00a0\n\nMissing features include:\n\nSupport for provider details.\n\nSupport for core Puppet configuration (options and settings).\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32444", "fixedVersions": [], "id": "32444", "issueType": "Improvement", "key": "PDOC-252", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should add features to enable replacement of 'puppet describe' and 'puppet docs'", "timeSpent": "PT0S", "updated": "2018-08-09T13:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-18T16:39:00.000000", "creator": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3c34c968" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm4lr:" } ], "description": "Puppet strings should have hooks or libraries so that we can expand it's mission.\u00a0 We would like to use it's features to replace functionality that is being deprecated in older code, but to do so we will need to support new templates, search paths, and possibly output formats or features, such as headers or footers.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32375", "fixedVersions": [], "id": "32375", "issueType": "Improvement", "key": "PDOC-251", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:66e2b7b3-3544-4ef8-aceb-8e67e1315116", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should be more modular/have entry points to support templates, other formats, search paths", "timeSpent": "PT0S", "updated": "2018-08-09T13:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-16T14:44:00.000000", "creator": "557058:4b02db91-705f-4691-a56a-9a839ecbce6e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1606fd79" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm21r:" } ], "description": "When I run `puppet strings generate`, it very kindly gives me data on how much coverage I have, which is awesome. It calls out what's undocumented. However, it doesn't tell me where the undocumented things are! If I could get a file name and a line number, that'd sure be swell!\n\n{code}\n$ be puppet strings generate ./lib/**/*.rb --format markdown\nFiles: 4\nModules: 1 ( 0 undocumented)\nClasses: 3 ( 1 undocumented)\nConstants: 0 ( 0 undocumented)\nAttributes: 0 ( 0 undocumented)\nMethods: 3 ( 1 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 2 ( 0 undocumented)\nPuppet Providers: 2 ( 0 undocumented)\nPuppet Functions: 0 ( 0 undocumented)\n 81.82% documented\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32344", "fixedVersions": [], "id": "32344", "issueType": "Task", "key": "PDOC-250", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:4b02db91-705f-4691-a56a-9a839ecbce6e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings should tell me where I'm missing documentation ", "timeSpent": "PT0S", "updated": "2018-05-16T15:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "created": "2018-05-15T14:30:00.000000", "name": "Screen Shot 2018-05-15 at 2.50.48 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12394" }, { "attacher": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "created": "2018-05-15T14:28:00.000000", "name": "Screen Shot 2018-05-15 at 2.51.10 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12395" }, { "attacher": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "created": "2018-05-15T14:31:00.000000", "name": "Screen Shot 2018-05-15 at 3.31.29 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12392" } ], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "this conditional is broken. This may have been true in older versions of YARD, but the Registry now never contains files:\nhttps://github.com/puppetlabs/puppet-strings/blob/master/lib/puppet-strings/yard/templates/default/layout/html/setup.rb#L128 ", "created": "2018-05-15T14:42:00.000000" } ], "components": [], "created": "2018-05-15T14:31:00.000000", "creator": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@382a3e3f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt5b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/May/18" } ], "description": "When using the yardoc Extra Files feature via .yardopts:\n{noformat}\n--markup markdown\n--output-dir public\n-\nCHANGELOG.md\ndocs/Overview.md{noformat}\nPuppet Strings will still add the \"extra files\" to the documentation, but won't add the links in the left column docs list as is expected.\n\nFor example, the official Yardoc Documentation contains similar \"extra files\" containing things like the LICENSE, LEGAL, and CHANGLOG.md files, but also a user Guide. To get to this guide, the user can click the \"Files\" link displayed at the top of the docs browser in the left-hand column alongside the ruby Classes and Methods links:\n!Screen Shot 2018-05-15 at 2.51.10 PM.png!\n\nHowever, with Puppet Strings, the files are uploaded and stored in the same place and Strings, like base Yardoc, is still aware of the README* file, but the \"Files\" link is nowhere to be found and the only way to get to the Files list in question is to go to the index:\n!Screen Shot 2018-05-15 at 2.50.48 PM.png!\n\nAdditionally, another side effect of this has been found. Since the Files list isn't being generated or displayed, anytime a user visits a File from the Files list (Other than README*), they entire left-hand column will display a blank screen or HTTP 404 (depending on how the files are hosted):\n!Screen Shot 2018-05-15 at 3.31.29 PM.png!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32512", "fixedVersions": [], "id": "32512", "issueType": "Bug", "key": "PDOC-249", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Yardoc \"Extra Files\" Link doesn't display", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b574c837501ba2d6ea647b9", "body": "String has now been implemented per\u00a0[https://github.com/puppetlabs/puppetlabs-tomcat/commit/44f96c5cb2f290ef09a4fa5432a9541c7e81e071#diff-eb120e74eba90da6132666ceb0405bf9]", "created": "2019-06-06T08:17:00.000000" } ], "components": [], "created": "2018-05-15T12:00:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17f00614" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm07j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33423379012_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32374", "fixedVersions": [], "id": "32374", "issueType": "Task", "key": "PDOC-248", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2019-06-06T08:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-tomcat", "timeSpent": "PT0S", "updated": "2019-06-06T08:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b574c837501ba2d6ea647b9", "body": "Strings has now been implemented per\u00a0FM-7923", "created": "2019-06-06T08:16:00.000000" } ], "components": [], "created": "2018-05-15T12:00:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@391f4bd2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm07b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33423338676_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32411", "fixedVersions": [], "id": "32411", "issueType": "Task", "key": "PDOC-247", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2019-06-06T08:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-apache", "timeSpent": "PT0S", "updated": "2019-06-06T08:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b574c837501ba2d6ea647b9", "body": "Strings has now been implemented per\u00a0FM-7936", "created": "2019-06-06T08:15:00.000000" } ], "components": [], "created": "2018-05-15T11:58:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1cbfe553" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm073:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33423411716_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32397", "fixedVersions": [], "id": "32397", "issueType": "Task", "key": "PDOC-246", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2019-06-06T08:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-postgresql", "timeSpent": "PT0S", "updated": "2019-06-06T08:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-15T11:58:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4e102436" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm06v:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1896106856_*|*_10007_*:*_1_*:*_5676440_*|*_5_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32340", "fixedVersions": [], "id": "32340", "issueType": "Task", "key": "PDOC-245", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-06-06T12:14:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-ntp", "timeSpent": "PT0S", "updated": "2018-06-07T14:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b574c837501ba2d6ea647b9", "body": "Strings has now been implemented per\u00a0FM-7950", "created": "2019-06-06T08:15:00.000000" } ], "components": [], "created": "2018-05-15T11:58:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5a431319" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-188" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm06f:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33423432631_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Document our own modules with Puppet Strings", "estimate": "PT0S", "externalId": "32509", "fixedVersions": [], "id": "32509", "issueType": "Task", "key": "PDOC-244", "labels": [], "originalEstimate": "PT0S", "parent": "32371", "parentSummary": "Document our own modules with Puppet Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2019-06-06T08:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings for puppetlabs-stdlib", "timeSpent": "PT0S", "updated": "2019-06-06T08:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-05-14T12:05:00.000000", "creator": "557058:9d1d227b-434f-481d-8279-a026a8ca4bbd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@353dcc0e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt53:" } ], "description": "When a class has a name like mcollective_agent_puppet, the resulting markdown from --format markdown looks like this:\n\n{code}\n## Plans\n\n* [`mcollective_agent_puppet::disable`](#mcollective_agent_puppetdisable): Disables Puppet on the provided nodes\n* [`mcollective_agent_puppet::disable_and_wait`](#mcollective_agent_puppetdisable_and_wait): Disables Puppet on the provided nodes and wait for them to idle By default 10 checks will be done 20 seconds apart, you can adjust these usi\n* [`mcollective_agent_puppet::enable`](#mcollective_agent_puppetenable): Enables Puppet on the provided nodes\n* [`mcollective_agent_puppet::stuck_agents`](#mcollective_agent_puppetstuck_agents): Locates agents stuck applying for extended periods of time When running Puppet in unstable networks one often finds a Puppet Agent stuck thi\n\n## Classes\n\n### mcollective_agent_puppet\n\nThe mcollective_agent_puppet class.\n{code}\n\nNote the _### mcollective_agent_puppet_ outside of code quotes. This will result in agent in italics instead of showing the right text. It should be\n\n{code}\n### mcollective\\_agent\\_puppet\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32443", "fixedVersions": [], "id": "32443", "issueType": "Bug", "key": "PDOC-243", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:9d1d227b-434f-481d-8279-a026a8ca4bbd", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "should escape underscores outside of code blocks", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-04-23T02:32:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4fa396f1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Customer Feedback" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt4v:" } ], "description": "Currently, after each class, type, function, task, or plan name in the table of contents, Strings writes either the text from the @summary tag or the first 140 characters of the \"overview\" text. This ticket is to display the @summary tag or nothing at all, as a clipped overview may be nothing more than clutter in the table of contents.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32474", "fixedVersions": [], "id": "32474", "issueType": "Bug", "key": "PDOC-242", "labels": [ "beginner" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Markdown TOC should display summary or nothing", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "created": "2018-04-23T02:26:00.000000", "name": "Screen Shot 2018-04-23 at 9.25.52 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12388" } ], "comments": [], "components": [], "created": "2018-04-23T02:26:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@127d027a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt4n:" } ], "description": "Running {{puppet strings generate}} on the following function:\n{code:ruby}\n# @summary overview string\nPuppet::Functions.create_function(:dope) do\n # This is a summary\n #\n # @author\n # the author of this class\n #\n # @example do something with it!\n # dope('blah', { some_option: 'key' }, ['bars','bars'])\n #\n # @raise [PuppetError] you might get a PuppetError!\n #\n # @version 1.1.1\n #\n # @since 1.0.0\n #\n # @see this thing\n # this thing, also\n # @see this thing, too\n #\n # @todo DO SOME STUFF\n # @param foo\n # This is a string called foo\n # @param bars\n # This is an optional array called bars\n # @param opts\n # blah\n dispatch :dope do\n param 'String', :foo\n param 'Hash', :opts\n optional_param 'Array', :bars\n return_type 'String'\n end\n\n # @summary second override\n #\n # @param qux\n # A string\n dispatch :dope2 do\n param 'String', :qux\n return_type 'Array'\n end\nend\n{code}\n\nResults in the attached image (not much).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32472", "fixedVersions": [], "id": "32472", "issueType": "Bug", "key": "PDOC-241", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "html output breaks on multiple function signatures", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [], "components": [], "created": "2018-04-20T07:59:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@42687e5c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlfrj:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_52983_*|*_10007_*:*_1_*:*_1915038_*|*_5_*:*_1_*:*_0" } ], "description": "affects Strings 1.2.1+\n\n\"features\" is a key that can be used in the new resource api type that i was not aware of. Further, it expects an array and the rsapi handler doesn't know what to do with an AST node of type :array. ", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32517", "fixedVersions": [], "id": "32517", "issueType": "Bug", "key": "PDOC-240", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-04-20T08:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "rsapi handler can't handle arrays", "timeSpent": "PT0S", "updated": "2018-04-20T08:32:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:371cce5a-def8-43ef-91e9-d177c322c20b], this is by design to keep the blurbs in the table of contents short and the table of contents readable. The TOC line prefers the @summary tag and I would encourage you to take advantage of it. In retrospect, perhaps it should display the @summary or nothing.", "created": "2018-04-17T07:42:00.000000" }, { "author": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "body": "[~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de], thanks. One of my team members found that that was documented after I wrote this ticket, it was just a little jarring to see half a word in my summary. That seems like a fine solution, we just don't have ant of our modules using it yet.", "created": "2018-04-17T07:56:00.000000" } ], "components": [], "created": "2018-04-16T11:01:00.000000", "creator": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@20738968" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlazz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Apr/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_574277883_*|*_5_*:*_1_*:*_0" } ], "description": "Many of our modules have lengthy class headers, like here: https://github.com/simp/pupmod-simp-pki/blob/master/manifests/init.pp\n\nHowever, when using the markdown output format, the header is cut off after about 140 characters in the class summary section.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32373", "fixedVersions": [], "id": "32373", "issueType": "Bug", "key": "PDOC-239", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "resolution": "Done", "resolutionDate": "2018-04-23T02:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "In the class list in REFERENCE.md, the class description is cut off", "timeSpent": "PT0S", "updated": "2018-04-23T02:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-04-16T10:59:00.000000", "creator": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1d385abe" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlazj:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_167478_*|*_1_*:*_1_*:*_76893661_*|*_10007_*:*_1_*:*_321819802_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_262944555" } ], "description": "REFERENCE.md should have a little section at the top where it says that it was generated with `puppet strings generate --format markdown` and changes could be overwritten. ", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32396", "fixedVersions": [], "id": "32396", "issueType": "Improvement", "key": "PDOC-238", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "resolution": "Fixed", "resolutionDate": "2018-04-24T02:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "REFERENCE.md should include a notice saying that it has been generated", "timeSpent": "PT0S", "updated": "2018-04-24T02:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Uh not sure if you spotted it, but it says {{@sumary}} (one 'm') is not supported - so something is clearly not spelled right (somewhere)...", "created": "2018-04-16T08:40:00.000000" }, { "author": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "body": "Oh god, I'm an idiot. Thank you [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]", "created": "2018-04-16T20:12:00.000000" } ], "components": [], "created": "2018-04-16T04:37:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50fe4baa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlan3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Apr/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_56087017_*|*_5_*:*_1_*:*_0" } ], "description": "When running puppet-strings 1.4.1 against files that have a {{@summary}} tag i get the following error:\n\n{code}\n> bundle exec puppet strings [warn]: Unknown tag @sumary\n[warn]: Unknown tag @sumary in file `manifests/item/v_38598.pp` near line 18\n[warn]: Missing @param tag for parameter 'rexecd_ensure' near manifests/item/v_38598.pp:18.\n[warn]: Missing @param tag for parameter 'rexecd_enable' near manifests/item/v_38598.pp:18.\n[warn]: Unknown tag @sumary\n[warn]: Unknown tag @sumary in file `manifests/standard/rhel_6.pp` near line 7\n[warn]: Unknown tag @sumary\n[warn]: Unknown tag @sumary in file `manifests/standard/rhel_6/low.pp` near line 7\n[warn]: Unknown tag @sumary\n[warn]: Unknown tag @sumary in file `manifests/standard/rhel_6/high.pp` near line 7\n[warn]: Unknown tag @sumary\n[warn]: Unknown tag @sumary in file `manifests/standard/rhel_6/medium.pp` near line 7\nFiles: 5\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nAttributes: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 5 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\nPuppet Functions: 0 ( 0 undocumented)\n 100.00% documented\n{code}", "environment": "{code}\n> bundle show \nGems included by the bundle:\n * addressable (2.5.2)\n * ast (2.4.0)\n * bundler (1.16.1)\n * coderay (1.1.2)\n * diff-lcs (1.3)\n * docile (1.3.0)\n * domain_name (0.5.20170404)\n * facter (2.5.1)\n * facterdb (0.5.1)\n * fast_gettext (1.1.2)\n * gettext (3.2.9)\n * gettext-setup (0.30)\n * hiera (3.4.2)\n * http-cookie (1.0.3)\n * jgrep (1.5.0)\n * json (2.0.4)\n * json-schema (2.8.0)\n * locale (2.1.2)\n * mcollective-client (2.12.0)\n * metaclass (0.0.4)\n * metadata-json-lint (2.1.0)\n * method_source (0.8.2)\n * mime-types (2.99.3)\n * mocha (1.1.0)\n * multi_json (1.13.1)\n * net-scp (1.2.1)\n * net-ssh (4.2.0)\n * net-telnet (0.1.1)\n * netrc (0.11.0)\n * parallel (1.12.1)\n * parallel_tests (2.14.2)\n * parser (2.5.1.0)\n * powerpack (0.1.1)\n * pry (0.10.4)\n * public_suffix (3.0.2)\n * puppet (5.5.0)\n * puppet-blacksmith (3.4.0)\n * puppet-lint (2.3.5)\n * puppet-module-posix-default-r2.4 (0.3.1)\n * puppet-module-posix-dev-r2.4 (0.3.1)\n * puppet-strings (1.2.1)\n * puppet-syntax (2.4.1)\n * puppet_pot_generator (1.0.1)\n * puppetlabs_spec_helper (2.7.0)\n * rainbow (2.2.2)\n * rake (12.3.1)\n * rest-client (1.8.0)\n * rgen (0.8.2)\n * rspec (3.7.0)\n * rspec-core (3.7.1)\n * rspec-expectations (3.7.0)\n * rspec-mocks (3.7.0)\n * rspec-puppet (2.6.11)\n * rspec-puppet-facts (1.9.0)\n * rspec-support (3.7.1)\n * rspec_junit_formatter (0.3.0)\n * rubocop (0.49.1)\n * rubocop-i18n (1.2.0)\n * rubocop-rspec (1.16.0)\n * ruby-progressbar (1.9.0)\n * sfl (2.3)\n * simplecov (0.16.1)\n * simplecov-html (0.10.2)\n * slop (3.6.0)\n * spdx-licenses (1.1.0)\n * specinfra (2.67.3)\n * stomp (1.4.4)\n * systemu (2.6.5)\n * text (1.3.1)\n * unf (0.1.4)\n * unf_ext (0.0.7.5)\n * unicode-display_width (1.3.0)\n * yard (0.9.12)\n{code}\n\nruby 2.4.3p205 (2017-12-14 revision 61247) [x86_64-darwin17]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32473", "fixedVersions": [], "id": "32473", "issueType": "Bug", "key": "PDOC-237", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Cannot Reproduce", "resolutionDate": "2018-04-16T20:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@summary does not work", "timeSpent": "PT0S", "updated": "2018-04-16T20:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-04-12T07:24:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5fb54763" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzl8y7:" } ], "description": "from PDOC-153:\n{quote}\nAlso, Consider the following, commonly used, {{params.pp}}\n\n{code}\nfoo::params {\n $bar = 'baz'\n}\n{code}\n\nIn this case, I would like to be able to declare that the {{$foo::params::bar}} variable is available for use but it is not a {{parameter}}.\n\nIdeally, this would be documented with the {{@!accessor [r]}} method, but, when I attempted to use this, an error was thrown.\n\nPresently, I'll continue using {{@param}} but it is inherently incorrect and a more correct alternative should be supplied.\n{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32442", "fixedVersions": [], "id": "32442", "issueType": "New Feature", "key": "PDOC-236", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@!accessor directive for params.pp (or something)", "timeSpent": "PT0S", "updated": "2019-05-01T15:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Will triage tickets that used to live here and some will make their way into a new Strings Maintenance epic", "created": "2019-05-01T15:19:00.000000" } ], "components": [], "created": "2018-04-12T02:14:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76c6cf8a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-7" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Strings Next" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "purple" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzl8kf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33224673858_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32471", "fixedVersions": [], "id": "32471", "issueType": "Epic", "key": "PDOC-235", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Won't Do", "resolutionDate": "2019-05-01T15:19:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings Next", "timeSpent": "PT0S", "updated": "2019-05-01T15:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-04-10T07:32:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@29f49646" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzl607:" } ], "description": "These emit-json options. GET 'EM OUT https://github.com/puppetlabs/puppet-strings/commit/9728d1004a6dff597fb34aa2d4c998999e4acb9d#diff-d247b2f19934e420821d364a7ff58475L19", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32585", "fixedVersions": [], "id": "32585", "issueType": "Task", "key": "PDOC-234", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "remove deprecated cli options", "timeSpent": "PT0S", "updated": "2019-09-04T10:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [ { "attacher": "623c128d866b810069e4380f", "created": "2018-03-27T06:16:00.000000", "name": "output.md.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12384" } ], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623c128d866b810069e4380f], thanks for raising this issue! Have you had a chance to work on the PR?", "created": "2018-03-29T10:17:00.000000" }, { "author": "623c128d866b810069e4380f", "body": "[~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de] - the code was done before I submitted this ticket, but I haven't created a PR.\u00a0 I'm still waiting on my company to get a CLA signed.\u00a0 Should I create the PR before the CLA is signed?\n\nAlso, not sure if you saw this:\n{quote}Is this something you would consider for a trivial patch exemption since it is just changes to white space formatting?\n{quote}\nThat might be a stretch but I thought I'd ask anyway.", "created": "2018-03-29T10:39:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623c128d866b810069e4380f], I think this would probably fall under the exemption. You can go ahead and open a PR without the CLA, for sure.", "created": "2018-03-29T10:45:00.000000" }, { "author": "623c128d866b810069e4380f", "body": "Submitted PR: [https://github.com/puppetlabs/puppet-strings/pull/170]\n\nI also mirrored this to GitLab if you want to check the rendering.\u00a0 See [https://gitlab.com/john.lyman/puppet-strings/tree/markdown-compatibility/spec/fixtures/unit/markdown]\n\n\u00a0", "created": "2018-03-30T07:36:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623c128d866b810069e4380f], PR merged. Please verify on here that this fixes your issue when you get some time.", "created": "2018-04-03T06:26:00.000000" }, { "author": "623c128d866b810069e4380f", "body": "Yes, it's fixed, [~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de].\u00a0 Thanks", "created": "2018-04-03T06:49:00.000000" } ], "components": [], "created": "2018-03-27T06:29:00.000000", "creator": "623c128d866b810069e4380f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3fb9e1a8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkwg7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_186468675_*|*_10007_*:*_1_*:*_349525712_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_76703418" } ], "description": "Some markdown parsers do not convert atx-style headers correctly unless they are surrounded by blank lines. (See below for example.)\n\nThe erb templates should be updated so that all headers are surrounded by blank lines to increase the chance of them rendering correctly with different parsers.\n\nI have already updated the templates and will submit a PR once my company signs the CLA. Is this something you would consider for a trivial patch exemption since it is just changes to white space formatting?\n\n\n\nExample rendering of {{output.md}} spec fixture on GitLab:\n!output.md.png|thumbnail! ", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32514", "fixedVersions": [], "id": "32514", "issueType": "Bug", "key": "PDOC-233", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c128d866b810069e4380f", "resolution": "Fixed", "resolutionDate": "2018-04-03T08:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Generated markdown does not always render correctly", "timeSpent": "PT0S", "updated": "2018-04-03T08:40:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-03-14T11:14:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a423763" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzknyv:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_685139630_*|*_3_*:*_1_*:*_255224_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1190468011" } ], "description": "Once the warning for documenting title/name is removed, add an example to the style guide that shows this is an ok thing to do.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32584", "fixedVersions": [], "id": "32584", "issueType": "Task", "key": "PDOC-232", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-04-05T04:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add example with name parameter documented", "timeSpent": "PT0S", "updated": "2018-04-05T04:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-03-13T17:55:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73cf22af" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzknav:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_747465596_*|*_3_*:*_1_*:*_19606093_*|*_5_*:*_1_*:*_0" } ], "description": "I made some changes to the resource_api handler based on the acceptance tests, but I should have changed the test instead. This is for that work. More details to come. Maybe.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32372", "fixedVersions": [], "id": "32372", "issueType": "Bug", "key": "PDOC-231", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-03-22T14:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Unbreak resource_api handler", "timeSpent": "PT0S", "updated": "2018-03-22T14:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "That is not possible since resolving a value from hiera requires a fully populated node scope - without that there is no way of knowing which values will be looked up. Also, hiera backends may call out to external services to get values. Since you cannot know you would need to put \"see hiera\" on everything which is not helpful at all.\n\nFurther - modules are typically documented in isolation.\n\nWhile there exist one special case - if a module has a very simple hierarchy and uses only data files without any interpolation / aliases to variables, then it could be indexed to produce a key => value map that could be used to indicate that the module comes with a hiera bound value for a parameter. Since that will not always work, is it really worth all the trouble?\n", "created": "2018-03-13T08:16:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623c0ed7866b810069e4361e] this is something that has come up before with Strings, but [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] makes some good points. Perhaps foremost, it'd add massive overhead when generating documentation. Second, we'd really like to keep Strings as a way to document only the module itself and getting into Hiera gets into environments and even beyond. Thanks for raising this ticket, though!", "created": "2018-04-16T06:50:00.000000" } ], "components": [], "created": "2018-03-12T21:19:00.000000", "creator": "623c0ed7866b810069e4361e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3a15a26e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzklyn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2971886835_*|*_6_*:*_1_*:*_0" } ], "description": "When generating documentation for parameterized classes, puppet strings only includes the default values which are specified within the class itself.\n\nInstead, puppet strings should also consider values in hiera, and indicate when there are multiple possible defaults, or an unclear selection (hiera files based upon facts) with a comment such as \"multiple defaults: see hiera\".", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32410", "fixedVersions": [], "id": "32410", "issueType": "Improvement", "key": "PDOC-230", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c0ed7866b810069e4361e", "resolution": "Won't Do", "resolutionDate": "2018-04-16T06:50:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings should look for default parameter values in module-scoped hiera", "timeSpent": "PT0S", "updated": "2018-04-16T06:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-03-12T10:38:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3797dd85" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Customer Feedback" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkkgf:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1012756_*|*_10007_*:*_1_*:*_499614202_*|*_3_*:*_1_*:*_168615140_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1296526693" } ], "description": "In a Puppet 4 function:\nif return_type is used AND there is no @return tag used, an error is thrown.\n\n*Repro*\n1. Create a simple Puppet 4 function\n{code}\nPuppet::Functions.create_function(:foo) do\n # @summary does a thing\n # @param param1 a string for stuff\n dispatch :foo do\n param 'String', :param1\n return_type 'String'\n end\nend\n{code}\n2. Run {{puppet strings generate --format markdown}}\n\ne.g.\n{code}\npuppet strings generate --format markdown\n--- SNIP ---\n[warn]: Missing documentation for Puppet function 'archive::artifactory_checksum' at lib/puppet/functions/archive/artifactory_checksum.rb:4.\n[error]: Unhandled exception in PuppetStrings::Yard::Handlers::Ruby::FunctionHandler:\n in `lib/puppet/functions/archive/artifactory_checksum.rb`:4:\n\n 4: Puppet::Functions.create_function(:'archive::artifactory_checksum') do\n\n[error]: NoMethodError: undefined method `types=' for nil:NilClass\n[error]: Stack trace:\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:142:in `block in add_overload_tag'\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:135:in `each'\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:135:in `add_overload_tag'\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:100:in `block in add_tags'\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:98:in `each'\n /home/alex/.rvm/gems/ruby-2.4.1/gems/puppet-strings-1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb:98:in `add_tags'\n{code}\n\n*In the code...*\n\nThe function handler assumes that a return tag exists and tries to add the return type to it:\nhttps://github.com/puppetlabs/puppet-strings/blob/1.2.1/lib/puppet-strings/yard/handlers/ruby/function_handler.rb#L142", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32470", "fixedVersions": [], "id": "32470", "issueType": "Bug", "key": "PDOC-229", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-04-04T04:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "error with return_type and @return tag", "timeSpent": "PT0S", "updated": "2021-06-10T23:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "body": "[~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de] can we chat through what this work would entail?", "created": "2018-03-06T07:59:00.000000" } ], "components": [], "created": "2018-03-02T16:57:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76549b6a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkduv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_6411_*|*_10007_*:*_1_*:*_668221303_*|*_3_*:*_2_*:*_1451880348_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_683318682" } ], "description": "Task Plans live in ./plans/\n\nThey are written in the DSL so the existing Puppet parser should be helpful.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32513", "fixedVersions": [], "id": "32513", "issueType": "Task", "key": "PDOC-228", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-04-04T04:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Task Plan support", "timeSpent": "PT0S", "updated": "2018-04-04T04:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "+100", "created": "2018-03-04T04:03:00.000000" } ], "components": [], "created": "2018-03-02T15:12:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c083cce" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkdqf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Mar/18" } ], "description": "Let's get rid of the option to specify markdown as the markup. It should _only_ be markdown.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32339", "fixedVersions": [], "id": "32339", "issueType": "Task", "key": "PDOC-227", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "use markdown as default/only markup type", "timeSpent": "PT0S", "updated": "2019-05-01T15:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "There are type aliases as the ones described in the linked documentation - i.e. an autoloaded data type alias like:\n{code:puppet}\ntype MyModule::MyType = SomeOtherType\n{code}\n\nFor those it would be great if an adjacent comment is taken as documentation of the aliased type.\n\nNote that for some such declarations - it is not as much an _alias_ as a type definition - for example:\n{code:puppet}\ntype MyModule::MyType = Object[{ attributes => { name => String, birthdate => Timestamp}}]\n{code}\n\nThere are also local type aliases in 4.x ruby functions. More complex functions use those to define aliases that are only in effect for a single function. Here is an example from the {{lookup()}} function:\n{code:ruby}\n local_types do\n type 'NameType = Variant[String, Array[String]]'\n type 'ValueType = Type'\n type 'DefaultValueType = Any'\n type 'MergeType = Variant[String[1], Hash[String, Scalar]]'\n type 'BlockType = Callable[NameType]'\n type \"OptionsWithName = Struct[{\\\n name => NameType,\\\n value_type => Optional[ValueType],\\\n default_value => Optional[DefaultValueType],\\\n override => Optional[Hash[String,Any]],\\\n default_values_hash => Optional[Hash[String,Any]],\\\n merge => Optional[MergeType]\\\n }]\"\n type \"OptionsWithoutName = Struct[{\\\n value_type => Optional[ValueType],\\\n default_value => Optional[DefaultValueType],\\\n override => Optional[Hash[String,Any]],\\\n default_values_hash => Optional[Hash[String,Any]],\\\n merge => Optional[MergeType]\\\n }]\"\n\n end\n\n dispatch :lookup_1 do\n scope_param\n param 'NameType', :name\n optional_param 'ValueType', :value_type\n optional_param 'MergeType', :merge\n end\n{code}\n\nDocumenting those are a bit more difficult - should the signature of the function show the aliases only - for example {{NameType}} (then you have to guess, or read the general description what a {{NameType}} is (requires author of function doc to write that), should it use an expanded {{NameType}} instead of just the alias (more difficult to read), or should it present the list of local aliases?\n\nI think it would be great if we could show a list of aliases and then use those aliases in the multiple signatures.\nIt may be that 4.x local aliases is complex enough to warrant a separate ticket.\n\n", "created": "2018-03-04T04:17:00.000000" }, { "author": "62437c021da0e1007138c15e", "body": "I'd like to back that request up. I just found out that the documentation pages generated by puppet strings shows the types for class and defined type params, but their definitions are nowhere to be found when you want to know what they stand for.\n\n\u00a0\n\nThey could be listed as pages in the same section as ruby custom types which are already supported, or if this confuses things too much, they could also have their own section named \"Type aliases\". The very least would be to see what the type is an alias of (e.g. show the definition in the html page). then, like Henrik suggested, it would be great if all uses of this type in class and defined type params would link to the corresponding page", "created": "2018-06-26T12:55:00.000000" }, { "author": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "body": "Just passing through and noticed this ticket\u2015documentation for Type aliases have been implemented for a while:\n * Example documentation generated from a simple Type Aliases: [https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#stdlibcompatbool]\n * Example documentation generated from a complex Type Alias (e.g., \"not as much an _alias_ as a type definition\"): [https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#stdlibfilesource]\n * Not sure if local type aliases are handled or not", "created": "2021-08-23T17:37:00.000000" } ], "components": [], "created": "2018-03-02T14:45:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e06ae44" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkdnj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Mar/18" } ], "description": "Support for these would be great:\nhttps://puppet.com/docs/puppet/5.3/lang_type_aliases.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32441", "fixedVersions": [], "id": "32441", "issueType": "Task", "key": "PDOC-226", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support for Type Aliases", "timeSpent": "PT0S", "updated": "2021-08-23T17:37:00.000000", "votes": "12", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The yard syntax for parameter default could perhaps be used for this. The module author knows a parameter has a default value in hiera data in the module and could note that with some notation - yard does not have semantics for default for {{@param}} tags, but for {{@option}} it is suggested to place a default value in parentheses. We could use the same for {{@param}}. \n\nThe convention could be {{()}} or say {{(module data)}} where the first documents a literal value for example {{(42)}}, and the second that there will be a lookup and that the value is in the module's data (if possible user could also state what the default in module data is - if it always resolves to the same value - if so use something like {{(module data 42)}}.\n\nCould also use {{(\\*)}} or somesuch to indicate \"default in module data\", but you have to know the notation to understand that.\n{code:puppet}\n# @param port [Integer] (*) the port to use\nclass myclass(Integer $port) { }\n{code}\n\nNothing of the above requires any changes to code, only that a convention is established.", "created": "2018-03-04T04:34:00.000000" }, { "author": "557058:9d1d227b-434f-481d-8279-a026a8ca4bbd", "body": "I have no ideas on how to do this with yard but details of the module supplied lookup options (merge strategies) would be amazing. ", "created": "2018-03-04T04:51:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:9d1d227b-434f-481d-8279-a026a8ca4bbd] Since the information after the bracketed type for a param is completely ignored by yard itself, you can put anything there. What Strings could do is to have a convention that for example a hash in puppet language notation inside parentheses following the bracket would be displayed a certain way. That would be kind of like additional meta tags (but those are lot harder to introduce).\n\nSomething like:\n{code}\n@param foo [Hash] (lookup_options => { merge => 'deep' }) foo is a param for foo details...\n{code}\n\nYou would have to do some static declaration like that as the information can not be obtained statically from hiera because the effective lookup_options may depend on values at runtime. Since that is the case, maybe it is just as good to spell it out in the text in free form - so if code does something fancy you can just say so?\n\n{code}\n@param foo [Hash] (* deep merge) foo is a param for foo details\n@param bar [Hash] (* deep merge if bar_deep is true) bar is a param for bar details\n{code}", "created": "2018-03-05T14:40:00.000000" } ], "components": [], "created": "2018-03-02T14:41:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@23a0920e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkdmf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Mar/18" } ], "description": "Would like to see documentation created for types, providers, facts and the hiera levels when using data in modules. - Garrett Honeycutt\n\nI agree with this but so much of data in modules is dependent on compile time material that it would be impossible to do anything except for defaults (which should be done). However, we do need some way to indicate that a parameter is in module data instead of 'required' that doesn't require keeping a manual mapping (because automation is good, right?) - Trevor Vaughn\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32506", "fixedVersions": [], "id": "32506", "issueType": "Task", "key": "PDOC-225", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Data in Modules?", "timeSpent": "PT0S", "updated": "2018-03-05T14:40:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [], "components": [], "created": "2018-03-01T05:26:00.000000", "creator": "623c100c4a57610068e74585", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56dc7076" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkc9z:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_21102860_*|*_5_*:*_1_*:*_0" } ], "description": "With puppet-strings 1.2.0\n{code:java}$ puppet strings generate --emit-json-stdout ~/dev/puppet-tftp/manifests/init.pp\nWARNING: '--emit-json-stdout' is deprecated. Use '--format json' instead.\n100.00% documented{code}\nWith puppet-strings 1.1.0\n{code:java}$ puppet strings generate --emit-json-stdout ~/dev/puppet-tftp/manifests/init.pp\n{\n\u00a0 \"puppet_classes\": [\n\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"tftp\",\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"file\": \"/home/ekohl/dev/puppet-tftp/manifests/init.pp\",\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"line\": 28,\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"docstring\": {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"TFTP server class\\n\\nThis class installs and configures a TFTP server, supporting both standalone\\ndaemons and xinetd-based TFTP servers.\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tags\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"summary\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Installs and configures a TFTP server\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"example\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"include tftp\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"Simple usage\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"example\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"class { 'tftp':\\n\u00a0 root => '/tftpboot',\\n}\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"Configure a TFTP server with a non-default root directory\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"example\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"class { 'tftp:'\\n\u00a0 package => 'tftp-hpa-destruct',\\n}\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"Configure a TFTP server with non-default package name\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Configures the root directory for the TFTP server\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Stdlib::Absolutepath\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"root\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Name of the TFTP server package\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"String\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"package\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Name of the syslinux package, essential for pxe boot\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Variant[String, Array[String]]\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"syslinux_package\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Runs a TFTP service when true, configures xinetd when false\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Boolean\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"daemon\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"manages the root dir, which tftpd will serve, defaults to true\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Boolean\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"manage_root_dir\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Name of the TFTP service, when daemon is true\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Optional[String]\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"service\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"tag_name\": \"param\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"text\": \"Override TFTP service provider, when daemon is true\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"types\": [\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Optional[String]\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ],\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"name\": \"service_provider\"\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\n\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"defaults\": {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"service\": \"undef\",\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"service_provider\": \"undef\"\n\u00a0\u00a0\u00a0\u00a0\u00a0 },\n\u00a0\u00a0\u00a0\u00a0\u00a0 \"source\": \"class tftp (\\n\u00a0 Stdlib::Absolutepath $root,\\n\u00a0 String $package,\\n\u00a0 Variant[String, Array[String]] $syslinux_package,\\n\u00a0 Boolean $daemon,\\n\u00a0 Boolean $manage_root_dir,\\n\u00a0 Optional[String] $service = undef,\\n\u00a0 Optional[String] $service_provider = undef,\\n) {\\n\\n\u00a0 class {'::tftp::install':}\\n\u00a0 -> class {'::tftp::config':}\\n\u00a0 ~> class {'::tftp::service':}\\n\u00a0 -> Class['::tftp']\\n}\"\n\u00a0\u00a0\u00a0 }\n\u00a0 ],\n\u00a0 \"defined_types\": [\n\n\u00a0 ],\n\u00a0 \"resource_types\": [\n\n\u00a0 ],\n\u00a0 \"providers\": [\n\n\u00a0 ],\n\u00a0 \"puppet_functions\": [\n\n\u00a0 ]\n}\n{code}\n\u00a0\n\nIf a class has undocumented parameters, --emit-json-stdout also puts warnigs on stdout rather than stderr which would also break JSON parsing.\n\nIn [kafo_parsers|https://github.com/theforeman/kafo_parsers] we call with --emit-json-stdout. We can't detect the exact puppet-strings version easily and maintaining compatibility with older versions is useful. We can redirect stderr to `/dev/null` so that'd be a good compromise. The [exact call|https://github.com/theforeman/kafo_parsers/blob/25e8a12adcedbfd9bd6be5056f5871a9f6425209/lib/kafo_parsers/puppet_strings_module_parser.rb#L40]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32338", "fixedVersions": [], "id": "32338", "issueType": "Bug", "key": "PDOC-224", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c100c4a57610068e74585", "resolution": "Fixed", "resolutionDate": "2018-03-01T11:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings 1.2.0 breaks --emit-json-stdout", "timeSpent": "PT0S", "updated": "2018-03-01T11:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This ticket is mostly for the .travis.yml work (updating testing matrix). The gemspec still needs to be updated but that will happen at release time.", "created": "2018-03-22T15:01:00.000000" } ], "components": [], "created": "2018-02-28T11:46:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@460067e7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkbq7:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1889171381_*|*_3_*:*_1_*:*_19720131_*|*_5_*:*_1_*:*_0" } ], "description": "Old Ruby and old Puppet are old. As part of the 2.0.0 major release, we will be dropping support for older Ruby and Puppet versions to modernize the gem and keep in line with the Puppet ecosystem.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32503", "fixedVersions": [], "id": "32503", "issueType": "Task", "key": "PDOC-223", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-03-22T15:01:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Drop Ruby < 2.1.9 and Puppet < 4", "timeSpent": "PT0S", "updated": "2018-03-22T15:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [], "components": [], "created": "2018-02-28T11:24:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@425d4f2a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkbpj:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9943_*|*_3_*:*_1_*:*_2762681_*|*_5_*:*_1_*:*_0" } ], "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32469", "fixedVersions": [], "id": "32469", "issueType": "Task", "key": "PDOC-222", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-02-28T12:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release 1.2.0", "timeSpent": "PT0S", "updated": "2018-02-28T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-27T14:39:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5f2ee5e3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-219" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkatz:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_36977327798_*|*_5_*:*_1_*:*_0" } ], "epicLinkSummary": "Puppet Strings 2.1.0", "estimate": "PT0S", "externalId": "32547", "fixedVersions": [], "id": "32547", "issueType": "Task", "key": "PDOC-221", "labels": [], "originalEstimate": "PT0S", "parent": "32409", "parentSummary": "Puppet Strings 2.1.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Done", "resolutionDate": "2019-05-01T15:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release 2.1.0", "timeSpent": "PT0S", "updated": "2019-05-01T15:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-27T14:38:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1080099b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkatr:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_6203317888_*|*_10007_*:*_1_*:*_23990421_*|*_3_*:*_2_*:*_81650958_*|*_5_*:*_1_*:*_0" } ], "description": "Released 2.0.0 (abf5c636a047a73ca7895e96315483ea3b01e5f9)", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32510", "fixedVersions": [], "id": "32510", "issueType": "Task", "key": "PDOC-220", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-05-11T16:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release 2.0.0", "timeSpent": "PT0S", "updated": "2018-05-11T16:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-27T14:27:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60423224" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-8" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet Strings 2.1.0" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_purple" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkas7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_36978468471_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32409", "fixedVersions": [], "id": "32409", "issueType": "Epic", "key": "PDOC-219", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2019-05-01T15:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings 2.1.0", "timeSpent": "PT0S", "updated": "2019-05-01T15:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-27T14:19:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@22a0eaef" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-5" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet Strings 1.2.0" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_teal" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkarz:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_78680521_*|*_6_*:*_2_*:*_575618_*|*_10010_*:*_1_*:*_1018370" } ], "description": "Describes content of version 1.2.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32468", "fixedVersions": [], "id": "32468", "issueType": "Epic", "key": "PDOC-218", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-02-28T12:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings 1.2.0", "timeSpent": "PT0S", "updated": "2018-02-28T12:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Done!", "created": "2018-02-27T14:31:00.000000" } ], "components": [], "created": "2018-02-27T14:11:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5dc7c46b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkarr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Feb/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1198461_*|*_5_*:*_1_*:*_0" } ], "description": "Please add Eric Putnam (putnam.eric@gmail.com) as an owner of the puppet-strings gem for releasing. https://rubygems.org/gems/puppet-strings", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32440", "fixedVersions": [], "id": "32440", "issueType": "Story", "key": "PDOC-217", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-02-27T14:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "add Eric Putnam as a gem owner", "timeSpent": "PT0S", "updated": "2018-02-27T14:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [], "components": [], "created": "2018-02-22T17:59:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@251a8f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk7jj:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_418139870_*|*_5_*:*_1_*:*_0" } ], "description": "This is for tracking a once over on markdown generation functionality.\n- Classes that are marked private appear as empty headings in the markdown (@api tag needs to be added to style guide)", "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32583", "fixedVersions": [], "id": "32583", "issueType": "Story", "key": "PDOC-216", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-02-27T14:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Iterate on markdown feature", "timeSpent": "PT0S", "updated": "2018-02-27T14:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-15T10:37:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3dfbbf90" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk24v:" } ], "description": "There is currently no way to document type aliases using Strings.\n\nThey are not really mentioned in any of the documentation, or the proposed style guide for Strings.\n\nThey are ignored when documentation is rendered. If a class param uses them, it shows the name of the alias, but NOT what it makes up.\n\n\u00a0\n\nThere should be some way to separately document these, and the param type listing should link to it or provide it as an expandable element or such.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32408", "fixedVersions": [], "id": "32408", "issueType": "New Feature", "key": "PDOC-215", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Type aliases are not handled well", "timeSpent": "PT0S", "updated": "2019-10-11T20:38:00.000000", "votes": "3", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-02-15T10:34:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@68455ca7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk24n:" } ], "description": "There should be a simple, documented method for customizing the rendered HTML output - adding custom sections or reordering things, applying custom CSS, etc.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32395", "fixedVersions": [], "id": "32395", "issueType": "New Feature", "key": "PDOC-214", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add ability to customize the template", "timeSpent": "PT0S", "updated": "2018-02-15T10:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "body": "Referencing @note from the style guide should be removed until this ticket is completed. https://puppet.com/docs/puppet/5.5/puppet_strings_style.html#classes-and-defined-types", "created": "2018-05-29T07:48:00.000000" } ], "components": [], "created": "2018-02-15T10:33:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@18dcc19c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-219" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk247:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1052623545_*|*_10007_*:*_1_*:*_27556296666_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9419999784" } ], "description": "Strings should support the @note YARD tag in rendered documentation.", "epicLinkSummary": "Puppet Strings 2.1.0", "estimate": "PT0S", "externalId": "32582", "fixedVersions": [], "id": "32582", "issueType": "New Feature", "key": "PDOC-213", "labels": [], "originalEstimate": "PT0S", "parent": "32409", "parentSummary": "Puppet Strings 2.1.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "resolution": "Fixed", "resolutionDate": "2019-05-01T15:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for @note tag", "timeSpent": "PT0S", "updated": "2019-05-01T15:08:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This has been requested by many community members", "created": "2018-02-27T14:43:00.000000" } ], "components": [], "created": "2018-02-15T10:32:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d8ea7fa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-219" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk23z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Feb/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1051846952_*|*_10007_*:*_1_*:*_27556280419_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9420836973" } ], "description": "Strings should support the YARD @todo tag in rendered documentation.", "epicLinkSummary": "Puppet Strings 2.1.0", "estimate": "PT0S", "externalId": "32499", "fixedVersions": [], "id": "32499", "issueType": "New Feature", "key": "PDOC-212", "labels": [], "originalEstimate": "PT0S", "parent": "32409", "parentSummary": "Puppet Strings 2.1.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "resolution": "Fixed", "resolutionDate": "2019-05-01T15:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for @todo tag", "timeSpent": "PT0S", "updated": "2019-05-01T15:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c09d27910a200718b903c", "body": "I'd like to second this.\u00a0 Using puppet strings server is not practical in our environment because of security concerns.\n\n\u00a0\n\nAs of now, there's no way to extract the same content that server generates for use in any other context.\u00a0 I'd prefer be able to autogenerate documentation for the whole environment as puppet strings server displays and deploy the result to a webserver like Apache where I can wrap it in authentication.", "created": "2018-07-19T08:37:00.000000" } ], "components": [], "created": "2018-02-15T10:28:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@41a7864c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzk23r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Jul/18" } ], "description": "when you run `puppet strings server` it parses all the modules in your modulepath and then generates a master/meta index.\n\n\u00a0\n\nThis is not currently possible to do using `puppet strings generate` which is done per module.\n\n\u00a0\n\nIt would be super useful to be able to feed generate a list of modules or a modulepath and have it generate documentation like puppet strings server does.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32546", "fixedVersions": [], "id": "32546", "issueType": "New Feature", "key": "PDOC-211", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for generating a \"meta index\"", "timeSpent": "PT0S", "updated": "2018-07-19T08:37:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:468002b0-7677-4624-b195-4b7b813f8dc1", "attachments": [], "comments": [], "components": [], "created": "2018-02-08T11:21:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69fe1d95" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt7z:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4724345527_*|*_10007_*:*_1_*:*_2611640341_*|*_3_*:*_1_*:*_269234377_*|*_5_*:*_1_*:*_0" } ], "description": "Update puppetlabs-mysql with strings docs to use as a proof of concept ahead of publicizing strings.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32497", "fixedVersions": [], "id": "32497", "issueType": "Task", "key": "PDOC-210", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-05-07T12:55:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add puppet-strings docs to puppetlabs-mysql as a POC", "timeSpent": "PT0S", "updated": "2018-05-07T12:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-01-27T12:37:00.000000", "creator": "623c12b950bb2b0070b6b384", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@11a49266" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt4f:" } ], "description": "I would like to pass :yard_args => '--output-dir public' in the rake strings:generate task. However, since the :json argument is considered before :yard_args, then HTML output is disabled and only the JSON output is produced.\n\nFor example, this is the command-line example presented in the Puppet Strings README:\n\n{{rake 'strings:generate[**/*.pp, true, true, markdown, test.json, --output-dir\\ public]'}}\n\nRunning this command generates a file named \"--output-dir public\" containing the JSON output.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32508", "fixedVersions": [], "id": "32508", "issueType": "Bug", "key": "PDOC-208", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c12b950bb2b0070b6b384", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Unable to pass :yard_args to rake strings::generate without generating json", "timeSpent": "PT0S", "updated": "2019-08-06T17:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2018-01-25T14:56:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2fee4a26" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt73:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" } ], "description": "See PDOC-193 for info on existing yard tool.\n\n\nYou can see this in raw action by simply calling the CLI tool from the PuppetStrings.generate method and then running strings on a module.\n{code:ruby}\nYARD::CLI::I18n.run(search_patterns)\n{code}\n\nSee from the attached file, there's a lot of stuff that we won't want in there. It will be confusing to the translator and lots of unnecessary work. A few examples:\n\nA lot of tags get the tag itself extracted into a msgid that looks like the one here:\n{code}\n# @param [String]\n#: ../lib/puppet/type/radius.rb:3\n#: ../manifests/install.pp:10\nmsgid \"tag|param|name\"\nmsgstr \"\"\n{code}\nFirst of all, we don't want the param name translated. Second, that's just confusing to look at.\n\nIn other cases, we _do_ want part of this msgid. This mostly occurs in examples:\n{code}\n# @example\n#: ../lib/puppet/type/radius.rb:3\nmsgid \"tag|example|Here's an example\"\nmsgstr \"\"\n{code}\n\nFinally, we don't want to translate code examples, obviously\n{code} \n# @example Using the type.\n#: ../lib/puppet/type/test.rb:3\nmsgid \"test { 'mctesterson':\\n\"\n\" foo => 'hi',\\n\"\n\" my_prop => 'bar',\\n\"\n\"}\"\nmsgstr \"\"\n{code}\n\n\nThe attached file also includes the README, which we may or may not want to pursue.\n\nSo *this work probably involves*\n1. Running the #run method as suggested above\n2. Some kind of post-processing? I actually don't have a good idea. Monkey patching?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32545", "fixedVersions": [], "id": "32545", "issueType": "New Feature", "key": "PDOC-207", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "i18n in puppet-strings", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [], "components": [], "created": "2018-01-25T14:53:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c532717" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt2f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_25135_*|*_10007_*:*_1_*:*_727909473_*|*_3_*:*_1_*:*_1835164309_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2252409609" } ], "description": "puppet-strings cannot currently document Puppet Tasks. Since we pushed Tasks so hard this past year, it would be a good/nice-to-have idea to have this capability out of the box for a 2.0.0.\n\nWe only need to parse the Task metadata, especially because you can write a Task in any language.\n\nOnly use keys that are already available in the task metadata. No fancy yard tag stuff from the description.\n\nProbably don't need a handler but maybe? Otherwise go straight to code object -> registry -> render", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32505", "fixedVersions": [], "id": "32505", "issueType": "New Feature", "key": "PDOC-206", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-03-22T09:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Task documentation capability", "timeSpent": "PT0S", "updated": "2018-03-22T09:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Duplicate of PDOC-184. However, an epic _does_ need to be created around documenting our modules and generating the REFERENCE.md.", "created": "2018-02-07T11:51:00.000000" } ], "components": [], "created": "2018-01-23T12:54:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "all strings data is used to generate a file called REFERENCE.md" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@225522ab" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzjg73:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_179726833_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1112476246" } ], "description": "Related to PDOC-131 sort of.\n\nInstead of generating entire README, we've instead decided to compromise on a REFERENCE.md. \n\nThis will be puppet-strings data in a format (markdown) that CS has said is valuable while taking a large burden off of the README.\n\npuppet-strings will need to be able to generate this markdown which will just be taking the Yard registries and organizing the data into acceptable looking markdown, in a file called REFERENCE.md.\n\nIn the cli, we can either create a new --emit-markdown option or create a --format and use it for both json and markdown.\n", "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32494", "fixedVersions": [], "id": "32494", "issueType": "New Feature", "key": "PDOC-197", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Duplicate", "resolutionDate": "2018-02-07T11:51:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Generate REFERENCE.md", "timeSpent": "PT0S", "updated": "2018-02-27T14:20:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:caae9c58-399c-4716-be37-c404839c368a]! For now, I've PR'd a fix to the README, and we've noted this in our puppet-strings guidelines (these are in progress and a draft should be available soon).", "created": "2018-01-19T15:12:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Closed by PDOC-76 and https://github.com/puppetlabs/puppet-strings/pull/151", "created": "2018-01-24T15:19:00.000000" } ], "components": [], "created": "2018-01-09T12:31:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@80cc537" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzj37b:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Jan/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_872833084_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_433244704" } ], "description": "The docs for Strings states:\n{quote}\nThe most commonly used tags for Strings are:\n...\nFor a complete list of tags, see the [YARD Tags Overview|http://www.rubydoc.info/gems/yard/file/docs/Tags.md].{quote}\n\nThis implies that while the tags in the list are the most often used ones, any valid tag can be used.\n\nHowever, when I used the {{@todo}} and {{@note}} tags they did not show up in my rendered HTML documentation as expected.\n\nThis ticket is intended to request that support for the additional tags be added, and that the documentation be updated to reflect actual behavior in the mean time since adding the tags may be non-trivial.\n", "environment": "Strings 1.1.1, yard 0.9.9, Ruby 2.1.9p490 (2016-03-30 revision 54437) [i386-mingw32], puppet 4.5.3 on win7\n\nStrings command ran from a \"Start command prompt with puppet\" instance, non-admin user", "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32581", "fixedVersions": [], "id": "32581", "issueType": "Bug", "key": "PDOC-196", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "resolution": "Fixed", "resolutionDate": "2018-01-24T15:19:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Documentation misleading about acceptable tags", "timeSpent": "PT0S", "updated": "2018-02-27T14:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-12-19T12:05:00.000000", "creator": "5c37a1aa1c6a692feab9b753", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5df60fb3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt47:" } ], "description": "When the server is started via *puppet strings server*,\n\nI can navigate to the modules and their init classes but cannot navigate to other classes within the module. When I click on the link to any other class other than init, the webpage displays:\n\nCould not find object: puppet_classes::_3A_3A", "environment": "puppet resource package puppet-strings\npackage { 'puppet-strings':\n ensure => ['1.1.1'],\n}\n\npuppet resource package yard\npackage { 'yard':\n ensure => ['0.9.12'],\n}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32467", "fixedVersions": [], "id": "32467", "issueType": "Bug", "key": "PDOC-195", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "5c37a1aa1c6a692feab9b753", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Could not find object: puppet_classes::_3A_3A", "timeSpent": "PT0S", "updated": "2019-08-06T17:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-12-13T12:58:00.000000", "creator": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5892774f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hziv3j:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_41130699688_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32337", "fixedVersions": [], "id": "32337", "issueType": "Task", "key": "PDOC-194", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "resolution": "Fixed", "resolutionDate": "2019-04-03T15:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "investigate using modules to replace current script automation", "timeSpent": "PT0S", "updated": "2019-04-03T15:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "created": "2018-06-08T15:28:00.000000", "name": "yard.pot", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12380" } ], "comments": [], "components": [], "created": "2017-12-13T07:03:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@406ecf17" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt7b:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" } ], "description": "Since 0.8.0 yard has included an {{i18n}} subcommand to place all the doc strings into a .pot file. It seems like if we just run this automatically when a user invokes {{puppet strings}} that would go a long way to enabling i18n workflows for module documentation.\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32544", "fixedVersions": [], "id": "32544", "issueType": "Task", "key": "PDOC-193", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Evaluate using `yard i18n` to extract doc string content into POT files", "timeSpent": "PT0S", "updated": "2019-09-04T10:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-12-07T15:41:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@111c0fae" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt7r:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_5908_*|*_1_*:*_1_*:*_4230431442_*|*_10007_*:*_1_*:*_414572009_*|*_3_*:*_1_*:*_1365629_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4835667029" } ], "description": "Currently, if you try to document a parameter called \"title\", Strings throws a warning saying there's no such parameter. This is, of course, untrue and there should be an exception for it. There should also not be a warning for \"name\".\n\nThis is probably a warning based on Puppet keywords.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32407", "fixedVersions": [], "id": "32407", "issueType": "Bug", "key": "PDOC-192", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2018-03-27T10:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Remove warning for $title parameter ", "timeSpent": "PT0S", "updated": "2018-03-27T10:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7], do you know if the @summary tag for puppet-strings has any specific use? Was the plan for the Forge to consume it in a particular way or...?", "created": "2017-11-17T17:59:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "See https://puppet.atlassian.net/browse/PDOC-161 for the origins of the summary tag.", "created": "2017-11-20T10:40:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This ticket is a bit redundant. We're tracking style guide work in PDOC-186", "created": "2018-01-23T12:31:00.000000" } ], "components": [], "created": "2017-11-17T17:57:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Expect Style Guide to:\n \n- Contain examples for documenting each type of component:\n-- class\n-- defined type\n-- function\n-- custom type\n-- provider\n-- fact\n- explain how each tag should be used" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@489a3d8e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyl88n:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Nov/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_847794_*|*_3_*:*_1_*:*_5768431612_*|*_5_*:*_1_*:*_0" } ], "description": "Tagging [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79]\n\nWe'll need to figure out how each component should be documented. I think we can re-use a lot from the [puppet-strings README|https://github.com/puppetlabs/puppet-strings/blob/master/README.md#documenting-puppet-code-for-strings].\n\nSome questions we already have:\nWhat is the @summary tag for? \n_The existence of 'overview' makes it seem redundant, however after speaking with Vox briefly, it seems like people pick one or the other to use and stick with that. It may have some kind of usage with the Forge or something._\nShould examples be included with their respective component or broken out into a Usage section?", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32580", "fixedVersions": [], "id": "32580", "issueType": "Task", "key": "PDOC-190", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Duplicate", "resolutionDate": "2018-01-23T12:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create Style Guide Proposal", "timeSpent": "PT0S", "updated": "2018-02-08T11:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-11-02T10:44:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@151a32aa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-4" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet Strings 2.0.0" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_blue" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzhxyf:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1663768196_*|*_6_*:*_1_*:*_0_*|*_10013_*:*_2_*:*_12881811295_*|*_10015_*:*_2_*:*_3098128182" } ], "description": "The next steps to get strings to a state where we and the community agree it's actually complete.\n\n*This epic deals with puppet-strings directly, not Forge or other work.*\nSee PF-1437 for Forge stuff.\n\nMore details in this doc:\nhttps://docs.google.com/document/d/1Tj1Y_RxKzP5lGJKXwxQWzNpYu_wVMpYF4JTuhkc2oqw/edit", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32609", "fixedVersions": [], "id": "32609", "issueType": "Epic", "key": "PDOC-183", "labels": [ "iac_feature" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2018-05-25T15:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings 2.0.0", "timeSpent": "PT0S", "updated": "2020-01-02T06:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-10-31T09:15:00.000000", "creator": "557058:dd7ba664-1e31-4b6c-9525-768d1f3babc2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Ability to specify a git remote such as 'upstream' and have the strings:gh_pages:update rake task push the gh-pages branch to that remote.\n\nSuggest implementing through an environment variable so it is easily configurable and does not need to be checked in to the module as it could be different for each collaborator." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7b3144a4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzhw6v:" } ], "description": "The current behavior of running the rake task strings:gh_pages:update is for it to create a branch named gh-pages and force push that to the origin git remote.\n\nAs a collaborator on projects, this means that a branch is pushed to my fork and not to the upstream remote where it should be.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32336", "fixedVersions": [], "id": "32336", "issueType": "New Feature", "key": "PDOC-181", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:dd7ba664-1e31-4b6c-9525-768d1f3babc2", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Allow specifying a git remote for the strings:gh_pages:update task", "timeSpent": "PT0S", "updated": "2017-10-31T09:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "PDOC-206", "created": "2018-03-05T12:33:00.000000" } ], "components": [], "created": "2017-10-27T12:18:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17ba651f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-9" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "puppet-strings Tasks support" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "orange" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzht3z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_11150078832_*|*_6_*:*_1_*:*_0" } ], "description": "puppet-strings should know how to document tasks in a module based on task metadata", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32335", "fixedVersions": [], "id": "32335", "issueType": "Epic", "key": "PDOC-180", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "resolution": "Duplicate", "resolutionDate": "2018-03-05T12:33:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings Tasks support", "timeSpent": "PT0S", "updated": "2018-03-26T13:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This ticket does not block a new puppet-strings release", "created": "2018-02-08T11:25:00.000000" } ], "components": [], "created": "2017-10-26T10:07:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7cdfcfa5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt87:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Feb/18" } ], "description": "This ticket is super vague but integration with the PDK should probably be on the roadmap somewhere...\n\n- add gem to PDK cache (may already be done)\n- add recommended style of strings notation into PDK templates\n- cli front-end for running puppet-strings", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32608", "fixedVersions": [], "id": "32608", "issueType": "Story", "key": "PDOC-189", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "PDK Integration", "timeSpent": "PT0S", "updated": "2019-05-01T15:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:468002b0-7677-4624-b195-4b7b813f8dc1", "body": "\\o/", "created": "2018-05-07T12:54:00.000000" }, { "author": "557058:468002b0-7677-4624-b195-4b7b813f8dc1", "body": "Bah, wrong ticket", "created": "2018-05-07T12:55:00.000000" } ], "components": [], "created": "2017-10-26T10:07:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4d558311" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt8v:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7882701753_*|*_10007_*:*_2_*:*_2853714800_*|*_3_*:*_1_*:*_540039861_*|*_5_*:*_2_*:*_70171_*|*_10005_*:*_1_*:*_6003646232" } ], "description": "# Open marketing ticket\n # Fill out template (on google docs)\n # Do words\n # Get review\n\nwords due. do words.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32490", "fixedVersions": [], "id": "32490", "issueType": "Task", "key": "PDOC-187", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "resolution": "Fixed", "resolutionDate": "2018-05-14T10:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings 2.0.0 improvements blog post", "timeSpent": "PT0S", "updated": "2018-05-14T10:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This ticket is no longer valid.\n\nIf there is documentation in the source code, we will generate REFERENCE.md and the information will be removed from the README. Boom. ", "created": "2018-01-25T14:10:00.000000" } ], "components": [], "created": "2017-10-26T10:07:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a9e83cc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzhs2f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jan/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7880592862_*|*_6_*:*_1_*:*_0" } ], "description": "Rolling out strings will eventually require us to remove the long reference sections from module READMEs. This will be a big change for a lot of users, so we'll want to make sure that strings docs are 100% ready to go before we start removing reference sections.\n\nAs such, it will be necessary to have an interim step where we have docs both in the README and as comments in the source code. In order to manage this reasonably, we'll want to have the comments be the source of truth and run strings against them to update the README reference section accordingly. The goal of this ticket is to add a feature that will let us do that.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32543", "fixedVersions": [], "id": "32543", "issueType": "Story", "key": "PDOC-185", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "resolution": "Won't Do", "resolutionDate": "2018-01-25T14:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Keep generated content in sync with static content in README automatically", "timeSpent": "PT0S", "updated": "2018-02-08T11:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I googled if someone had already implemented this for yard, and there seems to be some attempts, but since we use special templates for the HTML, it is probably best if we develop a set of markdown templates for yard ourselves (could be quite a lot of work, but probably better than tweaking someone else's half baked approach", "created": "2017-11-09T01:39:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "FYI [~accountid:557058:89652935-bbd6-4e26-afbf-0a04063f7db8]", "created": "2017-12-13T06:22:00.000000" } ], "components": [], "created": "2017-10-26T10:06:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@642573df" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt27:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Nov/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7608046307_*|*_10007_*:*_1_*:*_440001773_*|*_3_*:*_1_*:*_1233298627_*|*_10009_*:*_1_*:*_683626474_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_16790_*|*_10005_*:*_1_*:*_170632441" } ], "description": "We want to add Markdown as a third output option for strings (right now the only options are HTML and JSON). Markdown generation will probably look something like the way we generate JSON using the YARD registry https://github.com/puppetlabs/puppet-strings/blob/master/lib/puppet-strings/json.rb", "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32439", "fixedVersions": [], "id": "32439", "issueType": "New Feature", "key": "PDOC-184", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "resolution": "Fixed", "resolutionDate": "2018-02-20T16:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add ability to generate Markdown", "timeSpent": "PT0S", "updated": "2018-02-27T14:20:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:958f7ee7-5a93-4d32-9615-42ff2d57e18c] Are there still any plans for the content teams to adopt puppet-strings in more modules? (I hope so! Please let PDE know if there are functional blockers to that work in puppet-strings.) If so, does it make sense for the unresolved tickets in the epic to move into the MODULES project or similar? We'd like to make the PDOC project focused specifically on puppet-strings features, bugs, etc.", "created": "2019-05-02T14:38:00.000000" } ], "components": [], "created": "2017-10-26T10:06:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Scrum Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Modules" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a9d11ed" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Document Modules using puppet-strings" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzhs1z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_11244562067_*|*_6_*:*_1_*:*_0_*|*_10010_*:*_1_*:*_47228142357_*|*_10015_*:*_1_*:*_2363" } ], "description": "Eventually we should work towards Strings compatible comments in all puppetlabs supported modules (as this is the standard we're proposing other people hold their modules to). We should start though by picking a list of several modules, at least one or two of which are rather complicated, to document with Strings. That way, users have examples to look to when trying to figure out how to document their own modules.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32371", "fixedVersions": [], "id": "32371", "issueType": "Epic", "key": "PDOC-188", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "resolution": "Fixed", "resolutionDate": "2019-09-03T04:31:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Document our own modules with Puppet Strings", "timeSpent": "PT0S", "updated": "2019-09-03T04:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Just a note that this is something we should probably interface with Vox about. They've been using Strings in their modules for a while and probably have some good ideas around best practices we should take into account.", "created": "2017-11-07T15:35:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Work on this has started with [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79]. We discussed some things the other day and plan to have a proposal for PDE/Vox prepared by Dec 5, 2017.", "created": "2017-11-17T17:48:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Assigning this to myself as I work on drafting this and compiling feedback. That doesn't mean [~accountid:557058:42c68e91-7f1c-4767-895c-70596db6f3d8] is off the hook, though. :D\n", "created": "2018-01-16T12:17:00.000000" }, { "author": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] is this done now?", "created": "2018-05-11T10:09:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Yes, I should say so!", "created": "2018-05-11T10:50:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "[https://puppet.com/docs/puppet/latest/puppet_strings_style.html]\u00a0for watchers ", "created": "2018-05-11T11:04:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Oh, gosh, thank you [~accountid:557058:c5ea6c35-c500-4334-8131-e031af9f81a4]! :D I honestly forgot that folks might be watching the ticket.", "created": "2018-05-11T12:37:00.000000" } ], "components": [], "created": "2017-10-26T10:05:00.000000", "creator": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@332be994" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt1z:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Nov/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5965522563_*|*_3_*:*_1_*:*_11057962530_*|*_5_*:*_1_*:*_8819021104_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32406", "fixedVersions": [], "id": "32406", "issueType": "Story", "key": "PDOC-186", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:245824fd-f598-4b92-8f0c-3fa4078a3f9b", "resolution": "Done", "resolutionDate": "2018-08-21T12:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Comprehensive strings style guide", "timeSpent": "PT0S", "updated": "2018-08-21T12:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "DOCS" ], "created": "2017-10-12T12:20:00.000000", "creator": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@68982787" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzfpq7:" } ], "description": "It would be nice to be able to generate puppet-strings docs for custom ruby facts as well. \nAs of right now, documentation for any custom facts still has to live in the code comments or the README.md file.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32394", "fixedVersions": [], "id": "32394", "issueType": "New Feature", "key": "PDOC-179", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support Custom Ruby Fact documentation", "timeSpent": "PT0S", "updated": "2018-05-15T16:37:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This is by design. It may be possible to modify the yard settings to also get output of private API.", "created": "2017-10-02T18:36:00.000000" }, { "author": "62437c021da0e1007138c15e", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] I'm curious why this was done by design. If the module developers indicate that a class should be private, then it'd be nice if it showed up in the generated documentation.. but there might be some things that I haven't considered.", "created": "2018-06-26T13:02:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The thinking at the time was that users should not see and use those things anyway.", "created": "2018-06-26T13:31:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Strings will now render things marked with \"@api private\", but we still need to update the HTML templates so that things are appropriately marked as private. I've created PDOC-278 to track that.", "created": "2019-05-02T14:12:00.000000" } ], "components": [], "created": "2017-10-02T15:58:00.000000", "creator": "623c11ebee1b5a0070293512", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@48e89103" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzh6af:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Oct/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_49846419854_*|*_5_*:*_1_*:*_0" } ], "description": "As best I can tell, putting @api private doesn't seem to be adding any special text / banner to puppet strings generated docs.\n\n{code}\n# @api private\n# jmeter::install\n#\n# @summary This class installs JMeter (and, optionally, the plugin manager), from tarball. It also handles installing plugins.\n{code}\n\n{noformat}\ngreta~/git/puppet-jmeter(data_types|\u271a5)% gem list puppet-strings\n\n*** LOCAL GEMS ***\n\npuppet-strings (1.1.0)\n{noformat}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32502", "fixedVersions": [], "id": "32502", "issueType": "Bug", "key": "PDOC-178", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c11ebee1b5a0070293512", "resolution": "Fixed", "resolutionDate": "2019-05-02T14:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@api private not showing up in generated docs", "timeSpent": "PT0S", "updated": "2019-05-02T14:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "[~accountid:557058:ba2d08f5-8947-446f-bada-55ecb351d6cc] thanks for the note and hopefully after PuppetConf we can cut a new release", "created": "2017-10-05T15:13:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Version 1.1.1 was released on Oct 20 which should contain all previously unreleased fixes.", "created": "2017-11-02T13:12:00.000000" } ], "components": [], "created": "2017-09-21T18:14:00.000000", "creator": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e334207" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtqv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Oct/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1198742816_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_2411934158" } ], "description": "There are a few fixed in master branch that are not yet released as a ruby gem which means I need to install directly from git every time I want to use puppet-strings, would it be possible to get an updated gem released please? Thanks!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32370", "fixedVersions": [], "id": "32370", "issueType": "Bug", "key": "PDOC-177", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "resolution": "Fixed", "resolutionDate": "2017-11-02T13:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Updated puppet-strings rubygem release", "timeSpent": "PT0S", "updated": "2017-11-02T13:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-08-25T05:41:00.000000", "creator": "557058:b79f6a67-ae1f-4d72-9eca-fcfa9e4bdaab", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7c24284b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Method Found", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzg8db:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_237365_*|*_6_*:*_1_*:*_0" } ], "description": "The puppetlabs puppet_agent module, doesn't add the puppet 5 repos properly\n\nIt tries to install from a url which isn't valid for puppet 5 packages.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32542", "fixedVersions": [], "id": "32542", "issueType": "Bug", "key": "PDOC-176", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Blocker", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:b79f6a67-ae1f-4d72-9eca-fcfa9e4bdaab", "resolution": "Won't Do", "resolutionDate": "2017-08-25T05:45:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "The puppetlabs puppet_agent module, doesn't add the puppet 5 repos properly", "timeSpent": "PT0S", "updated": "2017-08-25T05:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "When considering adding support for hiera bindings it is also of value to make it possible to document default data bindings and lookup options. A module could for example come with lookup options configured for deep merge etc for some parameters, and could have defaults bound in hiera (as opposed to defaults in manifests). The most elegant would be if PDOC could pick up the information directly from hiera, but this gets complicated because information can come from any kind of backend. It is therefore best if this is documented in the puppet logic. If doing that, then there needs to be a structured way to mark up a parameter with such information.", "created": "2017-08-03T05:24:00.000000" }, { "author": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "body": "so you mean extend this ticket to cover if someone was using in-module\nhiera data to set defaults then pick up those and document what they\nresolve to? That would be even better and really useful. perhaps there\ncould even be some javascript magic so that you could see what defaults eg\nfor different OS's\n\nOn 3 Aug. 2017 21:25, \"Henrik Lindberg (JIRA)\" <\nissue-updates+HenrikLindberg@puppet.com> wrote:\n\nHenrik Lindberg\n\n*commented* on [image: New Feature] PDOC-171\n\n\nRe: generate the hiera keynames to use for parameterised classes\n\n\nWhen considering adding support for hiera bindings it is also of value to\nmake it possible to document default data bindings and lookup options. A\nmodule could for example come with lookup options configured for deep merge\netc for some parameters, and could have defaults bound in hiera (as opposed\nto defaults in manifests). The most elegant would be if PDOC could pick up\nthe information directly from hiera, but this gets complicated because\ninformation can come from any kind of backend. It is therefore best if this\nis documented in the puppet logic. If doing that, then there needs to be a\nstructured way to mark up a parameter with such information.\n[image: Add Comment]\n Add Comment\n\n\nThis message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)\n[image: Atlassian logo]\n", "created": "2017-08-03T18:51:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] How difficult would it be to just get defaults and not follow any logical paths? This is what is blocking us right now from putting all of our defaults in module data.\n\nAlso, is it actually a good idea to put all defaults in module data? This seems to be less readable and 'easy to use' for new users.", "created": "2019-02-06T12:19:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "Actually, thinking about this, it might be a LOT easier than going 'full Hiera':\n # If the hiera path has interpolation, the strings value becomes {{see in module}} data\n # If it does not, return the value\n\nThat should be it, right?", "created": "2019-02-06T13:15:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Applying heuristics like that would work - the documentation extraction would need to understand a hiera.yaml, understand if there is any interpolation in any layer, and if all layers are known data functions, further it must understand lookup options - if they are not, then it is not possible to statically compute the value that will be looked up.\n\nThe simple case: one level, one path pointing to a yaml file is doable - but then, must also look if the data is an alias, or contains interpolation. Information from lookup_options should also be taken into account since it is of interest to know if deep merge is turned on by the module's hiera data.\n\nSo, somewhat doable for the simplest case, but still quite a bit of work to get right.", "created": "2019-02-07T01:44:00.000000" } ], "components": [], "created": "2017-08-02T20:46:00.000000", "creator": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@32af19a6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzfppz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Aug/17" } ], "description": "It would be cool if puppet-strings could generate the keyname to use for hiera when documenting puppet classes.\n\nAt the moment parameters for say an {{motd}} class are documented like this:\n\n*Parameters:*\n* content (String) (defaults to: undef) \u2014 String to be used for motd\n* issue_content (String) (defaults to: undef) \u2014 String to be used for /etc/issue\n* issue_net_content (String) (defaults to: undef) \u2014 String to be used for /etc/issue.net identical_message (Boolean) (defaults to: false) \u2014 If true, use the main MOTD message for all messages unless overriden by issue_content and issue_net\n...\n\nI would like this to be enhanced with final name of the hiera key a user must add in order to set values, along the lines of:\n*Parameters:*\n* content (String) (defaults to: undef; hiera key motd::content) \u2014 String to be used for motd\n* issue_content (String) (defaults to: undef; hiera key motd::issue_content) \u2014 String to be used for /etc/issue\n* issue_net_content (String) (defaults to: undef; hiera key motd::issue_net_content) \u2014 String to be used for /etc/issue.net identical_message (Boolean) (defaults to: false) \u2014 If true, use the main MOTD message for all messages unless overriden by issue_content and issue_net\n\n*User benefit*\n* Impossible to make a typo - just copy and paste from the documentation\n* Encourages users to generate documentation, keep it updated and use it for reference\n* Makes it very obvious that automatic data binding is being used and how to use it\n* Improved efficiency from single step hiera keyname lookup - say you have a class {{profile::obisidian::client::oracle}} and parameter {{jdbc_options}} - computing the final key name for heira would typically be two copy and paste trips between windows, often with a single or triple colon used to interpolate the values due to user error. If typing out class names manually there's a good chance of a hard to spot typo instead. With the final keyname generated its just a single copy and paste job.\n* Removes the need for explicit hiera lookups in code as a way of mitigating the above\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32606", "fixedVersions": [], "id": "32606", "issueType": "New Feature", "key": "PDOC-171", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "generate the hiera keynames to use for parameterised classes", "timeSpent": "PT0S", "updated": "2019-02-07T01:44:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c100c4a57610068e74585", "body": "In the meantime it would be very helpful if a puppet-strings gem was released which depends on rgen.", "created": "2017-09-07T03:53:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Ping [~accountid:557058:c7e2df03-377d-4bf0-9407-106b8483430d] - what is the right thing to do here so the dependencies work ok.", "created": "2017-09-07T09:19:00.000000" }, { "author": "557058:c7e2df03-377d-4bf0-9407-106b8483430d", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd], not sure how to answer that. What dependencies? From Puppet? Or is the question how to create a Puppet Strings gem that depends on RGen? Confused...", "created": "2017-09-07T10:29:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "Right now we add rgen to our Gemfile if we need puppet-strings with Puppet 5 because puppet-strings does use it, but doesn't list it as a dependency. Until the dependency is no longer needed, it should be listed in puppet-strings dependencies.", "created": "2017-09-07T10:58:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "1.2.0 at least added the rgen dependency.", "created": "2018-03-01T04:37:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "If Puppet Strings wants to support both puppet 4 and 5 with the same version the puppet/strings combination will need RGen for as long as Puppet Strings supports puppet 4.", "created": "2018-03-01T14:15:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "I have no problem with that. Now that the dependency is in the gemspec I can remove the manual specification from my gemfiles.", "created": "2018-03-01T14:41:00.000000" } ], "components": [], "created": "2017-03-28T07:12:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@777befd3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt3z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Sep/17" } ], "description": "Starting with Puppet 5.0.0, the RGen gem is no longer used by Puppet. It should not be required by Puppet Strings.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32333", "fixedVersions": [], "id": "32333", "issueType": "Bug", "key": "PDOC-168", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "drop requirement for RGen gem for Puppet 5.0.0", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-03-21T02:50:00.000000", "creator": "557058:1a0b4537-0255-4113-93e1-2a192bed4235", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6539aa2c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt3r:" } ], "description": "I'm trying to add some custom documentation to my projects and tried adding my markdown documentation.\nThere are 2 problems about this (not sure if they're puppet strings related or yard related).\n\n1 - My main README.md file refer to other md file using [title](otherfile.md) syntax. It don't work (they are not translated). If i put the {file:otherfile.md title} syntax they work correctly but it's a pain because they will not display correctly into my gitlab environment.\n\n2 - When running a normal puppet strings run with the option \"--files docs/*.md\" to generate puppet and custom documentation puppet strings is not creating the file_list.html (and not putting the custom \"file\" link on the left tree). If i run puppet string without passing \".rb and .pp\" files but just the --files docs/*,md the file_type.html is created correctly.\nCommands that works (they will not create the custom doc): \n- rake strings:generate[\", false, false, markdown,,--files docs/*.md -r docs/README.md \"]\n- puppet strings (having --files *.md -r docs/README.md in .yardopts)\nCommand that don't work (don't create the file_type.html page):\n- rake strings:generate[\"site/**/*{.pp\\,.rb} manifests/site.pp, false, false, markdown\n- puppet strings generate site/profile/manifests/**/*.pp site/profile/functions/**/*.pp site/profile/manifests/**/**/*.pp\n\n", "environment": "RHEL 7\npuppet-agent-1.9.3-1.el7.x86_64\nyard (0.9.8)\npuppet-strings (1.1.0)\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32466", "fixedVersions": [], "id": "32466", "issueType": "Bug", "key": "PDOC-167", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1a0b4537-0255-4113-93e1-2a192bed4235", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Problem with file managed with --files (in .yardocs or using rake task)", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-03-16T16:09:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6194bd42" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzcorr:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_743188_*|*_6_*:*_1_*:*_0" } ], "description": "Build and release a new version of strings, largely to ship PDOC-161 (add a summary tag)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32501", "fixedVersions": [], "id": "32501", "issueType": "Task", "key": "PDOC-166", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Blocker", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Duplicate", "resolutionDate": "2017-03-16T16:21:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release new version of puppet-strings", "timeSpent": "PT0S", "updated": "2017-03-16T16:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-03-16T15:49:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5cbc166" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzcor3:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_333755999_*|*_3_*:*_1_*:*_2716945_*|*_6_*:*_1_*:*_0" } ], "description": "Skipping subtasks in favor or just commenting here.\n1. Is the code ready for release?\n\nCHANGELOG updated and gemspec version updated. Tests are all passing and all tickets for this release are resolved.\n\n2. Reconcile git commits and JIRA tickets\n\nAll commits have associated JIRA tickets (except maint commits).\n\n3. Is the Jira tidy-up done for this release and prepared for the next one?\n\nWe now have PDOC version 1.1.1 in JIRA.\n\nFilters:\nFixed in 1.1.0: https://puppet.atlassian.net/issues/?filter=25603\nIntroduced in 1.1.0: https://puppet.atlassian.net/issues/?filter=25604\n\n4. Prepare long form release notes:\n\nSubject: Announce: Strings 1.1.0 Released\n\nHello, all! Today we're releasing puppet-strings 1.1.0. This is a small release that includes two features: the new `summary` tag, and the ability to explicitly document the types of parameters in Puppet 4 code.\n\nFeatures:\n\n* The `summary` tag can be added to any code that puppet-strings supports. The recommended length limit for a summary is 140 characters. Warnings will be issued for strings longer than this limit.\n* Puppet 4 parameter types can now be (optionally) explicitly documented. Previously, this was not allowed because Puppet 4 parameter types can be automatically determined without extra documentation. However, users may desire to do so anyway for consistency. Strings will emit a warning if the documented type does not match the actual type. In such an event, the incorrect documented type will be ignored in favor of the real one. Note that this is purely optional - Strings will continue to automatically determine the types of Puppet 4 parameters without this documentation.\n\nNever used Strings? Check out our recent blog post to learn more! https://puppet.com/blog/using-puppet-strings-generate-great-documentation-puppet-modules\n\nThe ruby gem can be found here: https://rubygems.org/gems/puppet-strings\n\nFor installation and usage instructions, see https://github.com/puppetlabs/puppet-strings/blob/master/README.md.\n\nTo track issues related to this release or report issues, see the PDOC Jira project:\n\nJIRA Project: https://puppet.atlassian.net/browse/PDOC\nFixed in 1.1.0: https://puppet.atlassian.net/issues/?filter=25603\nIntroduced in 1.1.0: https://puppet.atlassian.net/issues/?filter=25604\n\n5. Tag the release\n\nTagged at commit eaa3d586590da9d17fc6549a1aa3160c067280b9.\n\n6. Build and smoke test gem\n\nSmoke tested on centos 7.\n\n7. Push tag to GitHub\n\nTag and gem pushed.\n\n8. Send out announcements\n\nAnnouncements sent to announce, users, and dev.\n\n9. Close all resolved tickets in JIRA.\n\nDone.\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32404", "fixedVersions": [ "PDOC 1.1.0" ], "id": "32404", "issueType": "Task", "key": "PDOC-165", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2017-03-20T13:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release puppet-strings 1.1.0", "timeSpent": "PT0S", "updated": "2017-03-20T13:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This would be a major undertaking as simply turning HTML pages into PDF is not likely to produce a very pleasing result. At a minimum you would probably need a clickable PDF TOC.\n\nJust a thought: Related is also the possibility to generate UNIX man-pages which would work for those that live on a textual CLI.\n\nMaybe there is a reasonable intermediate mark-up format that could be used to feed into generators for both \"pure text\" (i.e. man-pages), as well as PDF?\n", "created": "2017-02-24T10:37:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "ping [~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] [~accountid:623c08e1562ab90069f8aed4] [~accountid:62450221ad6b7e006aa4e34c]", "created": "2017-02-24T10:38:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "there is this thing for example: http://rtomayko.github.io/ronn/ronn.1", "created": "2017-02-24T10:41:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Well, I can definitely say we should not invest any further in Ronn, since it's abandonware based on multiple pieces of additional abandonware. \n\nBut it should be possible to build something that can make a mediocre PDF based on the JSON-with-markdown-fragments output we already have. And mediocre PDFs make the world go round, right? :D ", "created": "2017-03-30T15:51:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Ok, if that PDF gem is not something worth using, we could do a static markdown version. There are markdown to PDF tools out there if the desire is to have a PDF. Markdown could also pass as \"crappy plain text\".\n\nStill, the effort to produce reasonable quality markdown output is still quite substantial, and adds to what we need to maintain.\nAssigning this to [~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] as I think this is a product/priority decision regarding how valuable this proposed feature is.", "created": "2017-03-31T04:19:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "if it's a choice between markdown and PDF, I'd choose markdown every time.", "created": "2017-03-31T11:35:00.000000" }, { "author": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "body": "The latex project has a vast amount of very powerfull typesetting tools to create exquisite looking pdfs with all of the bells and whistles you could possibly wish for. I think it should certainly get some consideration. ", "created": "2017-09-29T02:45:00.000000" } ], "components": [ "CLI", "UX" ], "created": "2017-02-24T07:16:00.000000", "creator": "557058:ba2d08f5-8947-446f-bada-55ecb351d6cc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@77d43877" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzc27r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Feb/17" } ], "description": "It would be a great new feature of Puppet Strings if it could be used to generate a single PDF file documenting an entire module. This would make great leave-behind documentation for consultants who are required to hand over static documentation at the end of engagements. Of course, the HTML output is more useful but this would be a great addition for those who have no choice but to write reports for those who demand them.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32392", "fixedVersions": [], "id": "32392", "issueType": "New Feature", "key": "PDOC-164", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ba2d08f5-8947-446f-bada-55ecb351d6cc", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "PDF module documentation", "timeSpent": "PT0S", "updated": "2019-05-01T15:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:88257301-b238-491f-840a-7b39463c2b2d] try this: {{bundle exec puppet strings generate ./\\*\\*/\\*(.pp|.rb)}}. The search won't expand to all files in all subdirectories unless you include the {{**}}.\n\nEdit: hrm, Jira is messing with my formatting, should be good now.", "created": "2017-02-21T12:14:00.000000" }, { "author": "557058:88257301-b238-491f-840a-7b39463c2b2d", "body": "Thanks escaping * did the trick", "created": "2017-02-22T05:15:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Ah, good to hear! :D", "created": "2017-02-22T15:53:00.000000" } ], "components": [ "CLI" ], "created": "2017-02-20T05:27:00.000000", "creator": "557058:88257301-b238-491f-840a-7b39463c2b2d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "aa" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7627a212" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzbyaf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Feb/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_210369250_*|*_6_*:*_1_*:*_0" } ], "description": "I use this https://github.com/biemond/biemond-orawls/tree/puppet4 as source \n\nstrings does not generate pp from subfolders inside manifest dir\nbundle exec puppet strings generate ./**/*.pp\n\nbut when I do this \nexec puppet strings generate ./manifests/**/*.pp\nit only pickups everything except the manifest dir\n\n puppet (4.9.2)\n CFPropertyList (~> 2.2.6)\n facter (> 2.0, < 4)\n gettext-setup (>= 0.10, < 1)\n hiera (>= 2.0, < 4)\n json_pure (~> 1.8)\n locale (~> 2.1)\n puppet-strings (1.0.0)\n yard (~> 0.9.5)", "environment": "mac", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32487", "fixedVersions": [], "id": "32487", "issueType": "Bug", "key": "PDOC-163", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:88257301-b238-491f-840a-7b39463c2b2d", "resolution": "Cannot Reproduce", "resolutionDate": "2017-02-22T15:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "failed to generate all docs when there are subfolders inside the manifest dir", "timeSpent": "PT0S", "updated": "2017-02-22T15:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:88257301-b238-491f-840a-7b39463c2b2d", "body": "duplicate of #PDOC-163", "created": "2017-02-20T05:30:00.000000" } ], "components": [ "CLI" ], "created": "2017-02-20T05:21:00.000000", "creator": "557058:88257301-b238-491f-840a-7b39463c2b2d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2cdf40d8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzbya7:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_532410_*|*_6_*:*_1_*:*_0" } ], "description": "Hi \n\nwhen I generate docs on https://github.com/biemond/biemond-orawls/tree/puppet4 based on this \nbundle exec puppet strings generate ./manifests/**/*.pp\nI will get all pp files from the subfolders but not from the manifest dir\n\nwhen I do this \nbundle exec puppet strings generate ./**/*.pp\nI will get all pp files from the subfolders but only from the manifest dir and not the subfolders\n\n puppet (4.9.2)\n CFPropertyList (~> 2.2.6)\n facter (> 2.0, < 4)\n gettext-setup (>= 0.10, < 1)\n hiera (>= 2.0, < 4)\n json_pure (~> 1.8)\n locale (~> 2.1)\n puppet-strings (1.0.0)\n yard (~> 0.9.5)", "environment": "mac", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32540", "fixedVersions": [], "id": "32540", "issueType": "Bug", "key": "PDOC-162", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:88257301-b238-491f-840a-7b39463c2b2d", "resolution": "Duplicate", "resolutionDate": "2017-02-20T05:30:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "failed to generate all docs when there are subfolders inside the manifest dir", "timeSpent": "PT0S", "updated": "2017-02-20T05:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:b2a437da-24ad-4861-8fa8-5973b0d167ed", "body": "There's some additional discussion about this in the following Google Group thread:\nhttps://groups.google.com/a/puppet.com/forum/#!topic/cs-architecture/svLAQDD4x4s", "created": "2017-02-17T16:35:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "[~accountid:623cffe88d8b9c0068b93ebf], [~accountid:62450221ad6b7e006aa4e34c], [~accountid:557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c]: any reasons why the proposed solution isn't the way to go?", "created": "2017-02-17T23:36:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "[~accountid:70121:daea3119-cdf4-43ae-bb73-2d9ef9d71335] asked me about this last week, and we discussed a range of options. As far as we could tell, there is no way to add tags without adding a few lines of ruby to the yard processor, therefore this is necessary.\n\nGiven the target group (VRA users and their role&profile classes) and purpose (UI specific markup), a tag along the lines of {{puppet.vra.description}} made the most sense.\n\nOther options discussed were\n\n* generic summary tag: does not really help roles & profiles", "created": "2017-02-20T01:12:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "Why wouldn't a generic summary tag be sufficient? If it's well-known and you add it to your role classes, then the VRA use case would be satisfied without, as far as I can tell, negatively impacting the same tag at the component module or profile class levels.", "created": "2017-02-20T09:39:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "a generic tag is ineffective from both ends of the problem:\n\n* role and profile classes (which seem to be the primary target here) are written specifically for VRA estates, a generic tag doesn't help.\n* In my experience UI-specific restrictions will be violated by innocent users of generic constructs, thereby leading to sub-optimal results (clipping, lack of information, etc).", "created": "2017-02-21T06:55:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "I chatted with [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02] and we decided that we *do* want a standard tag built-in so that multiple solutions can take advantage of the class short name. The burden of coping with the constraints of the tag will be on the consuming solution (VRA, Foreman, PE GUI eventually, etc.). For our part we'd want to evangelize its existence so that consuming solutions have content to take advantage of.", "created": "2017-03-14T15:28:00.000000" }, { "author": "70121:daea3119-cdf4-43ae-bb73-2d9ef9d71335", "body": "+1 to a tag called {{summary}} that will appear at least in the context of puppet classes, though I wouldn't be opposed to it showing up in the other types as well:\n\n{code}\n{\n \"puppet_classes\": [\n ],\n \"defined_types\": [\n ],\n \"resource_types\": [\n ],\n \"providers\": [\n ],\n \"puppet_functions\": [\n ]\n}\n{code}\n", "created": "2017-03-14T18:30:00.000000" } ], "components": [], "created": "2017-02-17T16:34:00.000000", "creator": "557058:b2a437da-24ad-4861-8fa8-5973b0d167ed", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@686fb943" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzby33:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Feb/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_333710025_*|*_1_*:*_1_*:*_2246324254_*|*_10007_*:*_1_*:*_80110962_*|*_5_*:*_1_*:*_2770785_*|*_6_*:*_1_*:*_0" } ], "description": "*Use Case:* Vendors like VMware would like a way to discover a list of role classes along with a description of the class. Right now they can pull a class name, but there isn't a standard way to retrieve a short description. puppet-strings is used to document puppet files, but it's also a great way to get easily parseable metadata about a puppet file via the JSON output option(s).\n\n*The Issue:* You can get the name from puppet-strings, but puppet-strings (and YARD itself) doesn't have a simple tag for a short description. There is the generic docstring text, but it's freeform and can be multiple lines. It's not ideal.\n\n*Solution:* Create a new \"summary\" tag (similar to puppet.type.param) for storing a short description with a recommended limit of 140 characters. This field should show up in the JSON output. ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32605", "fixedVersions": [ "PDOC 1.1.0" ], "id": "32605", "issueType": "Improvement", "key": "PDOC-161", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:b2a437da-24ad-4861-8fa8-5973b0d167ed", "resolution": "Fixed", "resolutionDate": "2017-03-20T12:30:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "As a developer I want to programmatically retrieve the name and short description from a puppet class", "timeSpent": "PT0S", "updated": "2017-03-20T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "One thing that complicates this is that other files may have cross references to the changed / added / removed files. So it becomes much more elaborate where it would need to generate all, and then compare what actually changed (except the timestamp). This unless there is some magic in yard that can do this.", "created": "2017-01-24T16:24:00.000000" }, { "author": "557058:724f8532-144f-4a06-830b-a614714244e4", "body": "How about if we just didn't add the date at all? I've created a PR to do this: https://github.com/puppetlabs/puppet-strings/pull/137\n\nOf course the file are all regenerated but with identical content, so only real changes will need to be committed to git. I've been trying this out locally and it works quite nicely", "created": "2017-03-11T04:16:00.000000" } ], "components": [], "created": "2017-01-23T16:25:00.000000", "creator": "557058:fc11868e-0146-4f3b-a79d-faf27cfd1154", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2313b16e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzbf5z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Jan/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38310196723_*|*_4_*:*_1_*:*_15474_*|*_5_*:*_2_*:*_12080" } ], "description": "Running puppet strings generate results in every file being updated with a new timestamp.\n\nI would like to be able to update docs only for changed files to remove checkins that have nothing other than updated timestamps.", "environment": "Puppet 4.7.0\nStrings 1.0.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32332", "fixedVersions": [], "id": "32332", "issueType": "Bug", "key": "PDOC-160", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:fc11868e-0146-4f3b-a79d-faf27cfd1154", "resolution": "Fixed", "resolutionDate": "2018-04-12T03:09:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "strings should be able to process only updated files", "timeSpent": "PT0S", "updated": "2018-04-12T03:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "body": "YARD's {{DisplayObjectCommand}} performs the lookup of an object from the URL path component and fails to URL-decode the object name to find it. This is only really an issue with Puppet Strings as it disables the normal namespacing of objects, so \"ntp::config\" is the full object name rather than \"config\" being namespaced under \"ntp\".\n\nYARD's serialisers perform URL-encoding on non-word characters, e.g. {{FileSystemSerializer#encode_path_components}} causing the path to contain \"_3A\" for a colon. I think this is probably only an issue when used with Puppet Strings as I can't think of a case where YARD would need URL encoding/decoding otherwise.\n\nHere's a temporary fix with a monkey patch to add in decoding of _3A: https://github.com/domcleal/puppet-strings/commit/a398e03493c0eea4dd1e30e85fab045bd106e18d", "created": "2017-01-17T01:39:00.000000" } ], "components": [], "created": "2017-01-16T06:01:00.000000", "creator": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7d0a1c4a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzkau7:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38952159480_*|*_10007_*:*_1_*:*_697319360_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_11655979" } ], "description": "Serving documentation for modules that contain classes with \"::\" causes 404s when trying to access those docs through the sidebar.\n\nFor example with puppetlabs/ntp 6.0.0 and running {{puppet strings server}}, the HTML sidebar links to {{docs/ntp/puppet_classes/ntp_3A_3Ainstall}} but the class docs are actually available at {{docs/ntp/puppet_classes/ntp/install}}.\n\nLogs show:\n\n{noformat}\nlocalhost - - [16/Jan/2017:07:56:48 EST] \"GET /docs/ntp/puppet_classes/ntp_3A_3Ainstall HTTP/1.1\" 404 55\nhttp://localhost:8808/list/ntp/puppet_class -> /docs/ntp/puppet_classes/ntp_3A_3Ainstall\nlocalhost - - [16/Jan/2017:07:56:54 EST] \"GET /docs/ntp/puppet_classes/ntp/install HTTP/1.1\" 200 4048\n- -> /docs/ntp/puppet_classes/ntp/install\n{noformat}\n\nThe {{generate}} mode works correctly however. It generates files at the ntp_3A_3Ainstall.html location, which the sidebar links to:\n\nntp/doc/puppet_classes/ntp_3A_3Aconfig.html\nntp/doc/puppet_classes/ntp_3A_3Aservice.html\nntp/doc/puppet_classes/ntp_3A_3Ainstall.html\nntp/doc/puppet_classes/ntp.html\n\nThis only seems to affect the server mode.", "environment": "puppet-strings 1.0.0\nyard 0.9.5\npuppet 4.8.1", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32391", "fixedVersions": [], "id": "32391", "issueType": "Bug", "key": "PDOC-159", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "resolution": "Fixed", "resolutionDate": "2018-04-20T08:00:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Links to classes containing \"::\" broken in server HTML sidebar", "timeSpent": "PT0S", "updated": "2018-04-20T08:00:00.000000", "votes": "4", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623a4744a95758006959fe55], another interesting suggestion. We are always accepting PRs! However, this may not be something that gets done by us in the near future.", "created": "2018-03-05T12:32:00.000000" } ], "components": [], "created": "2017-01-13T11:40:00.000000", "creator": "623a4744a95758006959fe55", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@712c14a4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzb7z3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "When formatting, warnings are printed for missing `@param` tags out but the exit status of the `puppet strings` face seems to always be `0`. It would be very useful to have a mode that disabled formatted output and makes warnings fatal (`exit != 0`). This would enable usage in a CI \"linting\" workflow to catch missing documentation for new parameters.", "environment": "puppet-strings-1.0.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32403", "fixedVersions": [], "id": "32403", "issueType": "New Feature", "key": "PDOC-158", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4744a95758006959fe55", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "linting of missing @params", "timeSpent": "PT0S", "updated": "2018-03-05T12:32:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Would be nifty. Goes in the nice-to-have bin.", "created": "2018-03-05T12:30:00.000000" } ], "components": [], "created": "2017-01-13T11:35:00.000000", "creator": "623a4744a95758006959fe55", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7c54cec0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzb7yv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "The HTML output does not include anchors for ``@param`` entries. It is incredibly convenient to be able to share a link directly to a parameter, which is in commonly done with GH rendered markdown README's for module documentation.", "environment": "puppet-strings-1.0.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32331", "fixedVersions": [], "id": "32331", "issueType": "New Feature", "key": "PDOC-157", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4744a95758006959fe55", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "HTML anchors for parameters", "timeSpent": "PT0S", "updated": "2018-03-05T12:30:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "I also just discovered that our handling of @api (in HTML) is buggy for functions. It only works for functions with multiple dispatches, and thus {{overload}} tags, i.e, this kind of works:\n\n{code}\n# Subtracts two things.\nPuppet::Functions.create_function(:subtract) do\n # @api private\n dispatch :subtract_ints do\n ...\n end\n\n dispatch :subtract_arrays do\n ...\n end\n\n def subtract_ints(x, y)\n x - y\n end\n\n def subtract_arrays(x, y)\n x - y\n end\nend\n{code}\n\n... but this doesn't:\n\n{code}\n# Subtracts two things.\nPuppet::Functions.create_function(:subtract) do\n # @api private\n dispatch :subtract_ints do\n ...\n end\n\n def subtract_ints(x, y)\n x - y\n end\nend\n{code}\n\nI believe this is because in the former, the docstring is wrapped in an {{overload}} tag which has its own template at {{lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb}}. This results in the overload having the bright warning in the HTML output, but only the overload which includes the tag. I *think* the presence of {{@api private}} for any overload should signify that they are all private, and the warning should be displayed above with the function overview.\n\nNote that the JSON output always includes the tag, so the scope of this change is limited to HTML output.", "created": "2017-01-11T13:49:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Users can now apply the @api tag to classes and defined types and see results in the generated markdown. Not sure about generated HTML.", "created": "2018-03-05T12:30:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "As Eric mentioned, this is now in place and markdown output has been updated. Still need to update HTML output but I created a separate issue to track that: PDOC-278", "created": "2019-05-02T14:14:00.000000" } ], "components": [], "created": "2017-01-11T13:17:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@587aa1e0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzb6kf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jan/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_36112369541_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_36549834264" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32498", "fixedVersions": [], "id": "32498", "issueType": "Improvement", "key": "PDOC-156", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2019-05-02T14:14:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support @api tag for classes (in addition to functions)", "timeSpent": "PT0S", "updated": "2019-05-02T14:14:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2017-01-10T11:50:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The following should run through strings correctly:\n{code}\n# @param [Regexp] param An example parameter.\nclass base(Regexp $param = /foobar/) {\n}\n{code}\n\nThe following should issue a warning:\n{code}\n# @param [String] param An example parameter.\nclass base(Regexp $param = /foobar/) {\n}\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5255bdae" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "No Action" }, { "fieldName": "QA Risk Assessment Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "covered by unit tests" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymeen:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7815_*|*_10007_*:*_1_*:*_264098377_*|*_3_*:*_1_*:*_1181585_*|*_5_*:*_1_*:*_5697868562_*|*_6_*:*_1_*:*_0" } ], "description": "Currently, you may not document the type of a parameter such as the following in puppet 4 code:\n\n{code}\n# @param [Regexp] param An example parameter.\nclass base(Regexp $param = /foobar/) {\n}\n{code}\n\nStrings emits a warning. However, users should have the option of adding this documentation. If the documented type differs from the actual type, strings should warn.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32495", "fixedVersions": [ "PDOC 1.1.0" ], "id": "32495", "issueType": "Improvement", "key": "PDOC-155", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2017-01-13T13:32:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should allow parameter types to be documented in Puppet 4 code", "timeSpent": "PT0S", "updated": "2017-03-20T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Agree.\nShould handle both the autoloaded data types as well as those defined locally in 4.x ruby functions. For the 4.x ruby functions the documentation should be kept on the function's page as the types are only valid locally for that function.", "created": "2016-12-20T06:33:00.000000" } ], "components": [ "UX" ], "created": "2016-12-19T10:41:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7d6d2c92" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzatrz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Dec/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38108737038_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_10077" } ], "description": "Presently there appears to be no provision or guidance on documenting custom Data Types in a way that Strings can automatically process.\n\nIt would be excellent to be able to document our Data Types as we create them moving forward.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32330", "fixedVersions": [], "id": "32330", "issueType": "Improvement", "key": "PDOC-154", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Duplicate", "resolutionDate": "2018-03-05T12:27:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should support documenting Data Types", "timeSpent": "PT0S", "updated": "2018-03-05T12:27:00.000000", "votes": "5", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "As a quick note, I also realized that this issue applies to the {{$name}} parameter in Defined Types", "created": "2016-12-12T12:15:00.000000" }, { "author": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "body": "(y) \n\nI think the inability to document {{$name}} bothers me the most\u2015it's a required parameter in every {{define\\{\\}}} and ought to be documentable.", "created": "2017-01-26T18:36:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "Is this looking to get fixed at any point? As [~accountid:557058:8b6a5143-cd16-434d-9c56-e1f3b642a830] mentioned, the inability to document {{$name}} without warnings is not good.", "created": "2017-08-01T09:10:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Hm, isn't {{$name}} an output parameter (after mangling etc) and {{$title}} the given id/name in the manifest? If so, it shouldn't it be the {{$title}} that you want to document. For user defined resources this may not matter since there is no mangling/munging taking place. PDOC should probably consider all meta parameters as being available for documentation.", "created": "2017-08-02T09:18:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] From the **user** point of view, {{$name}} is more commonly used that {{$title}} so it's what I would usually put in my docs.\n\nI also need to be able to document arbitrary variables of import that might be useful to users.\n\nI know that this is not a usual use case, but {{params.pp}} is going to be around until early Puppet 4 is completely dead (so 2 more years or so?).", "created": "2017-08-02T10:50:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "We are currently looking to remove this warning. PDOC-192", "created": "2018-03-05T12:25:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This warning has been removed in 2.0.0 (unreleased). New ticket created for other request PDOC-236", "created": "2018-04-12T07:25:00.000000" } ], "components": [ "DOCS" ], "created": "2016-12-12T11:11:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a416a1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzannj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Jan/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38711635672_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3261589823" } ], "description": "The following currently throws a {{warning}}:\n\n{code}\n# @param name [String]\ndefine foo {\n notify { 'My name is:' message => $name }\n}\n{code}\n\nSince {{$name}} is a **required** parameter for all defined types, we should be able to document it as a parameter.\n\nAlso, Consider the following, commonly used, {{params.pp}}\n\n{code}\nfoo::params {\n $bar = 'baz'\n}\n{code}\n\nIn this case, I would like to be able to declare that the {{$foo::params::bar}} variable is available for use but it is not a {{parameter}}.\n\nIdeally, this would be documented with the {{@!accessor [r]}} method, but, when I attempted to use this, an error was thrown.\n\nPresently, I'll continue using {{@param}} but it is inherently incorrect and a more correct alternative should be supplied.\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32537", "fixedVersions": [], "id": "32537", "issueType": "Bug", "key": "PDOC-153", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Fixed", "resolutionDate": "2018-04-12T07:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Users should be able to document the $name parameter of defined types", "timeSpent": "PT0S", "updated": "2018-04-12T07:25:00.000000", "votes": "8", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Not sure I follow the reasoning here - if you can set the parameters from outside, then the construct is not really private is it?\nThere is still value in producing documentation of private elements of the language for the purpose of helping those that maintain a module.\n\nNote that there will be proper support for private classes built into the puppet language. When that has been added, the {{@private}} yard tag can be inferred for those classes. Don't think it is worth digging out the use of {{assert_private}} as that will be replaced by the support in the language itself.", "created": "2016-12-12T05:39:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] You bring up a good point. Count this as my official vote toward adding a {{protected}} set of classes.\n\nI use {{assert_private()}} to ensure that users can't include classes that won't work without other parts of the module. This way I can strictly control, from the top level, how users should be using the module and it lets me logically split up my module into components.\n\nHowever, I do **not** want to have to repeat all 5 million parameters at the top level, that defeats a lot of the reason that I'm splitting things off into sub-classes.\n\nWhat I want is what I currently have, which I guess you could call {{protected}}, where I can control the class acesss and inclusion order and I can then allow the setting of various less-used parameters via data binding.\n\nAlternatively, classes could be {{private}} with parameters having a flag to be {{public}} or something like that. That said, my current parameters are already going over 140 characters and I'm starting to think that {{.h}} files are about to come back into style.", "created": "2016-12-12T06:56:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "What would {{protected}} mean? I am guessing that you cannot include them (unless from within the module), but you can set parameters via APL ?\nThe semantics for {{private}} has not been determined yet (we only have the keyword reserved at this point) - maybe that should mean that you are allowed to set parameters via APL since the module can, if it does not want to allow that, give all parameters explicitly.", "created": "2016-12-12T08:27:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Yes, this is exactly what I would need. I would expect my data bindings to work on {{protected}} classes but not {{private}} classes. Also, probably 99% of my classes (and probably everyone else's) would be {{protected}} because nobody wants to do the work to make sure that all parameters are exposed everywhere, nor do we want to deconflict the {{thing}} parameter from 4 different subclasses. That way lies reverting to the madness of {{params.pp}}.", "created": "2016-12-12T08:31:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We should have this discussion in PUP-523 as this ticket (PDOC-152) is about how the outcome of that ticket would look like when documented.", "created": "2016-12-12T08:58:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "marked as blocked by PUP-523", "created": "2016-12-12T09:01:00.000000" }, { "author": "557058:dce8a3bd-52a4-4c8d-a974-0f0aacd00e53", "body": "Discovered today that the {{@private}} tag is non-functionional in puppet classes/defines. It would be nice to somehow specify that a class/define is only thought to be used inside the module and that it is not a public interface (I'm thinking of the {{module::parms}}, {{module::install}}, {{module::service}} classes). Right now I added a \"THIS IS A PRIVATE CLASS\" heading to make it visible.", "created": "2017-01-13T12:30:00.000000" }, { "author": "5ac72d915fe4b660cda6eee6", "body": "I just stumbled across this issue because I wondered why the @private tag does not work. \nIs it really necessary have this blocked by the language implementation. It would be beneficial to have a generic way to document that a class/define is not meant to be used independent of actually enforcing it.\n\nAlso the readme simply says:\n??For a complete list of tags, see the YARD Tags Overview.?? and ??You can also include any number of YARD tags that hold semantic metadata for various aspects of the code.??\nwith no hint that only a subset of the tags is supported", "created": "2017-04-11T11:45:00.000000" }, { "author": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "body": "As a >3 year update to this discussion:\n * [@api private|https://puppet.com/docs/puppet/5.5/puppet_strings.html#available-strings-tags] has been available in Strings for some time to mark \"module elements\" like classes as private\n * PUP-523 was just transitioned from \"Designing\" back to \"Open,\" so the introduction of a {{protected}} keyword seems unlikely in the foreseeable future.", "created": "2020-05-06T10:07:00.000000" } ], "components": [ "DOCS" ], "created": "2016-12-11T11:11:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@463c3ca5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzang7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Dec/16" } ], "description": "With the advent of {{contain}} and {{assert_private()}} a consistent group of {{private}} classes have arisen.\n\nHowever, unlike many languages, Puppet private classes need to be documented and exposed to the user in case they want to set some of the more esoteric parameters of the classes.\n\nTo this end, I would like to recommend that a {{Private Puppet Classes}} be added and that the {{@private}} YARD tag be accepted to place classes into this group.\n\nAlternatively, detection of {{assert_private()}} could be used to note that a class is private to a module.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32493", "fixedVersions": [], "id": "32493", "issueType": "New Feature", "key": "PDOC-152", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "status": "Needs Information", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should support the documentation of private classes", "timeSpent": "PT0S", "updated": "2021-03-10T13:57:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "PDOC-213", "created": "2018-03-05T12:24:00.000000" } ], "components": [ "DOCS" ], "created": "2016-12-11T11:09:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@cc64f79" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzanfz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38798099542_*|*_6_*:*_1_*:*_0" } ], "description": "The {{@note}} Tag would be extremely useful for adding notes to the top of the rendered pages.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32465", "fixedVersions": [], "id": "32465", "issueType": "New Feature", "key": "PDOC-151", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Duplicate", "resolutionDate": "2018-03-05T12:24:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should support the @note Tag", "timeSpent": "PT0S", "updated": "2018-03-05T12:24:00.000000", "votes": "3", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a] it sounds like you may be talking about this issue which I raised against YARD: https://github.com/lsegal/yard/issues/1032. Does that look right?\n\nIt may be an issue with redcarpet, our markdown processing library. YARD delegates rendering markup to HTML to the markdown library, so the issue may be there.", "created": "2016-12-07T14:54:00.000000" }, { "author": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "body": "That is definitely very similar, if not the same, issue I'm seeing with the README markdown not being properly parsed/processed into HTML.\n\nI can see if something is open with the redcarpet project if you haven't already created one", "created": "2016-12-12T10:48:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a] This is still an issue, though not necessarily a bug. We would need puppet-strings to start pulling in other markdown files _or_ link out to github for things like CONTRIBUTING or MAINTAINERS, etc. Thoughts there? If someone is viewing the strings documentation, would they also want to see the contributing docs? Or would that be someone who is already on the github ui?", "created": "2018-04-12T02:30:00.000000" } ], "components": [], "created": "2016-11-29T16:21:00.000000", "creator": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@215adbc4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt3j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Dec/16" } ], "description": "When Puppet Strings turns the README.md into an HTML document, I have found that:\n\n# Markdown anchors are not properly converted and don't actually go anywhere when clicked.\n# Links to other Markdown files are converted to HTML expecting the referenced files to also have been converted into yardoc HTML, however puppet-strings is only aware of the README.md, not any other markdown files in the root of the repository and as such you end up with a link to a 404 message in the finished yardoc page.\n\nExample: \n\ndhollinger/autofs-puppet README references a CONTRIBUTING.md file for contribution guidelines. Puppet Strings sees that link and creates an HREF to this URL: \n\nhttps://dhollinger.github.io/autofs-puppet/CONTRIBUTING.md.\n\nMy guess is that it sees the github flavored markdown \"[CONTRIBUTING.md](CONTRIBUTING.md)\" and converts that directly to the the URL seen above without validating that an HTML or Markdown file exists in that path.\n\n\nNot sure if this is an issue related to the conversion of github flavored markdown to HTML or not, but I figured it'd be easiest to start the troubleshooting process here.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32390", "fixedVersions": [], "id": "32390", "issueType": "Bug", "key": "PDOC-150", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:ede431de-1cf3-4b55-8994-7e87bbe1f36a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "README links broken after being HTMLfied", "timeSpent": "PT0S", "updated": "2019-08-06T17:49:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Duplicate of DOCUMENT-597 (my bad!). Advice to use Strings has been added to the Style Guide, with a reference to the Puppet Strings docs. The style guide is not the right place for the instructions, despite my earlier comment.", "created": "2017-01-05T11:16:00.000000" } ], "components": [ "DOCS" ], "created": "2016-11-28T13:11:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6e7a0832" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzadmv:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_53017_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3276241621" } ], "description": "Style Guide: Replace documentation section and add in \"how to doc your code with Strings,\" from README at least)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32535", "fixedVersions": [], "id": "32535", "issueType": "Sub-task", "key": "PDOC-149", "labels": [], "originalEstimate": "PT0S", "parent": "32485", "parentSummary": "Update module-related docs for Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Duplicate", "resolutionDate": "2017-01-05T11:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Style Guide: add Strings info", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Documentation section added that points to module_documentation.html and the Language Style Guide.", "created": "2017-03-01T16:11:00.000000" } ], "components": [ "DOCS" ], "created": "2016-11-28T13:10:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7acbd8cd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzadmf:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_120726_*|*_5_*:*_1_*:*_32213020479_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_8045958151" } ], "description": "BGTM: https://docs.puppet.com/guides/module_guides/bgtm.html (doesn't talk about docs, but should mention and reference strings as part of code)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32463", "fixedVersions": [], "id": "32463", "issueType": "Sub-task", "key": "PDOC-148", "labels": [], "originalEstimate": "PT0S", "parent": "32485", "parentSummary": "Update module-related docs for Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Fixed", "resolutionDate": "2017-03-01T16:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "add Strings info to BGtM", "timeSpent": "PT0S", "updated": "2018-03-09T12:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [], "components": [ "DOCS" ], "created": "2016-11-28T13:09:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3e1d1f45" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzadm7:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_157862_*|*_5_*:*_1_*:*_33934350311_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_6324652162" } ], "description": "Revise module README template: https://docs.puppet.com/puppet/latest/reference/READMEtemplate.txt", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32438", "fixedVersions": [], "id": "32438", "issueType": "Sub-task", "key": "PDOC-147", "labels": [], "originalEstimate": "PT0S", "parent": "32485", "parentSummary": "Update module-related docs for Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Fixed", "resolutionDate": "2017-02-09T18:03:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Revise module README template", "timeSpent": "PT0S", "updated": "2018-03-09T12:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [], "components": [ "DOCS" ], "created": "2016-11-28T13:08:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@63cf3083" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzadlz:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_196461_*|*_5_*:*_1_*:*_48187803937_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_6324719238" } ], "environment": "Rewrite Documenting Modules page: https://docs.puppet.com/puppet/latest/reference/modules_documentation.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32604", "fixedVersions": [], "id": "32604", "issueType": "Sub-task", "key": "PDOC-146", "labels": [], "originalEstimate": "PT0S", "parent": "32485", "parentSummary": "Update module-related docs for Strings", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Done", "resolutionDate": "2018-08-21T12:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Rewrite Documenting Modules page", "timeSpent": "PT0S", "updated": "2018-08-21T12:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Resolving this as all the subtasks are done. Hooray!", "created": "2017-04-25T10:54:00.000000" } ], "components": [ "DOCS" ], "created": "2016-11-28T13:08:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "* " }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2d9d7fa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtpz:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_6301045156_*|*_3_*:*_1_*:*_6474509665_*|*_5_*:*_1_*:*_27483690513_*|*_6_*:*_1_*:*_0" } ], "description": "* Rewrite Documenting Modules page: https://docs.puppet.com/puppet/latest/reference/modules_documentation.html\n* Revise module README template: https://docs.puppet.com/puppet/latest/reference/READMEtemplate.txt\n* Add revised README template to pmt skeleton\n* BGTM: https://docs.puppet.com/guides/module_guides/bgtm.html (doesn't talk about docs, but should mention and reference strings as part of code)\n* -Style Guide: Replace documentation section and add in \"how to doc your code with Strings, from README at least)-", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32485", "fixedVersions": [], "id": "32485", "issueType": "New Feature", "key": "PDOC-145", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Fixed", "resolutionDate": "2017-04-25T10:54:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Update module-related docs for Strings", "timeSpent": "PT0S", "updated": "2018-03-09T12:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-11-23T14:17:00.000000", "creator": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "* pre-suite can install deps and puppet-strings\n* acceptance suite can run " }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b635531" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Automate" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymd3r:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_65375409_*|*_1_*:*_1_*:*_5277033898_*|*_10007_*:*_1_*:*_1756377_*|*_3_*:*_1_*:*_1215009263_*|*_5_*:*_1_*:*_3542360584_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32482", "fixedVersions": [ "PDOC 1.1.0" ], "id": "32482", "issueType": "Task", "key": "PDOC-144", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "resolution": "Fixed", "resolutionDate": "2017-02-07T12:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "acceptance: fix windows pre-suite", "timeSpent": "PT0S", "updated": "2017-03-20T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I can fit this work into next sprint, but this also depends on [~accountid:62450221ad6b7e006aa4e34c] and/or [~accountid:557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715] having the bandwidth to get me predoc information.", "created": "2016-11-30T12:49:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:62450221ad6b7e006aa4e34c], poke at this and see if it's complicated or easy?", "created": "2016-11-30T14:32:00.000000" } ], "components": [ "DOCS" ], "created": "2016-11-23T13:59:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@353dd8de" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "623e796e8d8b9c0068b9f467" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "No Action" }, { "fieldName": "QA Risk Assessment Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "docs" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzacov:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7975_*|*_10007_*:*_1_*:*_3324134_*|*_3_*:*_1_*:*_88778546_*|*_5_*:*_1_*:*_9327577057_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_682981922" } ], "description": "From GitHub:\n\ner0ck:\ndoes this work in windows? should we provide instructions there?\nwhopper:\nIt wouldn't work in Windows, and we probably should have instructions here. It's a small use case, as you'd only do this if you were authoring a module on Windows (since windows masters aren't supported, so you wouldn't be installing a bunch of modules on a windows machine). Still, some people do write modules in Windows.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32460", "fixedVersions": [ "PDOC 1.1.0" ], "id": "32460", "issueType": "Bug", "key": "PDOC-143", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Fixed", "resolutionDate": "2016-12-02T13:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add Windows information to Strings README", "timeSpent": "PT0S", "updated": "2017-03-20T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Puppet Strings does not currently support references to Puppet defined elements. We need to look into how that can be done so that Yard can differentiate if a name used as a reference is to a named thing in the Puppet namespace or a name in the Ruby namespace.", "created": "2016-11-22T06:19:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "A workaround for this would be {my_module::defined_type my_module::defined_type}. Unfortunately, this probably wont get worked on in the near-term. Feel free to submit a PR on GitHub or re-open this issue if it becomes a blocking issue for you.", "created": "2018-04-12T08:00:00.000000" } ], "components": [], "created": "2016-11-22T00:50:00.000000", "creator": "557058:df8b6625-c029-4721-9f26-d07a22905a5a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@23675556" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzabbz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_40476672815_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3263919625" } ], "description": "I need to reference a defined type in my documentation.\n\nThe following code works for a class :\n\n{my_module::my_class}\n\nI want to have the same behavior for a defined type but the output is wrong.", "environment": "RHEL 7.3\nPuppet 4.7.0\nRuby 2.0\npuppet-strings 0.99.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32603", "fixedVersions": [], "id": "32603", "issueType": "New Feature", "key": "PDOC-142", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:df8b6625-c029-4721-9f26-d07a22905a5a", "resolution": "Won't Do", "resolutionDate": "2018-04-12T08:00:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Reference to defined type doesn't work", "timeSpent": "PT0S", "updated": "2018-04-12T08:00:00.000000", "votes": "4", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] any ideas on how this might be accomplished?", "created": "2018-03-05T12:21:00.000000" } ], "components": [], "created": "2016-11-18T12:45:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2f11d1d9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtmv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32480", "fixedVersions": [], "id": "32480", "issueType": "Story", "key": "PDOC-141", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Measurement of strings adoption", "timeSpent": "PT0S", "updated": "2019-05-02T14:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:dce8a3bd-52a4-4c8d-a974-0f0aacd00e53", "body": "this would be very nice! just converted voxpupuli/selinux to use puppet-strings documentation. Right now it's served from GH Pages via https://voxpupuli.org/puppet-selinux from the master-branch docs/ . But having it on the forge would even be better. ", "created": "2017-01-13T12:09:00.000000" }, { "author": "557058:dce8a3bd-52a4-4c8d-a974-0f0aacd00e53", "body": "Puppet strings as a service (PDOC-104) is IMHO related when not even a duplication to having it on the forge. ", "created": "2017-01-13T12:13:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This work is being tracked in PF-1437", "created": "2018-01-24T15:20:00.000000" } ], "components": [], "created": "2016-11-18T12:45:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@11946791" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtpr:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Jan/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_37334112158_*|*_6_*:*_1_*:*_0" } ], "description": "Probably in the form of a \"references\" tab or something that displays the JSON output of strings.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32533", "fixedVersions": [], "id": "32533", "issueType": "Story", "key": "PDOC-140", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Duplicate", "resolutionDate": "2018-01-24T15:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings-generated content on the Forge", "timeSpent": "PT0S", "updated": "2018-02-08T11:38:00.000000", "votes": "3", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "The discussion around module scoring is already pretty heated in terms of what to use and what not to use. I don't think we're looking at revamping scoring any time in the near future. If we do get around to talking about scoring again, we can evaluate Strings' inclusion at that time.", "created": "2018-04-12T03:16:00.000000" } ], "components": [], "created": "2016-11-18T12:42:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@777d553c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtpj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Apr/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_44026479667_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32491", "fixedVersions": [], "id": "32491", "issueType": "Story", "key": "PDOC-139", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Won't Do", "resolutionDate": "2018-04-12T03:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Use strings for module scoring", "timeSpent": "PT0S", "updated": "2018-04-12T03:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] is this a blocker for the release? And did we decide how we wanted to do this? (Delete current strings module on forge, replace with stub module that points to the gem. maybe?)\n\nEdit: actually, I'm going to assume it doesn't block the release since the forge page is already out of date with 0.99.0. I'm going to release 1.0.0 today and then work on getting some help updating the forge page.", "created": "2016-11-28T11:31:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Just kidding, with Jesse's help I figured out how to do this. For future reference, the preferred way to deprecate a module on the forge is as follows.\n\nDownload the tarball. Replace the README with a note saying that the module is deprecated and where to find it now. Update the module metadata.json to have a version of 999.999.999, and add \"[deprecated]\" to the beginning of the summary. Then, push the module to the forge.\n\nSee https://forge.puppet.com/puppetlabs/strings.", "created": "2016-11-28T12:43:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-11-18T12:39:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60e5eb9a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtrb:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_864312541_*|*_5_*:*_1_*:*_5836876_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32458", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32458", "issueType": "Story", "key": "PDOC-138", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Fixed", "resolutionDate": "2016-11-28T12:44:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Update strings forge page to point to current", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Skipping subtasks in favor or just commenting here.\n\n1. Is the code ready for release?\n\nChangelog entry added for 1.0.0 and version bumped in the gemspec. Tests are all passing, and all tickets are resolved for this release. See https://puppet.atlassian.net/issues/?filter=23607.\n\n2. Reconcile git commits and JIRA tickets\n\nAll commits have associated JIRA tickets (except maint commits).\n\n3. Is the Jira tidy-up done for this release and prepared for the next one?\n\nWe now have PDOC version 1.0.1 in JIRA.\n\nFilters:\nFixed in 1.0.0: https://puppet.atlassian.net/issues/?filter=23607\nIntroduced in 1.0.0: https://puppet.atlassian.net/issues/?filter=23606\n\n4. Prepare long form release notes:\n\nSubject: Announce: Strings 1.0.0 Released!\n\nBody:\n\nHello, all! Today we're happy to announce the release of puppet-strings 1.0.0! For those unfamiliar with the project, Strings is a YARD-based documentation tool for Puppet extensions written in Puppet and Ruby. Given some simple in-code comments containing YARD tags, it will generate consistent HTML or JSON documentation for all of your Puppet 3x/4x API functions, Puppet language functions, Ruby classes, Ruby methods, types, and providers.\n\nThis release mainly includes minor bug based on feedback from the recent 0.99.0 release. We also slightly modified the JSON schema for Puppet functions (see below).\n\nFeatures:\n- The JSON schema for Puppet functions has been altered to include a new 'signatures' top-level key (PDOC-125)\n - Includes information about all function signatures (overloads). Existing overload key format has been preserved.\n- Reworked README for enhanced clarity (PDOC-133)\n\nBug fixes:\n- Fixed an issue where the search box in the code navigator overlapped list items below it (PDOC-93)\n- Strings can now handle multiple `defaultfor` calls in Puppet providers (PDOC-95)\n- Fixed an issue preventing the generated \\_index.html file from being uploaded to GitHub pages via the gh_pages task (PDOC-120)\n- Fixed several issues with String's handling of Puppet 3.x and 4.x function return types (PDOC-135), (PDOC-136)\n- Fixed an issue where String's didn't properly parse overloads if no summary description was provided (PDOC-129)\n- Strings now correctly handles Puppet 3.x functions when the `newfunction` call is on a newline (PDOC-122)\n- Fixed an issue where certain Ruby string constructs were incompletely stripped from some docstrings (PDOC-126)\n- Hanging indents from type feature descriptions are now properly stripped (PDOC-127)\n\nNever used Strings? Check out our recent blog post to learn more! https://puppet.com/blog/using-puppet-strings-generate-great-documentation-puppet-modules\n\nThe ruby gem can be found here: https://rubygems.org/gems/puppet-strings\n\nFor installation and usage instructions, see https://github.com/puppetlabs/puppet-strings/blob/master/README.md.\n\nTo track issues related to this release or report issues, see the PDOC Jira project:\n\n- JIRA Project: https://puppet.atlassian.net/browse/PDOC\n\n- Fixed for 1.0.0: https://puppet.atlassian.net/issues/?filter=23607\n- Introduced in 1.0.0: https://puppet.atlassian.net/issues/?filter=23606\n\n", "created": "2016-11-28T13:33:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "5. Tag the release\n\nTagged 1.0.0 at 1bd8575acb82d283412228516a6aeeb0e0259bf8\n\n6. Build and smoke test gem\n\nBuilt gem and tested on Centos 7 by running against puppetlabs-apache with FOSS puppet-agent latest.\n\n7. Push tag to GitHub\n\nTag pushed and gem pushed.\n\n8. Send out announcements\n\nAnnouncements sent to announce, dev and users mailing lists.\n\n9. Close all resolved tickets in JIRA.\n\nDone.", "created": "2016-11-28T14:22:00.000000" } ], "components": [], "created": "2016-11-16T15:26:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@668b72f9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hza69r:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1022533115_*|*_3_*:*_1_*:*_10269230_*|*_5_*:*_1_*:*_110392_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32329", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32329", "issueType": "Task", "key": "PDOC-137", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-28T14:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release puppet-strings 1.0.0", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-11-10T14:53:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Given the following function, Strings should recognize that the function returns a string without having to add {{[String]}} to the {{@return}} tag:\n\n{code}\nfunction example(String $name) >> String {\n\"hello\"\n}\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@339bdf68" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hza28n:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Puppet 4.8 added the ability to define puppet language functions with return types (PUP-5623). This change updates strings to recognize those return types and automatically inject them into the documentation for the function." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_6681425_*|*_1_*:*_1_*:*_79876116_*|*_10007_*:*_2_*:*_251938157_*|*_3_*:*_2_*:*_6169535_*|*_5_*:*_1_*:*_1049144070_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_159464560" } ], "description": "{code}\nfunction example(String $name) >> String {\n\"hello\"\n}\n{code}\n\nIn this example, {{>> String}} says that this function returns a string. Currently, Strings ignores this which requires the user to document the return type with the {{@return}} tag.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32488", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32488", "issueType": "Bug", "key": "PDOC-136", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-16T10:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings doesn't recognize `>> Type` syntax for return type of puppet language functions", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-11-10T14:45:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Given the following function, strings should correctly identify that the 'subtract_ints` overload returns type 'Numeric'.\n\n{code}\n# Subtracts two things.\nPuppet::Functions.create_function(:subtract) do\n # @param x The first integer.\n # @param y The second integer.\n # @return Returns x - y.\n # @example Subtracting two integers.\n # subtract(5, 1) => 4\n dispatch :subtract_ints do\n param 'Integer', :x\n param 'Integer', :y\n return_type 'Numeric'\n end\n\n def subtract_ints(x, y)\n x - y\n end\nend\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@43aa62b6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hza28f:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "This change updates strings to recognize calls to the 'return_type' method within puppet 4.x function dispatches. This information is automatically included in the documentation for the function." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_6685496_*|*_1_*:*_1_*:*_4437414_*|*_10007_*:*_2_*:*_333731233_*|*_3_*:*_1_*:*_294944_*|*_5_*:*_1_*:*_1049502393_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_159107793" } ], "description": "Puppet 4.x API functions can include a {{return_type 'blah'}} in each of their dispatches. Strings should use this to document the return type for the overload rather than requiring the type to be documented in the {{@return}} tag. Example:\n\n{code}\n# Subtracts two things.\nPuppet::Functions.create_function(:subtract) do\n # @param x The first integer.\n # @param y The second integer.\n # @return Returns x - y.\n # @example Subtracting two integers.\n # subtract(5, 1) => 4\n dispatch :subtract_ints do\n param 'Integer', :x\n param 'Integer', :y\n return_type 'Numeric'\n end\n\n def subtract_ints(x, y)\n x - y\n end\nend\n{code}", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32456", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32456", "issueType": "Bug", "key": "PDOC-135", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-16T10:50:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings doesn't recognize `return_type` in 4.x function dispatch", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Not sure this ever happened but may be a good thing to do when we release our new run of blog posts/publicity for strings.", "created": "2018-03-05T12:19:00.000000" } ], "components": [], "created": "2016-11-10T13:54:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@731aadad" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtq7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "Should cover:\n\nDelivering Documentation to Users\nHosting documentation as github pages\nRunning the Strings web server", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32486", "fixedVersions": [], "id": "32486", "issueType": "Task", "key": "PDOC-134", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "evangelize \"how to puppet-strings\"", "timeSpent": "PT0S", "updated": "2019-05-01T15:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Edit the existing README, then determine other tickets needed. \n\nTickets I think I might need:\n* Create a strings page for the Docs site, would exist alongside existing module docs\n* Change BGTM, Style Guide, and other(?) module pages to reflect Strings existence", "created": "2016-11-07T17:03:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Created PDOC-145 to track remaining Docs work for Strings.", "created": "2016-11-28T13:21:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [ "DOCS" ], "created": "2016-11-07T17:00:00.000000", "creator": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3769fa4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hza033:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_13493_*|*_3_*:*_1_*:*_187635018_*|*_5_*:*_1_*:*_429788615_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1187417958" } ], "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32328", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32328", "issueType": "Task", "key": "PDOC-133", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "resolution": "Fixed", "resolutionDate": "2016-11-23T14:58:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Edit Strings README", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "I've got a rough draft mostly fleshed out here: https://docs.google.com/a/puppet.com/document/d/14CZGJJ_lbrHTZXyTGy9VTawSC9mN_NoZ61u7FScOF5A/edit?usp=sharing", "created": "2016-11-09T16:49:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "LGTM and I made some suggestions in the doc. Also, I created https://github.com/puppetlabs/puppet-strings/pull/124 to include modern PE instructions in installation instructions.", "created": "2016-11-09T18:39:00.000000" } ], "components": [], "created": "2016-11-07T15:35:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@14d90a1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9zzj:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_78721_*|*_3_*:*_1_*:*_772635753_*|*_5_*:*_1_*:*_1037272866_*|*_6_*:*_1_*:*_0" } ], "description": "I think this post is sort of meant to be a demo of what strings can do for anyone who isn't familiar. I plan to basically go over how to document some of the major components of a module with examples.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32369", "fixedVersions": [], "id": "32369", "issueType": "Task", "key": "PDOC-132", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-16T14:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Blog post: documenting new (or old) modules with puppet-strings", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c11ebee1b5a0070293512", "body": "And maybe there could also be some kind of way of using a template or a 'README.top' file to allow adding freeform stuff without putting it in heredocs in the code?\n\nIf there's already a way to do something similar or equivalent, let me know.", "created": "2016-10-25T00:28:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Hey [~accountid:623c11ebee1b5a0070293512]! You are correct that README generation isn't currently possible. I had been thinking along similar lines, though. It makes sense and I think we'll make it so at some point (not for the 1.0 release, probably, but hopefully soon!)", "created": "2016-10-25T10:55:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Markdown functionality has been merged to master and for the foreseeable future, this is as close as we'll come to generating a full README.", "created": "2018-02-27T17:52:00.000000" } ], "components": [], "created": "2016-10-24T22:34:00.000000", "creator": "623c11ebee1b5a0070293512", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@36cf5709" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9qmf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_42409092228_*|*_6_*:*_1_*:*_0" } ], "description": "Is it possible to generate a module's README itself from puppet-strings? I first thought that this was possible (and some folks on the modules team seemed to think it was feasible), but from brief testing of the examples, and looking at the help text, it seems like typically things go the other way (a README html file is generated from the README).\n\nIt would be ideal (IMHO) to be able to include descriptions for the various typical sections in heredocs within the module, and have puppet-strings generate the README, including the examples and the parameters and their descriptions.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32530", "fixedVersions": [], "id": "32530", "issueType": "New Feature", "key": "PDOC-131", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c11ebee1b5a0070293512", "resolution": "Won't Do", "resolutionDate": "2018-02-27T17:52:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "generate README from puppet-strings", "timeSpent": "PT0S", "updated": "2018-02-27T17:52:00.000000", "votes": "3", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623c11ebee1b5a0070293512", "created": "2016-10-24T23:01:00.000000", "name": "puppet-strings1.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12379" } ], "comments": [ { "author": "623c11ebee1b5a0070293512", "body": "ps - Just realized if you indent, it behaves as expected. However, the unpredictable behavior when you don't indent still seems like a bug.", "created": "2016-10-24T23:01:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:623c11ebee1b5a0070293512] that's actually a YARD thing - the same goes for examples. We don't have control over that, but we can and should make note of that in the README. As for official puppet modules using strings, part of the reason we released 0.99.0 was so that our internal docs team could start using it on our modules. So, you should start to see that happening soon.", "created": "2016-10-25T10:58:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-24T22:27:00.000000", "creator": "623c11ebee1b5a0070293512", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3030ff23" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9qm7:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_51527718_*|*_10007_*:*_1_*:*_91124642_*|*_5_*:*_1_*:*_2851574476_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4239354" } ], "description": "Creating long descriptions doesn't seem to work optimally; typically, I'd want to wrap at 80 or 140 characters, but a newline seems to confuse puppet-strings. If this is expected behavior, the limitation should be documented better.\n\nFor example, if you try to wrap lines for a long description, e.g.,\n\n{code:ruby}\n# @param package_source [String] The source for the package. Possible values\n# are undef (default), meaning the package will be installed from the\n# vendor's packaging system using configured repos. On supported platforms,\n# this can also be set to:\n# 'nginx-stable': (current production release from official repository)\n# 'nginx-mainline': (current development release from official repository)\n# 'passenger': (Phusion Passenger repos)\n{code}\n\nand generate the pages using the example command, the parameter text is truncated, and the extra text shows up in an unexpected place (in this example, under Overview)\n!puppet-strings1.png|thumbnail!\n\nI would also love to see at least one official Puppet module documented using puppet-strings, having a concrete example would be really useful.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32483", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32483", "issueType": "Bug", "key": "PDOC-130", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c11ebee1b5a0070293512", "resolution": "Fixed", "resolutionDate": "2016-10-26T15:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add note to README about linebreaks and indentation for long tag docs", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-19T15:07:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Given the following 4.x function, both overloads in the JSON output should include a parameter and return tag:\n\n{code}\n# Subtracts two things.\nPuppet::Functions.create_function(:subtract) do\n # @param x The first integer.\n # @param y The second integer.\n # @return [Integer] Returns x - y.\n # @example Subtracting two integers.\n # subtract(5, 1) => 4\n dispatch :subtract_ints do\n param 'Integer', :x\n param 'Integer', :y\n end\n\n # Here is a docstring\n # @param x The first array.\n # @param y The second array.\n # @return [Array] Returns x - y.\n # @example Subtracting two arrays.\n # subtract([3, 2, 1], [1]) => [3, 2]\n dispatch :subtract_arrays do\n param 'Array', :x\n param 'Array', :y\n end\n\n def subtract_ints(x, y)\n x - y\n end\n\n def subtract_arrays(x, y)\n x - y\n end\nend\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73cfce48" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9omv:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_2773772_*|*_1_*:*_1_*:*_1378650112_*|*_10007_*:*_1_*:*_866392108_*|*_3_*:*_1_*:*_426165_*|*_5_*:*_1_*:*_1049740348_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_158871074" } ], "description": "In the following function overload, if you remove the \"Subtracts two integers\" line, strings will ignore the rest of the @param and @return tags, but *only* in the JSON output, it seems.\n\n{code}\nPuppet::Functions.create_function(:subtract) do\n # Subtracts two integers.\n # @param x The first integer.\n # @param y The second integer.\n # @return [Integer] Returns x - y.\n # @example Subtracting two integers.\n # subtract(5, 1) => 4\n dispatch :subtract_ints do\n param 'Integer', :x\n param 'Integer', :y\n end\nend\n{code}\n\n... results in ...\n\n{code}\n \"name\": \"subtract\",\n \"file\": \"/Users/whopper/Coding/strings-demo/strings-demo/lib/puppet/functions/subtract.rb\",\n \"line\": 2,\n \"type\": \"ruby4x\",\n \"docstring\": {\n \"text\": \"Subtracts two things.\",\n \"tags\": [\n {\n \"tag_name\": \"overload\",\n \"signature\": \"subtract(Integer $x, Integer $y)\",\n \"name\": \"subtract\"\n },\n {\n \"tag_name\": \"overload\",\n \"signature\": \"subtract(Array $x, Array $y)\",\n \"name\": \"subtract\"\n }\n ]\n },\n{code}\n\n... as opposed to the following when the doc string is added back in:\n\n{code}\n \"tag_name\": \"overload\",\n \"signature\": \"subtract(Array $x, Array $y)\",\n \"docstring\": {\n \"text\": \"Here is a docstring\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"The first array.\",\n \"types\": [\n \"Array\"\n ],\n \"name\": \"x\"\n },\n {\n \"tag_name\": \"param\",\n \"text\": \"The second array.\",\n \"types\": [\n \"Array\"\n ],\n \"name\": \"y\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"Returns x - y.\",\n \"types\": [\n \"Array\"\n ]\n },\n {\n \"tag_name\": \"example\",\n \"text\": \"subtract([3, 2, 1], [1]) => [3, 2]\",\n \"name\": \"Subtracting two arrays.\"\n }\n ]\n },\n{code}", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32437", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32437", "issueType": "Bug", "key": "PDOC-129", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-16T10:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "4.x function overload tags not parsed if the overload is missing a docstring", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "62450221ad6b7e006aa4e34c", "created": "2016-10-11T12:43:00.000000", "name": "Screen Shot 2016-10-11 at 11.40.03 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12393" } ], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:623c08e1562ab90069f8aed4] Strange - the following works correctly:\n\n{code}\n# Adds two integers together.\n# @param x The first integer to add.\n# @param y The second integer to add.\n# @return [Integer] Returns the sum of x and y.\n# @example Example of adding two integers.\n# demo::add(1, 2) => 3\nfunction demo::add(Integer $x, Integer $y) {\n $x + $y\n}\n{code}\n\nI attached the HTML output of that, and the JSON collects:\n\n{code}\n{\n \"tag_name\": \"example\",\n \"text\": \"demo::add(1, 2) => 3\",\n \"name\": \"Example of adding two integers.\"\n }\n{code}\n\nI'll look into your example and see if this is a matter of documenting @example format or if something's wrong in strings.", "created": "2016-10-11T12:43:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Interesting. Wonder if the amount of hanging indent is significant. (There's none in the core functions.)", "created": "2016-10-11T12:44:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "It is", "created": "2016-10-11T13:40:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "With what [~accountid:557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c] said above, my understanding is that there aren't any changes to make for this ticket on the strings side. Puppet core examples will need to be updated to use the proper syntax, though. \n\nIt may make sense to add a bit more to the README about how to use @examples", "created": "2016-10-12T14:43:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Yeah! An update to the README plus a PUP or DOC ticket for the needed edits sounds like a fine resolution to this. \n\nWhat I'd like to know from the README:\n\n* How much indentation should one use? I'm noticing 2 spaces above", "created": "2016-10-12T14:53:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:623c08e1562ab90069f8aed4] I opened https://github.com/puppetlabs/puppet-strings/pull/114 and filed https://puppet.atlassian.net/browse/DOC-2970.", "created": "2016-10-12T16:06:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-11T12:36:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@18883197" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9h7b:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_70212053_*|*_1_*:*_1_*:*_95206431_*|*_10007_*:*_1_*:*_6681767_*|*_3_*:*_1_*:*_3524131_*|*_5_*:*_1_*:*_3981492009_*|*_6_*:*_1_*:*_0" } ], "description": "Several functions include {{\\@example}} tags in their comment text, but Strings isn't handling them in a useful way. Check out these instances from the assert_type function: \n\nOriginal source: \n\n{code}\n# ...\n# 1. The expected data type.\n# 2. A value to compare against the expected data type.\n#\n# @example Using `assert_type`\n#\n# ~~~ puppet\n# $raw_username = 'Amy Berry'\n#\n# # Assert that $raw_username is a non-empty string and assign it to $valid_username.\n# $valid_username = assert_type(String[1], $raw_username)\n#\n# # $valid_username contains \"Amy Berry\".\n# # If $raw_username was an empty string or a different data type, the Puppet run would\n# # fail with an \"Expected type does not match actual\" error.\n# ~~~\n#\n# You can use an optional lambda to provide enhanced feedback. The lambda takes two\n# mandatory parameters, in this order:\n#\n# 1. The expected data type as described in the function's first argument.\n# 2. The actual data type of the value.\n#\n# @example Using `assert_type` with a warning and default value\n#\n# ~~~ puppet\n# $raw_username = 'Amy Berry'\n#\n# # Assert that $raw_username is a non-empty string and assign it to $valid_username.\n# # If it isn't, output a warning describing the problem and use a default value.\n# $valid_username = assert_type(String[1], $raw_username) |$expected, $actual| {\n# warning( \"The username should be \\'${expected}\\', not \\'${actual}\\'. Using 'anonymous'.\" )\n# 'anonymous'\n# }\n#\n# # $valid_username contains \"Amy Berry\".\n# # If $raw_username was an empty string, the Puppet run would set $valid_username to\n# # \"anonymous\" and output a warning: \"The username should be 'String[1, default]', not\n# # 'String[0, 0]'. Using 'anonymous'.\"\n# ~~~\n#\n# For more information about data types, see the\n# [documentation](https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html).\n#\n# @since 4.0.0\n#\n{code}\n\nResulting JSON output:\n\n{code}\n \"docstring\": {\n \"text\": \"Returns the given value if it is of the given\\n[data type](https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html), or\\notherwise either raises an error or executes an optional two-parameter\\n[lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html).\\n\\nThe function takes two mandatory arguments, in this order:\\n\\n1. The expected data type.\\n2. A value to compare against the expected data type.\\n\\n~~~ puppet\\n$raw_username = 'Amy Berry'\\n\\n# Assert that $raw_username is a non-empty string and assign it to $valid_username.\\n$valid_username = assert_type(String[1], $raw_username)\\n\\n# $valid_username contains \\\"Amy Berry\\\".\\n# If $raw_username was an empty string or a different data type, the Puppet run would\\n# fail with an \\\"Expected type does not match actual\\\" error.\\n~~~\\n\\nYou can use an optional lambda to provide enhanced feedback. The lambda takes two\\nmandatory parameters, in this order:\\n\\n1. The expected data type as described in the function's first argument.\\n2. The actual data type of the value.\\n\\n~~~ puppet\\n$raw_username = 'Amy Berry'\\n\\n# Assert that $raw_username is a non-empty string and assign it to $valid_username.\\n# If it isn't, output a warning describing the problem and use a default value.\\n$valid_username = assert_type(String[1], $raw_username) |$expected, $actual| {\\n warning( \\\"The username should be \\\\'${expected}\\\\', not \\\\'${actual}\\\\'. Using 'anonymous'.\\\" )\\n 'anonymous'\\n}\\n\\n# $valid_username contains \\\"Amy Berry\\\".\\n# If $raw_username was an empty string, the Puppet run would set $valid_username to\\n# \\\"anonymous\\\" and output a warning: \\\"The username should be 'String[1, default]', not\\n# 'String[0, 0]'. Using 'anonymous'.\\\"\\n~~~\\n\\nFor more information about data types, see the\\n[documentation](https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html).\",\n \"tags\": [\n {\n \"tag_name\": \"example\",\n \"text\": \"\",\n \"name\": \"Using `assert_type`\"\n },\n {\n \"tag_name\": \"example\",\n \"text\": \"\",\n \"name\": \"Using `assert_type` with a warning and default value\"\n },\n {\n \"tag_name\": \"since\",\n \"text\": \"4.0.0\"\n },\n {\n \"tag_name\": \"overload\",\n \"signature\": \"assert_type(Type $type, Any $value, Optional[Callable[Type, Type]] &$block)\",\n \"name\": \"assert_type\"\n },\n {\n \"tag_name\": \"overload\",\n \"signature\": \"assert_type(String $type_string, Any $value, Optional[Callable[Type, Type]] &$block)\",\n \"name\": \"assert_type\"\n }\n ]\n },\n{code}\n\n...that might be kind of hard to read, but what's happening is that it's snipping out the line that starts with {{\\@example}} and using it to populate a \"tag_name\":\"example\" object, but it's not grabbing the code block that's supposed to be associated with the example. And now that I think about it, it's really hard to tell WHICH text is supposed to be associated in the first place! There's a short run in the middle that is not associated with either example, as I read it. \n\nI think we need to do one of these things:\n\n* Document how to explicitly associate an example tag with a multi-line block of example text. If there's not currently a way to do that, make one. \n* Document that example tags are impossible to use constructively, and remove all instances from the Puppet core codebase. ", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32368", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32368", "issueType": "Bug", "key": "PDOC-128", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-10-13T13:23:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Update README to explain: What's the deal with @example tags?", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "Sounds like a {{Puppet::Util::Docs.scrub}} call is probably missing for features.", "created": "2016-10-11T13:39:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-11T12:27:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Given the following type, string should parse the feature :magic and strip out all whitespace and newlines from its docstring:\n\n{code}\nPuppet::Type.newtype(:database) do\n desc 'An example database server resource type.'\n feature :encryption, 'The provider supports encryption.', methods: [:encrypt]\n\n feature :magic,\n 'The feature docstring should have\n whitespace and newlines stripped out.'\nend\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6effd9f4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9h6n:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "This change ensures that puppet Type features have their docstrings scrubbed of extra whitespace and newlines." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_66894644_*|*_1_*:*_1_*:*_12012787_*|*_10007_*:*_1_*:*_2591484_*|*_3_*:*_1_*:*_120212_*|*_5_*:*_2_*:*_4054238266_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_21820616" } ], "description": "In most text blobs, we properly strip hanging indentation. But feature descriptions \u2014\u00a0part of some resource type objects \u2014\u00a0are getting missed. \n\nFrom the 'user' type: \n{code}\n \"features\": [\n {\n \"name\": \"allows_duplicates\",\n \"description\": \"The provider supports duplicate users with the same UID.\"\n },\n {\n \"name\": \"manages_homedir\",\n \"description\": \"The provider can create and remove home directories.\"\n },\n {\n \"name\": \"manages_passwords\",\n \"description\": \"The provider can modify user passwords, by accepting a password\\n hash.\"\n },\n {\n \"name\": \"manages_password_age\",\n \"description\": \"The provider can set age requirements and restrictions for\\n passwords.\"\n },\n {\n \"name\": \"manages_password_salt\",\n \"description\": \"The provider can set a password salt. This is for providers that\\n implement PBKDF2 passwords with salt properties.\"\n },\n {\n \"name\": \"manages_solaris_rbac\",\n \"description\": \"The provider can manage roles and normal users\"\n },\n {\n \"name\": \"manages_expiry\",\n \"description\": \"The provider can manage the expiry date for a user.\"\n },\n {\n \"name\": \"system_users\",\n \"description\": \"The provider allows you to create system users with lower UIDs.\"\n },\n {\n \"name\": \"manages_aix_lam\",\n \"description\": \"The provider can manage AIX Loadable Authentication Module (LAM) system.\"\n },\n {\n \"name\": \"libuser\",\n \"description\": \"Allows local users to be managed on systems that also use some other\\n remote NSS method of managing accounts.\"\n },\n {\n \"name\": \"manages_shell\",\n \"description\": \"The provider allows for setting shell and validates if possible\"\n },\n {\n \"name\": \"manages_loginclass\",\n \"description\": \"The provider can manage the login class for a user.\"\n }\n ]\n{code}\n\nNote the occurrences of \"\\n\" followed by six or seven spaces. ", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32602", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32602", "issueType": "Bug", "key": "PDOC-127", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-10-12T17:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Hanging indent isn't stripped for resource feature descriptions", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "Currently only string literals and heredoc expressions are supported, with the latter having known issues due to long standing \"it's not a bug!\" bug in YARD that we try to work around.\n\nI think we can attempt to fix this by simply stripping both {{%q}} and {{%Q}} from around the strings, although we should error if the latter attempts interpolation as that cannot be supported.", "created": "2016-10-11T13:37:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Is \"quoted heredoc\" supported ? it can also include interpolations. Just stripping %q %Q sounds fine to me as well as error if there is Ruby interpolation in a docstring.", "created": "2016-10-12T08:31:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "I believe it would be treated the same as a double quoted string with interpolations: namely the result should contain the interpolation expression as text. We should test this, [~accountid:62450221ad6b7e006aa4e34c].", "created": "2016-10-12T11:10:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Here are a few test cases and what we currently get. Note that the warnings only show up when *not* using either of the {{--emit-json}} options.\n\nh4. 1: string interpolation using {{%Q}}\n{code}\ntest = \"hello world\"\n desc %Q{This is a Q test to see what happens when\n we use interpolation: #{test}}\n\nbundle exec puppet strings generate test_provider.rb\n[warn]: In file `test_provider.rb':1: Cannot resolve link to This from text.\n\n \"docstring\": {\n \"text\": \"%Q{This is a Q test to see what happens when\\nwe use interpolation: #{test}}\"\n },\n{code}\n\nh4. regular heredoc\n\n{code}\n test = \"hello world\"\n desc <<-DOC\n This is a Q test to see what happens when\n we use interpolation: #{test}}\nDOC\n\nbundle exec puppet strings generate test_provider.rb\n[warn]: In file `test_provider.rb':2: Cannot resolve link to test from text:\n[warn]: ...{test}...\n\n \"docstring\": {\n \"text\": \"This is a Q test to see what happens when\\nwe use interpolation: #{test}\"\n },\n{code}\n\nh4. quoted heredoc (I think this is what [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] meant - this should suppress interpolation):\n\n{code}\n test = \"hello world\"\n desc <<-'DOC'\n This is a Q test to see what happens when\n we use interpolation: #{test}\n DOC\n\n[warn]: In file `test_provider.rb':2: Cannot resolve link to test from text:\n[warn]: ...{test}...\n\n \"docstring\": {\n \"text\": \"This is a Q test to see what happens when\\nwe use interpolation: #{test}\"\n },\n{code}", "created": "2016-10-12T11:26:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "\ud83d\udc4d thanks for the tests, looks like the quoted heredoc is operating correctly with respect to the best puppet-strings can do, although those warnings are annoying. I wonder if there is a way to prevent YARD from treating it as a link to something.", "created": "2016-10-12T11:30:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "So then it sounds like the plan of action for this ticket is to simply strip off {{%Q}} and {{%q}} from docstrings? And unless we can find a way to prevent those warnings, nothing else will change and it's expected that docstrings that contain interpolated text will end up having the interpolation expression?", "created": "2016-10-12T11:34:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "Yes on stripping {{%Q}} and {{%q}} (and the brackets).\n\nYes on treating interpolated expressions as simply raw docstring text", "created": "2016-10-12T11:37:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "I agree with Peter! Interpolation is not desirable here, and treating it as raw text is an excellent fallback when we encounter it.", "created": "2016-10-12T15:11:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-11T12:24:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Given the following provider, strings should parse the docstring as \"The database provider on Linux. Here is a test: #{test}\" rather than \"%Q{The database provider on Linux. Here is a test: #{test}}\". Note that string interpolations are not supported, so we expect to see the literal interpolation expression in the final string.\n\n{code}\nPuppet::Type.type(:database).provide :linux do\n confine 'osfamily' => 'linux'\n defaultfor 'osfamily' => 'linux'\n commands :database => '/usr/bin/database'\n\n test = \"hello world\"\n\n desc %Q{The database provider on Linux. Here is a test: #{test}}\n\n # ...\nend\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a4b8fd8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9h6f:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Previously, docstrings using the Ruby %Q or %q syntax were parsed literally, resulting in the literal \"%Q\" appearing in the final string. This change ensures that the resulting string does not include that notation." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_251737300_*|*_1_*:*_1_*:*_72433428_*|*_10007_*:*_1_*:*_156372290_*|*_3_*:*_1_*:*_9280328_*|*_5_*:*_2_*:*_2429393468_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_5484382_*|*_10005_*:*_1_*:*_1233129745" } ], "description": "In Strings's JSON output, check out the 'password' parameter of the 'user' resource type. It has a leftover {{%q}} (plus curly braces) from its original ruby string quoting:\n\n{code}\n{\n \"name\": \"password\",\n \"description\": \"%q{The user's password, in whatever encrypted format the local system\\nrequires. Consult your operating system's documentation for acceptable password\\nencryption formats and requirements.\\n\\n* Mac OS X 10.5 and 10.6, and some older Linux distributions, use salted SHA1\\n hashes. You can use Puppet's built-in `sha1` function to generate a salted SHA1\\n hash from a password.\\n* Mac OS X 10.7 (Lion), and many recent Linux distributions, use salted SHA512\\n hashes. The Puppet Labs [stdlib][] module contains a `str2saltedsha512` function\\n which can generate password hashes for these operating systems.\\n* OS X 10.8 and higher use salted SHA512 PBKDF2 hashes. When managing passwords\\n on these systems, the `salt` and `iterations` attributes need to be specified as\\n well as the password.\\n* Windows passwords can only be managed in cleartext, as there is no Windows API\\n for setting the password hash.\\n\\n[stdlib]: https://github.com/puppetlabs/puppetlabs-stdlib/\\n\\nEnclose any value that includes a dollar sign ($) in single quotes (') to avoid\\naccidental variable interpolation.}\"\n }\n{code}\n\nEither Strings should be stripping this, or, if that's not feasible, we should specify which quoting constructs are legal to use in a resource type / provider / etc. ", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32477", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32477", "issueType": "Bug", "key": "PDOC-126", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-10-31T12:32:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ruby quoting constructs are incompletely stripped from some docstrings", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c08e1562ab90069f8aed4", "body": "My preferred interface would be a top-level {{signatures}} tag that is always an array. ", "created": "2016-10-11T11:50:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "This is funky because this is how YARD represents the data. That is to say the intention of this schema was to enable any users familiar with YARD to consume the data for their uses and not solely as a mechanism for which Puppet's doc team can generate documentation.\n\nFunction objects only have a single signature, which is omitted when the function has overloads because the overload tags themselves store their signature representation. Perhaps this is not the best way of representing it, but it's consistent with how YARD does it.", "created": "2016-10-11T13:29:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Sure. But given that this JSON will be used by the Forge, possibly the PE console, possibly a future CLI interface for reading bite-sized docs, etc., I think it's worth treating it like a designed interface, don't you? ", "created": "2016-10-11T16:12:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Agree with [~accountid:623c08e1562ab90069f8aed4] here. Think this format should try to be free of yard concerns. Who knows what we will be using years from now.", "created": "2016-10-12T08:19:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "I'm completely fine with having a better structure that isn't tied closely to YARD, but I'd still argue that an overload's signature belongs with the overload's data (doc text, tags, etc.) because most of the time you want this displayed as a single entity in a list of overloads.", "created": "2016-10-12T11:12:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "In the interest of getting to a decision, it sounds like we're comfortable with changing the behavior from YARD. If that's true and I understand correctly, the remaining question is where we want the signature(s) to be nested within the JSON?", "created": "2016-10-12T16:30:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "I think our options are:\n\n# As a top-level key (\"signatures\" maybe) in the function object.\n# As a key (\"signatures\") in the \"docstring\" object.\n# As an object in the \"docstring.tags\" object (\"tag_name\":\"signatures\", \"signatures\":, or something like that).\n# As a group of \"overload\" objects in the docstring.tags object (i.e. we just move the existing top-level \"signature\" key to an overload object). \n\nI dislike options 3 and 4, but can easily live with them if there's a good argument for going that way. I think 1 and 2 are basically equivalent. ", "created": "2016-10-12T16:56:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "I don't feel like I have a basis for making a recommendation and am willing to accept the consensus choice.", "created": "2016-10-12T22:35:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Wait, I forgot something: Parameter descriptions are attached to signatures, and each signature can also have a description as well. This isn't widely used in the current code base, but here's an example: \n\n{code}\n{\n \"name\": \"lookup\",\n \"file\": \"/Users/nick/RubymineProjects/puppet-docs/vendor/puppet/lib/puppet/functions/lookup.rb\",\n \"line\": 124,\n \"type\": \"ruby4x\",\n \"docstring\": {\n \"text\": \"Uses the Puppet lookup system to retrieve a value for a given key. By default,\\nthis returns the first value found (and fails compilation if no values are\\navailable), but you can configure it to merge multiple values into one, fail\\ngracefully, and more.\\n\\nWhen looking up a key, Puppet will search up to three tiers of data, in the\\nfollowing order:\\n\\n1. Hiera.\\n2. The current environment's data provider.\\n3. The indicated module's data provider, if the key is of the form\\n `::`.\\n\\n#### Arguments\\n\\nYou must provide the name of a key to look up, and can optionally provide other\\narguments. You can combine these arguments in the following ways:\\n\\n* `lookup( , [], [], [] )`\\n* `lookup( [], )`\\n* `lookup( as above ) |$key| { # lambda returns a default value }`\\n\\nArguments in `[square brackets]` are optional.\\n\\nThe arguments accepted by `lookup` are as follows:\\n\\n1. `` (string or array) --- The name of the key to look up.\\n * This can also be an array of keys. If Puppet doesn't find anything for the\\n first key, it will try again with the subsequent ones, only resorting to a\\n default value if none of them succeed.\\n2. `` (data type) --- A\\n[data type](https://docs.puppetlabs.com/puppet/latest/reference/lang_data_type.html)\\nthat must match the retrieved value", "created": "2016-10-14T15:12:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "Okay, taking that into account, here's my full proposal:\n\n* We leave the format of the \"overload\"/signature objects mostly alone \u2014\u00a0they continue to be objects that can have their own docstring text, tags, etc.\n* However, we remove the \"tag_name\":\"overload\" part...\n* (...and possibly the \"name\" part, since it never seems to contain any new information?...)\n* ...and we move them from the docstring.tags array to a new top-level array in the function object. The key name should be either \"signatures\" (existing, well-known term of art) or \"dispatches\" (after the name of the method used to establish a signature in the Ruby 4x function API). I prefer \"signatures.\"\n* If there is only one signature for a function, we combine the signature and any \"tag_name\":\"param\" objects from the docstring.tags array to create a new signature object, which we place in the top-level \"signatures\" array. \n** This unifies the behavior of single and multiple dispatch, which was my original request for this ticket.\n* We no longer use the top-level \"signature\" (non-plural) key or free-floating \"param\" objects in the tags array. Param descriptions are always associated with a particular function dispatch. \n** Does that match what we already do to validate \\@param tags? Or am I forgetting something weird?\n\nHow does this sound? I'd also like to get input from the Forge team since I think they're the next people going to be using this... who's the right one to ask for that?", "created": "2016-10-14T15:30:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] can evaluate from the Forge perspective", "created": "2016-10-14T15:35:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "That sounds reasonable to me. Having one place to look for signatures (that is always a list, even if it only has one item) sounds a lot better than a conditional.", "created": "2016-10-19T16:03:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Based on [~accountid:623c08e1562ab90069f8aed4]'s proposals, I believe the JSON of his examples will look like this (please correct me if I'm wrong):\n\nEdit: perhaps in the case of only one signature, the return tag should also be included in the top-level {{signatures}} object?\n\nh4. A function with multiple dispatches\n{code}\n{\n \"puppet_functions\": [\n {\n \"name\": \"lookup\",\n \"file\": \"/Users/whopper/Coding/puppet/lib/puppet/functions/lookup.rb\",\n \"line\": 124,\n \"type\": \"ruby4x\",\n \"signatures\": [\n {\n \"signature\": \"lookup(NameType $name, Optional[ValueType] $value_type, Optional[MergeType] $merge)\"\n },\n {\n \"signature\": \"lookup(NameType $name, Optional[ValueType] $value_type, Optional[MergeType] $merge, DefaultValueType $default_value)\"\n },\n {\n \"signature\": \"lookup(NameType $name, Optional[ValueType] $value_type, Optional[MergeType] $merge, BlockType &$block)\"\n },\n {\n \"signature\": \"lookup(OptionsWithName $options_hash, Optional[BlockType] &$block)\",\n \"docstring\": {\n \"text\": \"Lookup without name. Name then becomes a required entry in the options hash\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"OptionsWithName\"\n ],\n \"name\": \"options_hash\"\n },\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"Optional[BlockType]\"\n ],\n \"name\": \"&block\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Any\"\n ]\n }\n ]\n },\n },\n {\n \"signature\": \"lookup(Variant[String,Array[String]] $name, OptionsWithoutName $options_hash, Optional[BlockType] &$block)\",\n \"docstring\": {\n \"text\": \"Lookup using name and options hash.\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"Variant[String,Array[String]]\"\n ],\n \"name\": \"name\"\n },\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"OptionsWithoutName\"\n ],\n \"name\": \"options_hash\"\n },\n {\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"Optional[BlockType]\"\n ],\n \"name\": \"&block\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Any\"\n ]\n }\n ]\n },\n }\n ]\n \"docstring\": {\n \"text\": \"text here\"\n \"tags\": [\n {\n \"tag_name\": \"example\",\n \"text\": \"\\nlookup('ntp::service_name')\",\n \"name\": \"Look up a key and return the first value found\"\n },\n {\n \"tag_name\": \"example\",\n \"text\": \"\\nlookup('classes', Array[String], 'unique').include\",\n \"name\": \"Do a unique merge lookup of class names, then add all of those classes to the catalog (like `hiera_include`)\"\n },\n {\n \"tag_name\": \"example\",\n \"text\": \"\\nlookup( { 'name' => 'users',\\n 'merge' => {\\n 'strategy' => 'deep',\\n 'knockout_prefix' => '--',\\n },\\n})\",\n \"name\": \"Do a deep hash merge lookup of user data, but let higher priority sources remove values by prefixing them with `--`\"\n },\n {\n \"tag_name\": \"since\",\n \"text\": \"4.0.0\"\n }\n \"source\": \"source here\" }\n ]\n}\n\n\n{code}\n\nh4. A function with only one signature\n{code}\n{\n \"puppet_functions\": [\n {\n \"name\": \"alert\",\n \"file\": \"/Users/whopper/Coding/puppet/lib/puppet/functions/alert.rb\",\n \"line\": 2,\n \"type\": \"ruby4x\",\n \"signatures\": [\n {\n \"signature\": \"alert(Any *$values)\",\n \"docstring\": {\n \"text\": \"\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"The values to log.\",\n \"types\": [\n \"Any\"\n ],\n \"name\": \"*values\"\n },\n ]\n }\n }\n ]\n \"docstring\": {\n \"text\": \"Log a message on the server at level alert.\",\n \"tags\": [\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Undef\"\n ]\n }\n ]\n },\n \"source\": \"Puppet::Functions.create_function(:alert, Puppet::Functions::InternalFunction) do\\n # @param values The values to log.\\n # @return [Undef]\\n dispatch :alert do\\n scope_param\\n repeated_param 'Any', :values\\n return_type 'Undef'\\n end\\n\\n def alert(scope, *values)\\n Puppet::Util::Log.log_func(scope, :alert, values)\\n end\\nend\"\n }\n ]\n}\n{code}", "created": "2016-10-31T14:40:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "[~accountid:62450221ad6b7e006aa4e34c] Yeah, this is pretty much exactly what I was hoping for! ", "created": "2016-10-31T17:17:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-11T11:49:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3eb809c0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymlnr:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "New Feature" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "This commit adds a new top-level key to the JSON schema for functions: signatures. This key holds all function signature data, and in the case of 4.x functions with multiple dispatches, each overload is present along with each of their parameters and other tags." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_74736665_*|*_1_*:*_1_*:*_1727166098_*|*_10007_*:*_2_*:*_1138472108_*|*_3_*:*_1_*:*_86876647_*|*_5_*:*_1_*:*_1049880006_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_62670263_*|*_10005_*:*_1_*:*_20134956" } ], "description": "If a function has only one possible signature, it goes in the top-level {{signature}} key. But if there are multiple signatures, {{signature}} is absent, and the signatures go in {{docstring.tags..signature}}. (That is, a key in any number of overload tags, which are located beside any other tags.)\n\nThis isn't difficult to work around, but it's poor design. Conceptually, every function has a list of signatures, and that list frequently has just one item; it's weird that it moves to a completely different place if you add one more signature. \n\nExample of single signature: \n\n{code}\n{\n \"name\": \"alert\",\n \"file\": \"/Users/nick/RubymineProjects/puppet-docs/vendor/puppet/lib/puppet/functions/alert.rb\",\n \"line\": 2,\n \"type\": \"ruby4x\",\n \"signature\": \"alert(Any *$values)\",\n \"docstring\": {\n \"text\": \"Log a message on the server at level alert.\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"The values to log.\",\n \"types\": [\n \"Any\"\n ],\n \"name\": \"*values\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Undef\"\n ]\n }\n ]\n },\n \"source\": \"Puppet::Functions.create_function(:alert, Puppet::Functions::InternalFunction) do\\n # @param values The values to log.\\n # @return [Undef]\\n dispatch :alert do\\n scope_param\\n repeated_param 'Any', :values\\n return_type 'Undef'\\n end\\n\\n def alert(scope, *values)\\n Puppet::Util::Log.log_func(scope, :alert, values)\\n end\\nend\"\n }\n{code}\n\nExample of multiple signatures: \n\n{code}\n{\n \"name\": \"assert_type\",\n \"file\": \"/Users/nick/RubymineProjects/puppet-docs/vendor/puppet/lib/puppet/functions/assert_type.rb\",\n \"line\": 53,\n \"type\": \"ruby4x\",\n \"docstring\": {\n \"text\": \"Returns the given value if it is of the given\\n[data type](https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html), or\\notherwise either raises an error or executes an optional two-parameter\\n[lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html).\\n\\nThe function takes two mandatory arguments, in this order:\\n\\n1. The expected data type.\\n2. A value to compare against the expected data type.\\n\\n~~~ puppet\\n$raw_username = 'Amy Berry'\\n\\n# Assert that $raw_username is a non-empty string and assign it to $valid_username.\\n$valid_username = assert_type(String[1], $raw_username)\\n\\n# $valid_username contains \\\"Amy Berry\\\".\\n# If $raw_username was an empty string or a different data type, the Puppet run would\\n# fail with an \\\"Expected type does not match actual\\\" error.\\n~~~\\n\\nYou can use an optional lambda to provide enhanced feedback. The lambda takes two\\nmandatory parameters, in this order:\\n\\n1. The expected data type as described in the function's first argument.\\n2. The actual data type of the value.\\n\\n~~~ puppet\\n$raw_username = 'Amy Berry'\\n\\n# Assert that $raw_username is a non-empty string and assign it to $valid_username.\\n# If it isn't, output a warning describing the problem and use a default value.\\n$valid_username = assert_type(String[1], $raw_username) |$expected, $actual| {\\n warning( \\\"The username should be \\\\'${expected}\\\\', not \\\\'${actual}\\\\'. Using 'anonymous'.\\\" )\\n 'anonymous'\\n}\\n\\n# $valid_username contains \\\"Amy Berry\\\".\\n# If $raw_username was an empty string, the Puppet run would set $valid_username to\\n# \\\"anonymous\\\" and output a warning: \\\"The username should be 'String[1, default]', not\\n# 'String[0, 0]'. Using 'anonymous'.\\\"\\n~~~\\n\\nFor more information about data types, see the\\n[documentation](https://docs.puppetlabs.com/puppet/latest/reference/lang_data.html).\",\n \"tags\": [\n {\n \"tag_name\": \"example\",\n \"text\": \"\",\n \"name\": \"Using `assert_type`\"\n },\n {\n \"tag_name\": \"example\",\n \"text\": \"\",\n \"name\": \"Using `assert_type` with a warning and default value\"\n },\n {\n \"tag_name\": \"since\",\n \"text\": \"4.0.0\"\n },\n {\n \"tag_name\": \"overload\",\n \"signature\": \"assert_type(Type $type, Any $value, Optional[Callable[Type, Type]] &$block)\",\n \"name\": \"assert_type\"\n },\n {\n \"tag_name\": \"overload\",\n \"signature\": \"assert_type(String $type_string, Any $value, Optional[Callable[Type, Type]] &$block)\",\n \"name\": \"assert_type\"\n }\n ]\n },\n \"source\": \"Puppet::Functions.create_function(:assert_type, Puppet::Functions::InternalFunction) do\\n dispatch :assert_type do\\n param 'Type', :type\\n param 'Any', :value\\n optional_block_param 'Callable[Type, Type]', :block\\n end\\n\\n dispatch :assert_type_s do\\n scope_param\\n param 'String', :type_string\\n param 'Any', :value\\n optional_block_param 'Callable[Type, Type]', :block\\n end\\n\\n # @param type [Type] the type the value must be an instance of\\n # @param value [Object] the value to assert\\n #\\n def assert_type(type, value)\\n unless Puppet::Pops::Types::TypeCalculator.instance?(type,value)\\n inferred_type = Puppet::Pops::Types::TypeCalculator.infer_set(value)\\n if block_given?\\n # Give the inferred type to allow richer comparison in the given block (if generalized\\n # information is lost).\\n #\\n value = yield(type, inferred_type)\\n else\\n raise Puppet::Pops::Types::TypeAssertionError.new(\\n Puppet::Pops::Types::TypeMismatchDescriber.singleton.describe_mismatch('assert_type():', type, inferred_type),\\n type, inferred_type)\\n end\\n end\\n value\\n end\\n\\n # @param scope [Puppet::Parser::Scope] scope used when obtaining loader for defined types\\n # @param type_string [String] the type the value must be an instance of given in String form\\n # @param value [Object] the value to assert\\n #\\n def assert_type_s(scope, type_string, value, &proc)\\n t = Puppet::Pops::Types::TypeParser.singleton.parse(type_string, scope)\\n block_given? ? assert_type(t, value, &proc) : assert_type(t, value)\\n end\\nend\"\n }\n{code}", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32327", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32327", "issueType": "Bug", "key": "PDOC-125", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-11-16T10:43:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "JSON: Splitting function signatures into two places is awkward", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "The name of the parameter includes the leading {{*}} to indicate it is vararg, which is not something that YARD represents outside of the parameter name (i.e. there's no \"is parameter vararg\" attribute on a {{param}} tag). However, the {{param}} tag's name attribute should not include a leading {{$}}.\n\nNote that the JSON schema was not designed solely for our internal docs team's use", "created": "2016-10-11T13:26:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "Taking PDOC-125 into account (i.e. the decision to not tie so closely to YARD with this format), I think we could do better here by having puppet-strings remove the {{*}} and set a \"is_vararg\" to true, or some such.\n\nI believe block parameters might also have {{&}} prefix.", "created": "2016-10-12T11:14:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c] If I understand correctly, that solution would result in no change to the function signature, but a removal of the {{*}} in tags.name:\n\n{code}\n \"signature\": \"alert(Any *$values)\",\n...\n\"tags\": [\n {\n ...\n \"name\": \"values\"\n \"is_vararg\" : true\n }\n]\n{code}\n\n(Or did you mean that we should also remove the {{*}} in the signature?)\n\n[~accountid:623c08e1562ab90069f8aed4] does this actually address the problem? It sounds like you just wanted the signature to match the tag name with regards to the {{$}}.", "created": "2016-10-31T11:46:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "I think it belongs in the signature as that's just something that should be displayed without processing to the user, already in the Puppet language (with a special non-Puppet syntax for showing the block parameter since we don't support that in function declarations in the language currently).\n\nIf we strip the special characters from the name in the tag, then we should have a \"is_block\" and \"is_vararg\" attribute to convey that information instead.", "created": "2016-10-31T11:57:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Ah, reading this again I realized that we're talking about two separate things. Nick originally just meant that any param, regardless of whether it's a vararg or not, has a {{$}} in the signature but not in the param tag name:\n\n{code}\n \"puppet_functions\": [\n {\n \"name\": \"versioncmp\",\n ...\n \"signature\": \"versioncmp(String $a, String $b)\",\n ...\n \"tags\" : [\n \"tag_name\": \"param\",\n \"text\": \"\",\n \"types\": [\n \"String\"\n ],\n \"name\": \"a\" # Note this is \"a\", not \"$a\"\n },\n ...\n ] \n{code}\n\nPeter is talking about varargs, which include the {{*}} in both the signature and the tag name, but still exhibit Nick's complaint about the {{$}} only being present in the signature:\n\n{code}\n \"puppet_functions\": [\n {\n \"name\": \"alert\",\n ...\n \"signature\": \"alert(Any *$values)\",\n ...\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"The values to log.\",\n \"types\": [\n \"Any\"\n ],\n \"name\": \"*values\"\n },\n{code}\n\nSince Nick wasn't complaining about the {{*}} for varargs, I think we can leave that alone and preserve YARD's format there. We really just need to figure out what to do about the {{$}} in the signature. Would it make any sense to remove it from the function signature so it matches the tag name? In my novice eyes, that would actually be somewhat confusing when looking at the signature, but if you all think it works I'm happy to work it out.", "created": "2016-10-31T12:04:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "The intention of the signature is to appear as if the user made a declaration in the Puppet language for the function", "created": "2016-10-31T12:11:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Ah, makes sense. Then, I think the solutions here are to either add the {{$}} to the tag name or do nothing at all.\n\nThe latter option you mentioned makes a lot of sense to me, where it's just assumed that {{$}} is a way for the language to denote a variable in the signature, but the parameter name is not a variable itself. [~accountid:623c08e1562ab90069f8aed4] given all of this, do you still think the param tag name should include a {{$}}?", "created": "2016-10-31T12:17:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "After discussing with Nick, we decided that this is acceptable behavior. We'll just document that this is the way the signature and param name references work.", "created": "2016-11-01T16:09:00.000000" } ], "components": [], "created": "2016-10-11T11:41:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@139281c7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9h1r:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_97360261_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_99206592_*|*_10005_*:*_1_*:*_1633886455" } ], "description": "In function signatures, argument names are represented with a leading dollar sign: {{\\*$values}}, e.g. But in {{param}} tags, they don't have a $: {{\\*values}}. \n\nExample: \n\n{code}\n {\n \"name\": \"alert\",\n \"file\": \"/Users/nick/RubymineProjects/puppet-docs/vendor/puppet/lib/puppet/functions/alert.rb\",\n \"line\": 2,\n \"type\": \"ruby4x\",\n \"signature\": \"alert(Any *$values)\",\n \"docstring\": {\n \"text\": \"Log a message on the server at level alert.\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"The values to log.\",\n \"types\": [\n \"Any\"\n ],\n \"name\": \"*values\"\n },\n {\n \"tag_name\": \"return\",\n \"text\": \"\",\n \"types\": [\n \"Undef\"\n ]\n }\n ]\n },\n \"source\": \"Puppet::Functions.create_function(:alert, Puppet::Functions::InternalFunction) do\\n # @param values The values to log.\\n # @return [Undef]\\n dispatch :alert do\\n scope_param\\n repeated_param 'Any', :values\\n return_type 'Undef'\\n end\\n\\n def alert(scope, *values)\\n Puppet::Util::Log.log_func(scope, :alert, values)\\n end\\nend\"\n }\n{code}\n\nSeems like they should be consistent in both areas, unless there's a good argument for not.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32453", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32453", "issueType": "Bug", "key": "PDOC-124", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Won't Fix", "resolutionDate": "2016-11-01T16:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "JSON: Inconsistent naming of function parameters", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "It makes sense in Json, it is just extra data - for HTML what is the recommended style of presentation - separate section with groups of parameters and a main alphabetical list, or something else?\nStill, this would break the JSON API I think (since \"group\" would be a new concept). Adding group to \"param\" tag would be backwards compatible I think.", "created": "2016-10-11T04:54:00.000000" }, { "author": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "body": "{quote}for HTML what is the recommended style of presentation - separate section with groups of parameters and a main alphabetical list, or something else?{quote}\n\nI'd suggest multiple lists - the existing \"Parameters\" list for ungrouped parameters, and an additional heading per group with the group name and bullet point list of parameters.\n\n{quote}Still, this would break the JSON API I think (since \"group\" would be a new concept). Adding group to \"param\" tag would be backwards compatible I think.{quote}\n\nPerhaps, but the schema doesn't list known tag_name types (https://github.com/puppetlabs/puppet-strings/blob/master/JSON.md#docstring-objects) so I think the anybody reading the JSON data has to be reasonably careful to search for tag_name types that they understand (certainly, that's what I've been doing.) Adding new ones ought to be straight forward, at least in a minor release rather than major.", "created": "2016-10-11T05:04:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Yes, but nesting \"param\" under \"group\" would be a breaking change. Adding a list of groups with each param listed by name would not break API, nor would adding \"group\" to the param itself.", "created": "2016-10-11T05:50:00.000000" }, { "author": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "body": "The syntax I suggested here isn't correct:\n\n{code}\n@!group Database connection\n@param db_adapter Database adapter name\n@param db_host Database server hostname\n@param db_username Username to authenticate with\n@!endgroup\n{code}\n\nThe directive will group classes, defines and other handled objects, but not group tags such as {{@param}} on a single object - at least, not with the group directive supplied by YARD as far as I can tell.", "created": "2016-10-25T08:53:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This has been requested by other community members as well. Something to keep in mind.", "created": "2018-03-05T12:18:00.000000" } ], "components": [], "created": "2016-10-11T03:49:00.000000", "creator": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1d67d68c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9dvj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/16" } ], "description": "Support for grouping of parameters with a group name would be useful when documenting classes with tens of parameters, e.g. for \"advanced parameters\", \"database connection parameters\".\n\nIt appears that YARD has {{@!group}} and {{@!endgroup}} directives already, so a doc format such as this might work:\n\n{code}\n@!group Database connection\n@param db_adapter Database adapter name\n@param db_host Database server hostname\n@param db_username Username to authenticate with\n@!endgroup\n{code}\n\nand I'd expect group within the tags in the JSON output, with parameters nested below:\n\n{code}\n\"docstring\": {\n \"tags\": [\n {\n \"tag_name\": \"group\",\n \"docstring\": {\n \"text\": \"Database connection\",\n \"tags\": [\n {\n \"tag_name\": \"param\",\n \"text\": \"Database adapter name\",\n \"types\": [\n \"String\"\n ],\n \"name\": \"db_adapter\"\n },\n ....\n ]\n }\n }\n ]\n}\n{code}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32601", "fixedVersions": [], "id": "32601", "issueType": "Improvement", "key": "PDOC-123", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support groups of parameters", "timeSpent": "PT0S", "updated": "2019-05-01T15:16:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Thanks for the report, [~accountid:557058:371cce5a-def8-43ef-91e9-d177c322c20b]. I was able to reproduce this and figure out what's going on.\n\nIn all of our tests, we create 3.x functions like yours in the following way:\n\n{code}\nPuppet::Parser::Functions::newfunction(:testfunc, doc: <<-DOC\nthis function prints all the arguments it gets\n@param [Array] some args separated by spaces\n@return [undef] won't return anything\nDOC\n) do |args|\n args.each do |arg|\n puts arg\n end\n end\n{code}\n\n... rather than:\n\n{code}\nmodule Puppet::Parser::Functions\n newfunction(:testfunc, doc: <<-DOC\n{code}\n\n{{newfunction}} being separated from the {{Puppet::Parser::Functions}} namespace now confuses strings, while this used to work. This is indeed a regression. Note that if the function is created like in the first example above, strings will work correctly.", "created": "2016-10-10T15:23:00.000000" }, { "author": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "body": "Awesome, thanks for looking into this. For reference, the module I noticed this behavior on was [simp/simplib|https://forge.puppet.com/simp/simplib].", "created": "2016-10-11T08:13:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-10T14:58:00.000000", "creator": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The following function should be documented correctly by strings:\n\n{code}\nmodule Puppet::Parser::Functions\n newfunction(:testfunc, doc: <<-DOC\nthis function prints all the arguments it gets\n@param [Array] arg_list Some args separated by spaces\n@return [undef] won't return anything\nDOC\n) do |args|\n args.each do |arg|\n puts arg\n end\n end\nend\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@54bb5dfe" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9dif:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "recent releases included a regression where documenting puppet 3.x functions where {{newfunction}} was separated from the {{Puppet::Parser::Functions}} namespace would not produce proper yard documentation. This has been fixed." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_64143512_*|*_1_*:*_1_*:*_5494175_*|*_10007_*:*_1_*:*_3750963_*|*_5_*:*_1_*:*_4139774733_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_21835827" } ], "description": "When the input to strings has more than one function in {{lib/puppet/parser/functions/*}}, the generated yard documentation only includes content from the first function it finds, alphabetically. It is also not possible to find the function documentation without going opening the file manually.\n\nSteps to reproduce:\n# Clone my [test repo|https://github.com/jeefberkey/functest], which was generated with `puppet module generate` and using Puppet 3.8.7\n# {{bundle install}}\n# {{puppet strings generate}}\n# Open {{docs/index.html}} in a browser and look for the function documentation", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32427", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32427", "issueType": "Bug", "key": "PDOC-122", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:371cce5a-def8-43ef-91e9-d177c322c20b", "resolution": "Fixed", "resolutionDate": "2016-10-11T17:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings doesn't handle puppet 3.x API syntax when newfunction is on a newline", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-09T14:29:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c660141" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9cwn:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_76065256_*|*_1_*:*_1_*:*_2071320198_*|*_10007_*:*_1_*:*_78564881_*|*_3_*:*_1_*:*_4446368_*|*_5_*:*_1_*:*_2085660757_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_7091240" } ], "description": "When creating the gh-pages commit it would be great to note the source tree's state (e.g. git describe --long) in the commit message(and probably the generated HTML) so that users have a chance of understanding where the documentation came from.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32527", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32527", "issueType": "Improvement", "key": "PDOC-121", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Fixed", "resolutionDate": "2016-11-04T12:00:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "gh-pages commit should reference the source", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "created": "2016-10-09T14:25:00.000000", "name": "2016-10-09_21MS+0100_709x391.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12371" }, { "attacher": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "created": "2016-10-09T14:25:00.000000", "name": "2016-10-09_21MS+0100_820x381.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12375" } ], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "David - this has to do with the use of Jekyll on github io.\nhttps://help.github.com/articles/files-that-start-with-an-underscore-are-missing/\n\nit can be turned off by adding a {{.nojekyll}} file to the root. (There are other options - see the link).\n\nIf you also want Jekyll processing to be available for some files, the file may not start with one of the special Jekyll characters (see the link, there are several ways to do that).\n", "created": "2016-10-10T08:21:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Question is if we should automatically add {{.nojekyll}} or simply pick another name for the {{_index.html}} file that does not interfere with use of Jekyll.", "created": "2016-10-10T08:22:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "{{_index.html}} is not a very descriptive name. Fixing the jekyll issue as a sideeffect of improving the name doesn't sound wrong. ", "created": "2016-10-10T08:26:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think it is better to use a different and more descriptive name than {{_index.html}} and leave Jekyll turned on since users may want to use it for other contents.", "created": "2016-10-10T08:51:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "+1.", "created": "2016-10-10T08:55:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Sadly, the usage of {{_index.html}} is thoroughly baked into YARD itself, and as far as I can tell is not configurable. I'm considering filing a request with them to make that configurable, and short term adding an exception to our own {{_config.yml}} to publish the file without turning off jekyll. Thoughts?", "created": "2016-10-12T16:33:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "{{_index.html}} comes essentially hardcoded into a base YARD template", "created": "2016-10-12T16:34:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "ok - the use of jekyll in combination with strings output is not really needed. ", "created": "2016-10-12T17:10:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "PR is up at https://github.com/puppetlabs/puppet-strings/pull/115\n\nWe don't even actually have to turn Jekyll off. I just added a bit to the rake task to add a Jekyll {{_config.yml}} file with {{include: _index.html}}, which just allows the file to be published. That config only ends up in the doc directory of the gh_pages branch.", "created": "2016-10-13T13:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at: bda361a", "created": "2016-10-13T13:21:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-10-09T14:25:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "After using the GH pages rake task as instructed by the README, the _index.html file should be accessible on the published GH site." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1104fca5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9cwf:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Previously when using the strings:gh_pages:update rake task, the generated _index.html file was not accessible in the published documentation. This change adds a configuration option to the project to allow the file to be published." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_984310_*|*_1_*:*_1_*:*_64626865_*|*_10007_*:*_1_*:*_158961_*|*_3_*:*_1_*:*_4660834_*|*_5_*:*_2_*:*_3555889729_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_424767585_*|*_10004_*:*_1_*:*_272300296" } ], "description": "Experimenting with the awsome puppet-string rake tasks, I published to https://davids.github.io/puppetlabs-ntp , but it turns out that some pages are not accessible there. Specifically https://davids.github.io/puppetlabs-ntp/_index.html leads to a 404, although the file is in the commit (https://github.com/DavidS/puppetlabs-ntp/tree/gh-pages).\n\nSee attached screenshots for details.\n\n{code}\ndavid@zion:~/git/puppetlabs-ntp$ bundle exec rake strings:gh_pages:update\nM\tPuppet/Parser/Functions.html\nM\t_index.html\nM\tfile.README.html\nM\tindex.html\nM\tpuppet_classes/ntp.html\nM\tpuppet_classes/ntp_3A_3Aconfig.html\nM\tpuppet_classes/ntp_3A_3Ainstall.html\nM\tpuppet_classes/ntp_3A_3Aservice.html\nM\ttop-level-namespace.html\nAlready on 'gh-pages'\nerror: Cannot pull with rebase: You have unstaged changes.\n[warn]: Missing @param tag for parameter 'config' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'config_dir' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'config_file_mode' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'config_epp' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'config_template' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'disable_auth' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'disable_dhclient' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'disable_kernel' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'disable_monitor' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'fudge' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'driftfile' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'leapfile' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'logfile' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'iburst_enable' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys_enable' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys_file' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys_controlkey' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys_requestkey' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'keys_trusted' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'minpoll' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'maxpoll' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'package_ensure' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'package_manage' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'package_name' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'panic' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'peers' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'preferred_servers' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'restrict' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'interfaces' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'interfaces_ignore' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'servers' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'service_enable' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'service_ensure' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'service_manage' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'service_name' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'service_provider' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'stepout' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'step_tickers_file' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'step_tickers_epp' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'step_tickers_template' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tinker' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos_minclock' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos_minsane' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos_floor' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos_ceiling' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'tos_cohort' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'udlc' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'udlc_stratum' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'ntpsigndsocket' near manifests/init.pp:4.\n[warn]: Missing @param tag for parameter 'authprov' near manifests/init.pp:4.\n[warn]: Missing documentation for Puppet class 'ntp::install' at manifests/install.pp:2.\n[warn]: Missing documentation for Puppet class 'ntp::service' at manifests/service.pp:2.\nFiles: 5\nModules: 1 ( 1 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nAttributes: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 4 ( 2 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\nPuppet Functions: 0 ( 0 undocumented)\n 40.00% documented\n[gh-pages 5e1e378] [strings] Generated Documentation Update\n 9 files changed, 21 insertions(+), 14 deletions(-)\nCounting objects: 14, done.\nDelta compression using up to 8 threads.\nCompressing objects: 100% (12/12), done.\nWriting objects: 100% (14/14), 1.27 KiB | 0 bytes/s, done.\nTotal 14 (delta 10), reused 0 (delta 0)\nremote: Resolving deltas: 100% (10/10), completed with 10 local objects.\nTo github.com:DavidS/puppetlabs-ntp.git\n 7f46ce5..5e1e378 gh-pages -> gh-pages\ndavid@zion:~/git/puppetlabs-ntp$ \n{code}\n\n", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32479", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32479", "issueType": "Bug", "key": "PDOC-120", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Fixed", "resolutionDate": "2016-10-18T11:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Generated _index.html page is not accessible on github.io", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-10-07T15:02:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@771c1bf0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9cnb:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_964967_*|*_1_*:*_1_*:*_40607_*|*_5_*:*_1_*:*_0" } ], "description": "See PDOC-118, which I accidentally referenced in the commit :). Opening this to match the commit message, instead of force pushing master.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32525", "fixedVersions": [], "id": "32525", "issueType": "Task", "key": "PDOC-119", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-07T15:19:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add required ruby version to gemspec", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Oops, PDOC-119 tracks the actual git commit for this", "created": "2016-10-07T15:04:00.000000" } ], "components": [], "created": "2016-10-06T17:23:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7bc497a4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c5r:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_295040_*|*_1_*:*_1_*:*_17990_*|*_10007_*:*_1_*:*_6026693_*|*_3_*:*_1_*:*_71714976_*|*_6_*:*_1_*:*_0" } ], "description": "The strings gemspec doesn't currently have a required_ruby_version field. This makes the required version show up as '> 0' on rubygems.org, but we really only test and support ruby >= 1.9.3.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32426", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32426", "issueType": "Task", "key": "PDOC-118", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Duplicate", "resolutionDate": "2016-10-07T15:04:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add ruby version requirement in puppet-strings.gemspec", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-10-06T17:06:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7109352" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c4v:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_331817648_*|*_6_*:*_1_*:*_0" } ], "description": "Close any tickets which have been resolved for the release.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32451", "fixedVersions": [], "id": "32451", "issueType": "Sub-task", "key": "PDOC-117", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T13:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Close all resolved tickets in Jira (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Announcements sent to announce, dev and users mailing lists.", "created": "2016-10-10T13:08:00.000000" } ], "components": [], "created": "2016-10-06T17:06:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@32d90a5a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c4n:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_331312754_*|*_5_*:*_1_*:*_533317_*|*_6_*:*_1_*:*_0" } ], "description": "Send out the release notes to puppet-dev, puppet-users and puppet-announce google groups, as well as internally at dev-team@puppetlabs.com. Also ping in IRC and Slack.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32436", "fixedVersions": [], "id": "32436", "issueType": "Sub-task", "key": "PDOC-116", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T13:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Send out announcements (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-10-06T17:04:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@590123f7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c4f:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_330754336_*|*_5_*:*_1_*:*_1199495_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32425", "fixedVersions": [], "id": "32425", "issueType": "Sub-task", "key": "PDOC-115", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T12:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Push tag to GitHub (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Lindsey Smith\u00b711:43 AM: Gooooooooooo", "created": "2016-10-10T12:44:00.000000" } ], "components": [], "created": "2016-10-06T17:03:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@404e6a39" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c47:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_330053924_*|*_5_*:*_1_*:*_1941301_*|*_6_*:*_1_*:*_0" } ], "description": "Verify the release with necessary strings stakeholders.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32402", "fixedVersions": [], "id": "32402", "issueType": "Sub-task", "key": "PDOC-114", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T12:44:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Go/no-go meeting (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "FOSS puppet-agent latest:\n\nVerified on Centos 7 by running {{strings generate}} on the apache, concat and stdlib modules. Documentation was generated as expected in both HTML and JSON.\n\nPE 3.8:\n\nVerified on Centos 7 in the same way.", "created": "2016-10-10T12:41:00.000000" } ], "components": [], "created": "2016-10-06T17:02:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@214ccd0a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c3z:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_329946955_*|*_5_*:*_1_*:*_2119916_*|*_6_*:*_1_*:*_0" } ], "description": "Verify the gem works on a few platforms. Check that the major features of this release are all functional.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32326", "fixedVersions": [], "id": "32326", "issueType": "Sub-task", "key": "PDOC-113", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T12:41:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Build and smoke test gem (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Tagged 0.99.0 at 7df4f9e87c91c5eb2711496eb6ae4eb2eb95e02e", "created": "2016-10-10T12:15:00.000000" } ], "components": [], "created": "2016-10-06T16:59:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3a1d8094" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c3r:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_328524414_*|*_5_*:*_1_*:*_3683365_*|*_6_*:*_1_*:*_0" } ], "description": "Tag the release locally, but don't push it to GitHub yet.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32475", "fixedVersions": [], "id": "32475", "issueType": "Sub-task", "key": "PDOC-112", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T12:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Tag the release (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Subject:\n\nAnnounce: Strings 0.99.0 Released!\n\nBody:\n\nHello, all! Today, we're pleased to announce the release of puppet-strings 0.99.0! Strings is a YARD-based documentation tool for Puppet extensions written in Puppet and Ruby. Given some simple in-code comments containing YARD tags, it will generate consistent HTML or JSON documentation for all of your Puppet 3x/4x API functions, Puppet language functions, Ruby classes, Ruby methods, types, and providers.\n\nThis release includes a near-complete rewrite of the project, fixing many bugs from previous versions and generally improving the user experience. Note that this release is intended to be the last stop before the strings major version 1.0.0 is released, and nearly all of the functionality of the major release is included.\n\nNote also: backwards-incompatible changes have been made to the original JSON schema.\n\n*Highlights*:\n - Both HTML and JSON documentation has been split into sections based on type: Puppet 3x API functions, Puppet 4x API functions, Ruby classes/methods, Puppet language functions, types, and providers.\n - New --emit-json and --emit-json-stdout commandline options for generating JSON documentation.\n - A brand new JSON schema organized around the new separation of types.\n - Support for custom functions written in the puppet language.\n - Support for function overloads via the create_function 4x API.\n - YARD has been bumped to the latest version, greatly enhancing the look and usability of the HTML output.\n\n*Other important notes*:\n - Markdown is now the default format for parsing in-code docstrings.\n - The runtime dependency of puppet has been removed in favor of a gem 'requirement' which appears on rubygems.org. This prevents conflicts when installing strings in older versions of Puppet Enterprise. We recommend you install the puppet-strings gem using puppet, as suggested in the README.\n\nNever used Strings? Check out the README linked below and give it a try!\n\n\nThe CHANGELOG can be found here: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md\n\nThe ruby gem can be found here: https://rubygems.org/gems/puppet-strings\n\nInstallation and usage instructions can be found here: https://github.com/puppetlabs/puppet-strings/blob/master/README.md\n\n\nTo track issues related to this release or report issues, see out the PDOC JIRA project:\n\n* JIRA Project: https://puppet.atlassian.net/browse/PDOC\n\n* Fixes for 0.99.0: https://puppet.atlassian.net/issues/?filter=22705\n* Introduced in 0.99.0: https://puppet.atlassian.net/issues/?filter=22706", "created": "2016-10-07T15:56:00.000000" } ], "components": [], "created": "2016-10-06T16:40:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@754111de" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c2v:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_85346026_*|*_3_*:*_1_*:*_2610_*|*_10009_*:*_1_*:*_243193302_*|*_5_*:*_1_*:*_4793721_*|*_6_*:*_1_*:*_0" } ], "description": "These will go out to puppet-dev and puppet-users. Will collaborate with [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79].", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32389", "fixedVersions": [], "id": "32389", "issueType": "Sub-task", "key": "PDOC-111", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-10T11:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Prepare long form release notes (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "We now have PDOC versions for both 0.99.1 and 1.0.0.\n\nFilters:\nFixed in 0.99.0: https://puppet.atlassian.net/issues/?filter=22705\nIntroduced in 0.99.0: https://puppet.atlassian.net/issues/?filter=22706", "created": "2016-10-07T15:20:00.000000" } ], "components": [], "created": "2016-10-06T16:39:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50031972" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9c2n:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_81753807_*|*_5_*:*_1_*:*_251663526_*|*_6_*:*_1_*:*_0" } ], "description": "(Initial planned release date: 2016-10-10)\n\nThis happens on Jira - we need to clean up the current release and prepare for the next release.\n\nCreate a version we can target future issues or issues that didn't make it into the current release. (e.g. if we're releasing Facter 1.7.4, make sure there's a 1.7.5 version (or at least 1.7.x if there's isn't another bug release planned for the near future)\nCreate a public pair of queries for inclusion in the release notes/announcement. These allow easy tracking as new bugs come in for a particular version and allow everyone to see the list of changes slated for the next release (Paste their URLs into the \"Release story\" ticket):\n'project = XX AND affectedVersion = 'X.Y.Z', Save as \"Introduced in X.Y.Z\", click Details, add permission for Everyone\n'project = XX AND fixVersion = 'X.Y.Z', Save as \"Fixes for X.Y.Z\", click Details, add permission for Everyone\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32325", "fixedVersions": [], "id": "32325", "issueType": "Sub-task", "key": "PDOC-110", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-07T15:21:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Is the Jira tidy-up done for this release and prepared for the next one? (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "All of the old code was gutted at https://github.com/puppetlabs/puppet-strings/commit/7ae8e74ec571c84a31dd2aee42aaa86f09a8ece3, thus we don't really need to worry about the code associated with them. The rewrite commit is tracked as PDOC-63, and everything after that is associated with a ticket or is a (maint) commit.", "created": "2016-10-07T15:14:00.000000" } ], "components": [], "created": "2016-10-06T16:36:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@87cf7cc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9bzr:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_81538534_*|*_5_*:*_1_*:*_252053432_*|*_6_*:*_1_*:*_0" } ], "description": "This is the first time in a while this has been done, but we can probably use https://github.com/puppetlabs/ticketmatch to do this.\n\nMake sure all git commits (besides maint) have Jira tickets and vice versa.\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32522", "fixedVersions": [], "id": "32522", "issueType": "Sub-task", "key": "PDOC-109", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-07T15:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Reconcile git commits and JIRA tickets (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2016-10-10T13:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Changelog entry added for 0.99.0 and version bumped in the gemspec. Tests are all passing, and all tickets are resolved for this release. See https://puppet.atlassian.net/issues/?filter=22705", "created": "2016-10-07T15:18:00.000000" } ], "components": [], "created": "2016-10-06T12:25:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2fee7a8e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9btb:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_2865770_*|*_1_*:*_1_*:*_93617472_*|*_10007_*:*_1_*:*_291819_*|*_10009_*:*_1_*:*_6204_*|*_5_*:*_1_*:*_251810325_*|*_6_*:*_1_*:*_0" } ], "description": "If there are any version dependencies expressed in the code base, make sure these are up to date. Strings will need its CHANGELOG and gemspec updated.\n\nAll tests (spec, acceptance) should be passing on all platforms.\n\nMove all items that should be moved from Ready for CI to Ready for Review\nHave all tickets been resolved (passed Functional Review)? If not please add any missing tickets to the current sprint's board.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32401", "fixedVersions": [], "id": "32401", "issueType": "Sub-task", "key": "PDOC-108", "labels": [], "originalEstimate": "PT0S", "parent": "32448", "parentSummary": "puppet-strings 0.99.0 Release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-07T15:18:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Is the code ready for release? (PDOC 0.99.0)", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "62450221ad6b7e006aa4e34c", "attachments": [], "comments": [ { "author": "557058:fb0bff9d-dc4d-45f3-b875-a76700f9736c", "body": "[~accountid:62450221ad6b7e006aa4e34c] to fill out sub tasks", "created": "2016-10-05T14:50:00.000000" } ], "components": [], "created": "2016-10-05T14:49:00.000000", "creator": "557058:fb0bff9d-dc4d-45f3-b875-a76700f9736c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@77fa19f4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9awn:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_77501096_*|*_3_*:*_1_*:*_348882571_*|*_6_*:*_2_*:*_11110" } ], "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32448", "fixedVersions": [], "id": "32448", "issueType": "Task", "key": "PDOC-107", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:fb0bff9d-dc4d-45f3-b875-a76700f9736c", "resolution": "Fixed", "resolutionDate": "2016-10-10T13:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings 0.99.0 Release", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Immediately after creating this ticket I looked at https://github.com/puppetlabs/puppet-strings/blob/master/spec/unit/puppet-strings/json_spec.rb and realized JSON output is already covered in specs.\n\nI'm going to add a small test to ensure the {{--emit-json}} options are working, and we'll be pretty much set.", "created": "2016-09-30T17:36:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "PR at https://github.com/puppetlabs/puppet-strings/pull/106", "created": "2016-09-30T17:38:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at: f1c7ad3", "created": "2016-10-01T07:06:00.000000" } ], "components": [], "created": "2016-09-30T12:30:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "An acceptance test which parses various puppet / ruby constructs and compares output to the correct schema." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@104e1602" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz96gv:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_199191454_*|*_1_*:*_1_*:*_7800725_*|*_10007_*:*_1_*:*_48447789_*|*_3_*:*_1_*:*_10661106_*|*_5_*:*_1_*:*_600846565_*|*_6_*:*_1_*:*_0" } ], "description": "Since the JSON output of strings is what will be consumed by the forge, we want to add some more robust acceptance tests to ensure that no regressions occur. We can setup a schema and run tests similar to Facter's JSON schema test.", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32388", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32388", "issueType": "Bug", "key": "PDOC-106", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-03T14:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Acceptance tests for strings JSON output", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Woot!", "created": "2018-05-10T10:31:00.000000" } ], "components": [], "created": "2016-09-29T17:31:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1005be7c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt8f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_41724895897_*|*_5_*:*_1_*:*_8906601097_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9053071578" } ], "description": "Currently the only docs for strings are [on github|https://github.com/puppetlabs/puppet-strings], which makes strings harder for users to discover and appear to be a less-than-first-class citizen in the puppet ecosystem.\n\nThis is publishing the style guide for Puppet Strings on docs.puppet.com and add any related documentation to the docs.\n\nBroader impact:\n * Other modules docs\n * Style guide\n * Etc", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32520", "fixedVersions": [], "id": "32520", "issueType": "Task", "key": "PDOC-105", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Done", "resolutionDate": "2018-08-21T12:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings docs on docs.puppet.com", "timeSpent": "PT0S", "updated": "2018-08-21T12:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "body": "I extended rubydoc.info per the description to create https://github.com/domcleal/puppetmodule.info, adding support to sync Puppet module data from the Forge and using Puppet Strings to generate docs instead of plain YARD.\n\nhttp://www.puppetmodule.info/ is the result.", "created": "2017-01-17T08:03:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Our plans are to integrate puppet-strings into the forge, not support in a standalone site.", "created": "2018-01-25T14:17:00.000000" } ], "components": [], "created": "2016-09-29T17:25:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@540e2a47" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtpb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Jan/17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_41723481914_*|*_6_*:*_1_*:*_0" } ], "description": "Goal: provide a website that hosts puppet strings generated docs for modules hosted on the Forge.\n\nVia [~accountid:557058:b62c47a4-37e4-460d-8791-518bdfebf3e8]:\n{quote}Basically rubydoc.info, but for Puppet code. This would also help give\nus insights into popular modules that aren't on the forge.\n\nie. you can already do:\nhttp://www.rubydoc.info/github/puppetlabs/puppetlabs-apache/master\n\nBut this doesn't run strings. So the same service, for with strings!\n\nI think the source for that service is here:\nhttps://github.com/docmeta/rubydoc.info. I played around with it a\nlittle at Config Management Camp but not enough to get it actually\nworking. You could get the list of repos to seed from the BigTable\nGitHub dump.{quote}", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32562", "fixedVersions": [], "id": "32562", "issueType": "Story", "key": "PDOC-104", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Won't Do", "resolutionDate": "2018-01-25T14:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings as a Service", "timeSpent": "PT0S", "updated": "2018-01-25T14:17:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-09-29T17:23:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4cf3b46f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-5" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Potential future puppet strings work" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_teal" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz95qf:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1114848034_*|*_6_*:*_1_*:*_0" } ], "description": "The collecting place for potential future puppet strings work.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32435", "fixedVersions": [], "id": "32435", "issueType": "Epic", "key": "PDOC-103", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Duplicate", "resolutionDate": "2016-10-12T15:04:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Potential future puppet strings work", "timeSpent": "PT0S", "updated": "2019-05-01T15:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "I think this should also include a bunch of example code for best practices for how to document all of the things strings supports. I've found https://github.com/peterhuene/strings-demo useful, but it includes some outdated practices that we shouldn't encourage. ", "created": "2016-10-25T12:39:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Questions/things about this work:\n\n1) What format should [~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24]'s suggested docs take? I'm not familiar with how we write this sort of documentation, but something like 'Converting an existing module to strings' almost sounds like a blog post?\n\n2) Where should these docs live? This may depend on the format.\n\n3) [~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] what do you mean by 'Includes using strings as a docs coverage tool'? Does that just mean that after generating docs with strings, you'd be able to see where you lack in-code documentation?\n\n4) I'd like to borrow [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] for this to ensure quality of the docs.\n\nEdit: also, the modules team has started thinking about this as well. We should work with them on this, as they have far greater experience with modules and what good strings documentation style should look like.", "created": "2016-11-03T11:51:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:62450221ad6b7e006aa4e34c], I think you're right that there's a blog post here", "created": "2016-11-07T12:06:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "[~accountid:62450221ad6b7e006aa4e34c] +1 to blog post and could also be the basis for a HOWTO or similar in the strings repo/gem docs. And yes, we should link to these from the places [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] mentioned ", "created": "2016-11-07T12:23:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] sounds good! What do you think is needed here as a predoc ticket?", "created": "2016-11-07T12:39:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Ah, for predocs that we might want to ticket, I think I'm looking for the examples listed above in the description. (Could use this ticket and link any others, but I guess I was thinking we don't usually work from Story tickets.)\n\nReally, I'd use that material + blog post + existing README to put things together, so it's all kinda predocs to me.", "created": "2016-11-07T12:48:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] ah, I see. The [existing readme|https://github.com/puppetlabs/puppet-strings/blob/master/README.md] actually already has good examples for how to document everything that strings supports (puppet classes, defined types, resource types, providers, 3x functions, 4x functions, and puppet language functions). I also recently added a 'further examples' section that goes into a little bit more depth about the {{@example}} tag and multi-line descriptions.\n\nIMO, the nuts and bolts of the docs are all already there, and now we just need a better narrative to pull them all together into a cohesive piece. Converting an existing module to strings and adding strings docs to a new module is a matter of using those examples in the README to add the proper tags to each of those puppet / ruby constructs. I'm not totally sure what a full doc on those would look like, other than \"remove RDoc comments and add YARD comments\", for example.\n\nAt least, this is all where my thinking is at now. Does that make sense? (I do want to work on some sort of reference module that has a real module skeleton containing strings best practices, but that's a separate piece).", "created": "2016-11-07T13:32:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I'm not totally sure what a full doc looks like yet either, [~accountid:62450221ad6b7e006aa4e34c]! :-D It sounds like predocs are in pretty good shape already, though, so maybe the next thing here is just for me to work through the README. Are you down to do a blog post? I am happy to look at it if you'd like to draft it.", "created": "2016-11-07T14:56:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Sure, I can give it a shot! I created PDOC-132 to track the blog post part of this.", "created": "2016-11-07T15:30:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Sweet, I made PDOC-133 to reflect editing the existing README and scoping/ticketing the work for other docs changes. I'm taking the DOCS component off of this ticket, because it specifically refers to the DOCS team and the story involves more than that. (DOCS component puts things on the Docs triage board, and it's not necessary for this to be there.)", "created": "2016-11-07T17:05:00.000000" }, { "author": "557058:fb0bff9d-dc4d-45f3-b875-a76700f9736c", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] [~accountid:62450221ad6b7e006aa4e34c] Please link related stories to Strings 1.0 Epic.", "created": "2016-11-16T14:09:00.000000" } ], "components": [], "created": "2016-09-29T15:54:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3212dc61" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9x5r:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4144442950_*|*_6_*:*_1_*:*_0" } ], "description": "In addition to the [existing strings docs|https://github.com/puppetlabs/puppet-strings], we need to provide examples in docs for:\n* Converting an existing module to strings\n* Add strings docs to a module with no docs\n* Includes using strings as a docs coverage tool", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32387", "fixedVersions": [], "id": "32387", "issueType": "Story", "key": "PDOC-101", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Done", "resolutionDate": "2016-11-16T14:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings examples", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-09-29T15:51:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@348582e3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-8" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Strings 1.0 release" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_purple" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyo6of:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_4671084332_*|*_6_*:*_2_*:*_511137411" } ], "description": "The things that need to be done to release the 1.0 version of puppet strings beyond completing PDOC-97.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32600", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32600", "issueType": "Epic", "key": "PDOC-100", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Fixed", "resolutionDate": "2016-11-28T14:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings 1.0 release", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think this should be handled as follows:\n\nA {{:statement}} function should be documented as having {{Undef}} return value (the implementation ensures this).\n\nA {{:rvalue}} function should be documented as having {{Any}} return value (unless there being a \\@return \\[T] tag)\n\nStretch goal:\n* log an error if function is of {{:statement}} type has a \\@return \\[T] other than T == Undef in any of its overloads\n\nThe {{:arity}} is really difficult to handle and difficult to understand for negative values. Just blurting out that arity is -n is not very helpful. Especially since this is often combined with overloading done by the logic in the function based on the types and number of given arguments. Attempting to map overloads documented in yard with arity gets complicated quickly. What could be done is automatically name the parameters if there is no name given to them in yard dags (that is something like $p1, $p2, ...). But since the only derivable data type and information is {{Any}} and a name like {{$p3}} any quality documentation would have to have been provided by the user in tags. These are the reasons we decided to not process arity at all.\n\nIf going ahead with this - there is (or at least was in 3.x when we supported Ruby 1.8.7) a utility to generate names from arity since Ruby 1.8.7 lacks the ability to describe a callable with parameter names.\n\nThe :raise adds no value what so ever since all functions can raise exceptions. And the existing ones pretty much all misuse the existing exception classes (like ParseError - which is supposed to be raised when there is an actual error with parsing and where you know a source location - 3.x functions have no clue). There is no function in puppet that uses :raise - I actually doubt that it is supported since I cannot find the {{:raise}} symbol in the source\n\nGiven that what can be automatically generated from the information in a 3.x function is of such low value is it really meaningful to do any of this? I think it is better to encourage users to migrate 3.x functions to 4.x since the automatically generated documentation is then of good quality. If not wanting to migrate, the other option is to provide all the details in yard tags.\n\nI think a scheme like automatically naming parameters can actually be confusing as old style documentation has no tags and there is no way to find the names of parameters - thus, we would output the generated names like $p1, $p2, while the documentation talks about say $port, and $domain - totally confusing. And, if a user invests the time to actually tag - then the generated names would be suppressed anyway.\n", "created": "2016-09-28T19:18:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] all very good points. Perhaps it's best if we require explicit documentation with yard tags for 3.x documentation rather than putting any extra effort into auto-generating docs for this, like you said. I think I'll go ahead and close this out, and if we get asked for this we can always reopen.", "created": "2016-09-29T00:05:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:62450221ad6b7e006aa4e34c] Agree.", "created": "2016-09-29T07:51:00.000000" } ], "components": [], "created": "2016-09-28T16:54:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "When run on a 3.x function, strings will include all {{newfunction}} options in its output." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3b77c45d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz945b:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_25956884_*|*_6_*:*_1_*:*_0" } ], "description": "Example function:\n{code}\nPuppet::Parser::Functions::newfunction(\n :raise,\n :type => :statement,\n :arity => 1,\n :doc => <<-DOC\nRaises a `Puppet::Error` exception.\n@param [String] message The exception message.\n@return [Undef]\n@example Raise an exception.\n raise('nope')\nDOC\n) do |args|\n raise Puppet::Error, args[0]\nend\n{code}\n\nIn this sample, strings ignores all of the options for {{newfunction}} except {{:doc}}. It should also pick up the rest of the options and display them.\n\nFrom Peter:\n\nThe handler should check the type when scanning the options and set it on the function (ignored for 4.x functions since this is a 3.x construct) and probably should display it in the box info for functions", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32424", "fixedVersions": [], "id": "32424", "issueType": "Bug", "key": "PDOC-99", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Won't Fix", "resolutionDate": "2016-09-29T00:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings ignores 3.x function options", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-09-21T12:54:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3a590dba" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-7" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet Strings Maintenance" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "In Progress" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "purple" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyo6yn:" } ], "description": "This epic collects potential future work around puppet strings to improve life for the puppet docs team.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32541", "fixedVersions": [], "id": "32541", "issueType": "Epic", "key": "PDOC-98", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "status": "Developing", "statusCategory": "In Progress", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings Maintenance", "timeSpent": "PT0S", "updated": "2019-05-28T17:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-09-21T12:30:00.000000", "creator": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7050811c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-5" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Initial increment for puppet strings and docs workflow" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_teal" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymvh3:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4068522609_*|*_6_*:*_1_*:*_0" } ], "description": "This epic tracks the work required for puppet strings to be minimally useful to the Puppet docs team.\n\nPotential future work for puppet strings and improving its utility for the docs team is tracked in PDOC-98\n\n*Acceptance criteria:*\n# Running from bundler in the docs team workflow, puppet strings can consume the puppet repo to produce JSON output for resource types/providers and functions\n# Confirmation that JSON format is sufficient\n\nRaw notes to be cleaned up later:{quote}\nGenerated puppet references, for each .y release there is a tool that generates docs\nProblem is the embedded docs in the puppet repo are in different formats\nGoal is that strings can cope with the worst of these formats\n\nresource types and providers: change frequently, important to experienced users\n- current tooling is extremely brittle\n- done: you can point `puppet strings #{puppet dir} --json` at puppet core --> goes into updated versions of existing templates, which live in puppet-docs/lib\n-- output needs to be mostly the same\n-- comprehensive: updating the actual docstrings\n{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32434", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32434", "issueType": "Epic", "key": "PDOC-97", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "resolution": "Fixed", "resolutionDate": "2016-11-07T13:39:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Initial increment for puppet strings and docs workflow", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Maybe something for the future?", "created": "2018-03-05T12:15:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Update! Some of these generated docs no longer need to be generated, because:\n* they are not useful for most users (indirection)\n* they are stable docs and can be handled as more-or-less static docs (metaparameter, report)\n* they aren't in the docs repo or recent docs memory at all (providers).\n\nI am in the process of removing the above docs from the docs generation tooling and the puppet-docs repo.\n\nThe docs that we WOULD like Strings to handle are:\n*configuration: Strings does NOT generate this, and tech pubs would love for Strings to do this.\n* function: Strings generates this, but may have some issues? I need to look at a diff, it might be fine actually.\n* type: Strings generates this, but with numerous problems.\n\n", "created": "2019-08-12T15:18:00.000000" } ], "components": [ "DOCS" ], "created": "2016-09-15T17:52:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@110cd13e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Strings should document core puppet references" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "In Progress" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt6v:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "`puppet doc` provided a facility for creating reference docs from {{lib/puppet/reference}}. That includes the following:\n\n{code}\n[16:46:24] whopper:~/Coding/puppet \u2039master*\u203a \u00bb bundle exec puppet doc --list\nconfiguration - A reference for all settings\nfunction - All functions available in the parser\nindirection - Indirection types and their terminus classes\nmetaparameter - All Puppet metaparameters and all their details\nproviders - Which providers are valid for this machine\nreport - All available transaction reports\ntype - All Puppet resource types and all their details\n{code}\n\nStrings currently handles functions, providers, and types. The others live at https://puppet.com/docs/puppet/latest/ (example, https://puppet.com/docs/puppet/latest/indirection.html) (link updated by Jean Bond 12 August 2019)\n\nStrings has never supported indirection, metaparameters, reports or configuration docs. The docs team will need these to be functional to populate the site.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32433", "fixedVersions": [], "id": "32433", "issueType": "Epic", "key": "PDOC-96", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "status": "Developing", "statusCategory": "In Progress", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)", "timeSpent": "PT0S", "updated": "2019-08-30T15:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c08e1562ab90069f8aed4", "body": "Word. We'll want this for docs integration stage 2 (types and providers reference), but it's not relevant to stage 1 (function reference). ", "created": "2016-10-06T19:15:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-09-14T13:56:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Strings should parse the following provider correctly (i.e, it should group the combined 'osfamily => redhat and operatingsystemmajrelease => 7 defaultfors together:\n\n{code}\nPuppet::Type.type(:database).provide :linux do\n confine 'operatingsystem' => 'fedora'\n defaultfor :osfamily => 'linux'\n defaultfor :osfamily => 'RedHat', :operatingsystemmajrelease => '7'\n commands :database => '/usr/bin/database'\n\n desc 'The database provider on Linux.'\n\n # ...\nend\n{code}\n\nJSON output should be:\n\n{code}\n \"defaults\": [\n [\n [\n \"osfamily\",\n \"linux\"\n ]\n ],\n [\n [\n \"osfamily\",\n \"RedHat\"\n ],\n [\n \"operatingsystemmajrelease\",\n \"7\"\n ]\n ]\n ],\n{code}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7f6a5334" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8ulz:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Strings previously did not handle multiple, combined `defaultfor` statements in puppet providers. This fix updates the logic around storing these statements so that they can be displayed correctly. This change includes a breaking change to the JSON schema." }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Oct/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_66819011_*|*_1_*:*_1_*:*_2323605719_*|*_10007_*:*_1_*:*_9269977_*|*_3_*:*_1_*:*_9351330_*|*_5_*:*_1_*:*_4054105898_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_21955552" } ], "description": "Note: this also affects Peter's rewrite.\n\nExample: the systemd service provider:\n\n{code}\n defaultfor :osfamily => [:archlinux] \u2502\n defaultfor :osfamily => :redhat, :operatingsystemmajrelease => \"7\" \u2502\n defaultfor :osfamily => :redhat, :operatingsystem => :fedora \u2502\n defaultfor :osfamily => :suse \u2502\n defaultfor :operatingsystem => :debian, :operatingsystemmajrelease => \"8\" \u2502\n defaultfor :operatingsystem => :ubuntu, :operatingsystemmajrelease => [\"15.04\",\"15.10\",\"16.04\",\"16.10\"] \u2502\n defaultfor :operatingsystem => :cumuluslinux, :operatingsystemmajrelease => [\"3\"]\n{code}\n\n... but strings documents this as:\n\n{code}\nDefault Provider For\noperatingsystem - debian\noperatingsystemmajrelease - ['5','6','7']\n{code}", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32324", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32324", "issueType": "Bug", "key": "PDOC-95", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-12T17:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings doesn't handle multiple `defaultfor`s in providers correctly", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Thanks for the report - we are aware of many errors in the current version of Puppet Strings. A major overhaul and update to a later yard is in the process. We are planning to have a new release of Puppet Strings shortly. When that is out it would be great if you could test if this is then still a problem.\n\nStay tuned...", "created": "2016-09-14T09:21:00.000000" }, { "author": "557058:30b5c31c-aff1-4b34-8c3e-742c2327385d", "body": "Will do, thanks for the update Henrik!", "created": "2016-09-14T10:37:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "As of 0.99.0, there's no indication that this is still a bug in the rewrite. I'm closing this ticket out, but in the unlikely event that someone encounters this again, feel free to reopen.", "created": "2016-11-03T13:30:00.000000" } ], "components": [ "DOCS" ], "created": "2016-09-14T08:08:00.000000", "creator": "557058:30b5c31c-aff1-4b34-8c3e-742c2327385d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@246e1ac3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8u47:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4339330222_*|*_6_*:*_1_*:*_0" } ], "description": "Running strings on a defined type with a type results in a stack trace.\n\n\n{code}\n$ puppet strings yardoc\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler:\n[error]: in `modules/multipath/manifests/device_entry.pp`:101:\n\ndefine multipath::device_entry (\n String $features = '',\n ) {\n}\n\n[error]: ArgumentError: wrong number of arguments (1 for 2)\n[error]: Stack trace:\n\t/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/pops/types/type_parser.rb:55:in `interpret_any'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/puppet-strings-0.4.0/lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb:19:in `block (2 levels) in '\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/puppet-strings-0.4.0/lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb:13:in `each'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/puppet-strings-0.4.0/lib/puppet_x/puppetlabs/strings/yard/handlers/defined_type_handler.rb:13:in `block in '\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:114:in `block (2 levels) in process'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:112:in `each'\n\nError: undefined method `map' for nil:NilClass\nError: Try 'puppet help strings yardoc' for usage\n{code}\n", "environment": "* puppet-agent-1.6.2-1.el7.x86_64\n* yard 0.8.7\n* puppet-strings 0.4.0\n* RHEL 7 x86_64", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32400", "fixedVersions": [], "id": "32400", "issueType": "Bug", "key": "PDOC-94", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:30b5c31c-aff1-4b34-8c3e-742c2327385d", "resolution": "Cannot Reproduce", "resolutionDate": "2016-11-03T13:30:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings crashes when documenting defined type with parameters with types", "timeSpent": "PT0S", "updated": "2016-11-03T13:30:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "62450221ad6b7e006aa4e34c", "created": "2016-10-13T13:42:00.000000", "name": "screenshot-1.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12372" } ], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Released with puppet-strings 1.0.0.", "created": "2016-11-28T14:21:00.000000" } ], "components": [], "created": "2016-09-13T11:20:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e158170" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8t9r:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2600547793_*|*_10007_*:*_1_*:*_8584782_*|*_3_*:*_1_*:*_442021_*|*_5_*:*_1_*:*_1801788156_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2169516385" } ], "description": "Currently, the search box specified in the {{fulldoc}} template overlaps with the first function / class / etc item in the list below. We'll need to figure out how to overwrite YARD's default CSS for that box.", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32423", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32423", "issueType": "Bug", "key": "PDOC-93", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-11-07T17:52:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Search box overlaps list items below on lefthand fulldoc navigator", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-09-13T11:17:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7294a5df" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8t9b:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2083332035_*|*_5_*:*_1_*:*_256797292_*|*_6_*:*_1_*:*_0" } ], "description": "Strings is not a puppet module and should not be named as such. GitHub will indefinitely redirect from the old repo name to the new one, so we won't break anyone by doing this. Some references will need to be updated in internal docs, however. We'll need to track these down and make note of them.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32386", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32386", "issueType": "Task", "key": "PDOC-92", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Fixed", "resolutionDate": "2016-10-07T13:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Rename the puppetlabs-strings repo to puppet-strings", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Also todo: figure out if docs needs this or if this is a 'nice to have'. If the latter, it probably doesn't belong in this epic.", "created": "2016-09-13T11:23:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "We need to have some research done on the validity of this use case. It seems like it could be a good idea but there's no point in doing it if no one is going to use it.", "created": "2018-01-25T14:36:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Throwing one possible use case at this:\nIn PE I would like to be able to browse the documentation for the code that is deployed in an environment.\n", "created": "2018-01-26T03:17:00.000000" }, { "author": "623a4a827910a200718ac35d", "body": "We use strings to generate whole-environment documentation as part of a CI job when we release updates to environments and serve it out via GitLab pages from our internal GitLab instance. It works fairly well, but there are some improvements that would make it a lot better (particularly for our Puppet \"end-users\" that work mostly with Hiera data and not the code). Independent per-module docs are far less useful for us.\n\nKey improvements that would directly and noticeably improve the end user experience in my environment (with regards to documentation):\n* Ability to handle any {{README.md}} optionally found in each module, and somehow make them available/visible in the whole-environment view.\n* Possibly related to the above, a module-level/centric search/list view in the left pane.\n* Documentation support for custom data types.\n* Links from custom data types used in parameter documentation to the place where the custom data type is documented.\n* Documentation for facts\n* The ability to distinguish a fact as having a stable \"API\" vs. an unstable one (or, \"public\" vs. \"private\"). While all facts are obviously always visible and usable from a technology standpoint, it would be good to clearly communicate expectations around whether the fact was intended for broader consumption (e.g. in external reporting) or only was intended for internal use in the module.\n* A type of \"index page\" where all class parameters are all collected and shown in one place so people can look to see if options are exposed to do something, even if they might not be familiar with what module it would found in or exactly what it would be called.\n\nI know some of these require some more fundamental things to be addressed in Strings (e.g. fact documentation) but I wanted to not only be clear that there is definitely a valid use case for this but also some of the key things that feel lacking to make it a more complete end-user experience.\n\nThat said, the Strings documentation we do enjoy now is great, far better than what we ever had with the old rdoc system (when it worked) and still provides a lot of value to our end users, so thank you for the work thus far on it.", "created": "2018-01-27T08:11:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:623a4a827910a200718ac35d]\n\nThanks for your comments! \n\nHaving Facts and Type aliases included in Strings is _definitely_ on the near-term wishlist. \n\nCan you clarify what you mean by the ability to \"handle _any_ README.md\" ? Are you referring to multiple READMEs in different directories? Other markdown files?\n\nThe other things you mentioned sound good, too, for the most part. Unfortunately resources are a bit low right now so we'll get to what we can but it may not be all of it.", "created": "2018-04-12T07:17:00.000000" } ], "components": [], "created": "2016-09-13T10:59:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7aa103" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtp3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jan/18" } ], "description": "Henrik's description of the use case:\n\nDocument an environment (i.e. layout as when compiling) to generate browseable docs for what is installed in an env. In this mode I can imagine wanting to skip certain modules, or regenerating one or a list of them (not sure how that plays with yard's web server and regeneration though).\n\nI believe at present, Strings will do this but only when using the webserver code path. We want to make this possible without having to also spin up the server.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32399", "fixedVersions": [], "id": "32399", "issueType": "Improvement", "key": "PDOC-91", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should be able to document an environment", "timeSpent": "PT0S", "updated": "2019-05-01T15:17:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think there are two fundamental modes of operation:\n* Document an environment (i.e. layout as when compiling) to generate browseable docs for what is installed in an env. In this mode I can imagine wanting to skip certain modules, or regenerating one or a list of them (not sure how that plays with yard's web server and regeneration though).\n* Document a single module - for this, the module is typically not installed in an environment (there is no env, no real modulepath, etc.). Difficult things here are handling references to things in other modules (OTOH, Strings currently does not do much processing of references).\n\nWhich of the use cases is it this ticket is intended for?\n", "created": "2016-09-13T07:20:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] whoops, I wrote this as I was running out the door :). We actually talked about both of those modes of operation with Peter. This ticket is meant to track the second, 'single module' use case. I just filed PDOC-91 to track the case of documenting an environment.\n\nAlso todo: figure out if docs needs this or if this is a 'nice to have'. If the latter, it probably doesn't belong in this epic.", "created": "2016-09-13T10:59:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This is what strings currently does, sans a \"cd\" command to change into any module's directory.", "created": "2018-01-25T14:37:00.000000" } ], "components": [], "created": "2016-09-12T17:43:00.000000", "creator": "62450221ad6b7e006aa4e34c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@27529401" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-98" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtov:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_43192434584_*|*_6_*:*_1_*:*_0" } ], "description": "Right now, strings will either parse a specific named file or everything in the current directory. There should be a {{puppet strings module}} command of some sort to document a specific module", "epicLinkSummary": "Puppet Strings Maintenance", "estimate": "PT0S", "externalId": "32599", "fixedVersions": [], "id": "32599", "issueType": "Improvement", "key": "PDOC-90", "labels": [], "originalEstimate": "PT0S", "parent": "32541", "parentSummary": "Puppet Strings Maintenance", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "62450221ad6b7e006aa4e34c", "resolution": "Won't Do", "resolutionDate": "2018-01-25T14:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should be able to document a single, specific module", "timeSpent": "PT0S", "updated": "2018-01-25T14:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Thanks for the report. We are aware of a number of problems with the current version of Puppet Strings and we are in the process of fixing up a lot of those issues.\nNot sure if this is one of the known issues - we will look into this.\n\n", "created": "2016-09-02T16:51:00.000000" } ], "components": [], "created": "2016-09-02T11:38:00.000000", "creator": "623a480b9b54ec0068b0724e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7c04e0a3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt3b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Sep/16" } ], "description": "When there's an error raised during processing, I expect the exit code is not 0.\n\nSample output from rake strings:generate (same happens with puppet strings):\n\n{code}\nsnafu109@foswiki:~/puppet-nginx$ bundle exec rake strings:generate\n[error]: Exception occurred while generating 'nginx/resource/vhost.html'\n[error]: ParseErrorWithIssue: Syntax error at end of file\n[error]: Stack trace:\n\t/var/lib/gems/2.3.0/gems/puppet-4.6.2/lib/puppet/pops/parser/parser_support.rb:127:in `on_error'\n\t/var/lib/gems/2.3.0/gems/puppet-4.6.2/lib/puppet/pops/parser/lexer2.rb:717:in `scan'\n\t/usr/lib/ruby/vendor_ruby/racc/parser.rb:331:in `_racc_yyparse_c'\n\t/usr/lib/ruby/vendor_ruby/racc/parser.rb:331:in `yyparse'\n\t/var/lib/gems/2.3.0/gems/puppet-4.6.2/lib/puppet/pops/parser/parser_support.rb:240:in `_parse'\n\t/var/lib/gems/2.3.0/gems/puppet-4.6.2/lib/puppet/pops/parser/parser_support.rb:134:in `parse_string'\n\nFiles: 17\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 9 ( 3 undocumented)\nPuppet Defined Types: 8 ( 3 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 64.71% documented\nsnafu109@foswiki:~/puppet-nginx$ echo $?\n0\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32539", "fixedVersions": [], "id": "32539", "issueType": "Bug", "key": "PDOC-89", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a480b9b54ec0068b0724e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should exit 1 when an error occurs", "timeSpent": "PT0S", "updated": "2019-08-06T17:49:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Todo: investigate what we have setup for strings in CI right now. We'd like to run the latest version of strings against a small fixture suite (acceptance). A 'don't break strings' acceptance test in puppet may be the way to do this.", "created": "2016-09-12T17:27:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We may need a test matrix of puppet versions as well.", "created": "2016-09-13T07:23:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "I did a sweep of the project with [SimpleCov|https://github.com/colszowka/simplecov] and found that spec coverage is actually very good. Most files are fully covered, except a few which I just put a PR up for: https://github.com/puppetlabs/puppet-strings/pull/105\n\nI think the remaining uncovered bits are best covered by acceptance-level tests. We actually do already have a matrix of puppet and ruby versions, but I'm not sure what the test actually entails. Looking into that now.", "created": "2016-09-29T15:49:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:62450221ad6b7e006aa4e34c] good news. Also to consider are the puppet versions it supports and new language features/regressions. ", "created": "2016-09-29T16:56:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] indeed, and there is actually already an acceptance test that parses simple fixtures that we can use to hold samples of new language features. They'll just have to be gated on puppet version.", "created": "2016-09-29T17:01:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Notes from sync with EricT:\n\nThe level of spec tests and HTML acceptance present with the PR linked above is sufficient. The higher priority is adding acceptance-level tests for JSON output, as this is what will be consumed by the forge. See PDOC-106.\n", "created": "2016-09-30T12:33:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at: 7c475a5", "created": "2016-10-03T05:53:00.000000" } ], "components": [], "created": "2016-07-07T09:51:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7e1286d3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7eov:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_30711610_*|*_1_*:*_1_*:*_5816152020_*|*_10007_*:*_1_*:*_235568972_*|*_3_*:*_1_*:*_74203216_*|*_5_*:*_1_*:*_600884715_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1462974762" } ], "description": "If the docs team is going to rely on strings, we need to make sure that new releases of puppet do not break it in such a way that it becomes unusable. That means that new releases of puppet cannot cause strings to have any of the following issues:\n\n# Fail to finish running\n# Emit corrupted JSON or other bad things\n# Any of the requirements defined by the PDOC-59 epic are no longer met (e.g. failing to pick up function definitions, etc)\n\nTesting for strings is incredibly minimal right now. At the very least, we need to improve unit tests and add unit tests for JSON output. We probably also need to add some actual acceptance testing. \n\nIt may be that better testing is all that's needed here, but before the docs team can integrate strings we have to be able to assure that it's maintained properly along with new releases of puppet.\n", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32398", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32398", "issueType": "Task", "key": "PDOC-88", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-10-03T14:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create a test plan for ensuring strings support going forward", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Because we have not been using Strings to generate the documentation for functions in puppet we ended up using a pattern where the documentation for 4.x functions are kept in 3.x stubs. In order to reduce the burden of maintaining two copies of the documentation many of the 4.x functions simply have \"documentation maintained in 3.x stub\" as their documentation. In order to really fix this, all of the 3.x stubs needs to be copied over to the 4.x (actual) implementation of the function. When doing so, the text needs to be edited from the \"free form, I hope this works\" to yard/markdown. Some 4.x functions are documented in both the 3.x stub as well as in the 4.x implementation. For those there is no guarantee that the two copies have not drifted apart. A manual review must be done because the formats are different (side by side viewing in an editor kind of works).\n\nWhen this is done, the 3.x stubs can be deleted. Which I guess is what PDOC-85 is about (also avoiding getting the same documentation twice, or the placeholder \"documentation maintained in 3.x stub\" instead of the documentation).", "created": "2016-09-13T07:29:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Not sure whose job this actually would be. It looks like all the documentation has been migrated to puppet 4 functions but at least some of it may not be written in a way YARD will understand. We probably want to get to a place where Strings is at least being used in modules first to prove it as a viable tool.", "created": "2018-04-12T03:14:00.000000" } ], "components": [], "created": "2016-07-07T09:31:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ad74a85" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymton:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Sep/16" } ], "description": "We should do a quick pass to make sure that all our function documentation is written in a format that strings can support. Basically this means two things:\n\n# Is it all valid Markdown that the parser used by YARD can handle\n# Are the YARD tags used supported by strings\n\nHopefully this shouldn't be a big effort, just a few minor corrections if anything.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32538", "fixedVersions": [], "id": "32538", "issueType": "Task", "key": "PDOC-87", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ensure our internal functions, types, and providers are documented in a way that's compatible with strings", "timeSpent": "PT0S", "updated": "2019-05-01T15:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "I'd just like to ask if this is a good idea.\n\nThe main reason is that approx 2 years ago, Strings was going to be the new hotness so we all started converting our code to something that was YARD/Strings compatible.\n\nNow, we're going *back* to Markdown (which is abysmal by the way).\n\nThe @param and @example functionality of YARD is *good* and I don't replacing this with Markdown in a way that is not going to be more trouble than it is worth.", "created": "2016-08-01T17:31:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We are absolutely keeping the meta tags from yard (was never under discussion). The \"using markdown\" means that the *text* is in markdown format as opposed to the Ruby Doc text format, (or the sorry mangled/hacked version of that used by the old documentation system in puppet). There is a reasonably large overlap between RubyDoc format, and Markdown for the most commonly used markup, but there are subtle differences. (Enough differences that people are driven crazy as markup is by far the dominating markup syntax for text in use).\n\n[~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9] - does that make it better?", "created": "2016-08-02T15:43:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Thanks for the update. Yes, this helps assuage my fears.", "created": "2016-08-02T16:00:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This is marked \"ready for merge\", but there is no link to a PR, and there seems to be no PR for this ticket in the repository ?!?\n\nIs this because it is part of the big rewrite PR ?", "created": "2016-09-13T04:38:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] ah yeah - this happened as part of the rewrite.", "created": "2016-09-18T22:32:00.000000" } ], "components": [], "created": "2016-07-07T08:43:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8ca6b34" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-59" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7en3:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Aug/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_213032551_*|*_1_*:*_1_*:*_5388145476_*|*_10007_*:*_1_*:*_323822390_*|*_3_*:*_1_*:*_431985839_*|*_5_*:*_1_*:*_1867625001_*|*_6_*:*_1_*:*_0" } ], "description": "Right now, without a .yardopts file dropped in the root directory of what you're documenting, strings will default to parsing comments with rdoc. This is not the desired behavior, as we now document our functions with Markdown and are encouraging this as the new standard. We need to modify strings to default to Markdown, preferably in a way that it is still configurable by the user to use rdoc instead.", "epicLinkSummary": "Improve behavior of Strings to support integration into Docs workflow ", "estimate": "PT0S", "externalId": "32598", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32598", "issueType": "Improvement", "key": "PDOC-86", "labels": [], "originalEstimate": "PT0S", "parent": "32534", "parentSummary": "Improve behavior of Strings to support integration into Docs workflow ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-09-18T22:32:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Make Markdown the default format", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623c08e1562ab90069f8aed4", "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Todo: talk to docs", "created": "2016-09-12T17:14:00.000000" }, { "author": "557058:db3c8c5c-5825-4424-a788-64c2fa922e24", "body": "[~accountid:623c08e1562ab90069f8aed4] believes this unnecessary and we'll fix it in the templates", "created": "2016-09-21T12:38:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:db3c8c5c-5825-4424-a788-64c2fa922e24] [~accountid:623c08e1562ab90069f8aed4] How exactly? We have three cases:\n\n* documented in both 3.x stub and 4.x\n* documented in 3.x, and 4.x contains a reference to see the 3.x stub - that reference looks just like documentation\n* documented in 4.x only (although we no longer have any in this category)\n\nI can imagine that if there is a 3.x function with the same name, then that wins - is that what we will do in the templates?", "created": "2016-09-22T06:35:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "My working assumption is that we have no items in the second category. (This might not be true, but we can make it true with a puppet PR as soon as I have a working function reference generator.) \n\nThe plan is to prefer v4 functions, to pave the way to remove v3 functions. Given JSON that includes both versions of a given function, this is simple to do in the template, and requires no add'l work in Strings itself. If I see two versions of a given function and only one of them is v4, I'll ignore the other. ", "created": "2016-10-06T19:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The right thing to do is:\n\n* move all 3.x stubs' documentation to 4.x and add/fix the markup to yard\n* remove the 3.x stubs\n\nUntil that is done however (say, when making the function reference generator work) the sane thing to do is to use the 3.x variant if one exists.\n\n", "created": "2016-10-07T05:11:00.000000" } ], "components": [], "created": "2016-07-06T09:25:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@f7d6c4b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-59" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7dr3:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5903402718_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_761023519" } ], "description": "Because we didn't want to maintain documentation in two places, many of the core Puppet functions are implemented in the 4x style but have a matching 3x stub with contains all the documentation. We need to ensure that strings can handle this in a way that makes sense, combining the relevant information from both, taking only the doc string from the 3x version, or something similar.\n\nh4. Example:\n\nh5. The 4.x implementation of {{contain}} in {{lib/puppet/functions/contain.rb}}:\n{code}\n# Called within a class definition, establishes a containment\n# relationship with another class\n# For documentation, see the 3.x stub\n#\nPuppet::Functions.create_function(:contain, Puppet::Functions::InternalFunction) do\n...\n{code}\n\nh5. The 3.x stub of {{contain}} in {{lib/puppet/parser/functions/contain.rb}}:\n\n{code}\n# Called within a class definition, establishes a containment\n# relationship with another class\n\nPuppet::Parser::Functions::newfunction(\n :contain,\n :arity => -2,\n :doc => \"Contain one or more classes inside the current class. If any of\n...\n) do |classes|\n # Call the 4.x version of this function in case 3.x ruby code uses this function\n Puppet.warn_once(:deprecation, '3xfunction#contain', \"Calling function_contain via the Scope class is deprecated. Use Scope#call_function instead\")\n call_function('contain', classes)\nend\n{code}", "epicLinkSummary": "Improve behavior of Strings to support integration into Docs workflow ", "estimate": "PT0S", "externalId": "32561", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32561", "issueType": "Improvement", "key": "PDOC-85", "labels": [], "originalEstimate": "PT0S", "parent": "32534", "parentSummary": "Improve behavior of Strings to support integration into Docs workflow ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Won't Fix", "resolutionDate": "2016-09-21T12:38:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Handle the case of 4x functions and 3x stubs", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:613151bd-b161-4bc3-9e32-335fdcef4d89", "body": "I believe this is currently possible if you add \\-n (--no-output) to the .yardopts file. But it would be nice to be able to do it without the need for the yardopts file.\n\nWe would like to use Puppet Strings to generate documentation for Forge modules automatically. It would be significantly less painful if we could generate the JSON using a configuration to puppet-strings rather than having to ensure every module has a .yardopts file with the \\-n flag.", "created": "2016-07-07T11:25:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "After Peter's rewrite this is now possible with the {{emit-json}} and {{emit-json-stdout}} options. Last thing to do is clear the new JSON schema (https://github.com/puppetlabs/puppet-strings/blob/master/JSON.md) with docs.\n\nEdit: actually, PDOC-83 tracks the schema itself. This ticket is intended to just track the JSON output option, which now works. Resolving.", "created": "2016-09-18T22:34:00.000000" } ], "components": [], "created": "2016-07-05T12:36:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@414bb90b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-59" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7d2v:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Jul/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_213021877_*|*_1_*:*_1_*:*_5978501816_*|*_10007_*:*_1_*:*_324233606_*|*_10009_*:*_1_*:*_265625_*|*_5_*:*_1_*:*_1867353327_*|*_6_*:*_1_*:*_0" } ], "description": "Whether it's a rake task, a subcommand, or both we need to add a way to generate only the single JSON file and not the entire doc directory of HTML pages. I'm not sure if it's possible to also prevent yard from producing the additional output like the .yardoc directory, but either way we need to clearly define what will be generated and where so that it can be automatically scrapped as appropriate.", "epicLinkSummary": "Improve behavior of Strings to support integration into Docs workflow ", "estimate": "PT0S", "externalId": "32597", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32597", "issueType": "Improvement", "key": "PDOC-84", "labels": [], "originalEstimate": "PT0S", "parent": "32534", "parentSummary": "Improve behavior of Strings to support integration into Docs workflow ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-09-18T22:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add the ability to generate only JSON", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Todo: confirm Peter's schema works for docs. Will follow up with Nick F this week.", "created": "2016-09-12T17:23:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "[~accountid:62450221ad6b7e006aa4e34c] [~accountid:623c08e1562ab90069f8aed4] is this done? what needs to happen to resolve?", "created": "2016-10-05T13:13:00.000000" } ], "components": [], "created": "2016-07-05T10:33:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b466a39" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymthb:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5986289721_*|*_10009_*:*_1_*:*_1438090637_*|*_5_*:*_1_*:*_429240034_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_537190086" } ], "description": "In order to ensure that strings produces JSON in a way that's consistent and workable. The language and docs teams should work together to define a schema that makes sense and will suit the needs of the docs team.\n\nAs part of this work, we need to ensure that the JSON output generated does not contain any significant errors or glitches and that things are reliably in the right place so it can be used by the docs team.", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32385", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32385", "issueType": "Improvement", "key": "PDOC-83", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-10-05T14:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Define a proper JSON schema for strings", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Todo: make sure runtime dependencies are managed in the gemspec rather than the Gemfile and test this.", "created": "2016-09-12T17:23:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Just worked with Nick on this. His workflow is as follows:\n\nBundle install puppet-strings in the puppet-doc repo (it is in the Gemfile). This repo holds a version of the puppet source in its vendor directory. Then, point strings at that source with {{bundle exec puppet-strings generate ./vendor/puppet/lib/puppet/**/*.rb}} (for functions)\n\nWe determined that this works correctly for Puppet 4.7.0. When running strings against 4.2.2, strings errored out with no explanation. Though we should probably look into that, it doesn't affect the docs workflow as they will not be regenerating docs for older versions of puppet.", "created": "2016-10-07T13:02:00.000000" } ], "components": [], "created": "2016-07-05T08:45:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56a38331" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7cun:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_215069_*|*_1_*:*_1_*:*_5992586888_*|*_10007_*:*_1_*:*_323964876_*|*_5_*:*_1_*:*_254218233_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1826271528" } ], "description": "Because the docs team would like to use strings in their automated doc extraction scripts, we need to ensure that the gem can be used and managed with bundler in that context. It needs to work out of the box and can\u2019t contaminate the user\u2019s environment outside of bundler. There's not really any reason to believe that this won't work, but since it's essential we should verify it.\n\nThe scripts in question live [here|https://github.com/puppetlabs/puppet-docs/tree/master/lib/puppet_references]\n", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32596", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32596", "issueType": "Improvement", "key": "PDOC-82", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-10-07T14:42:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Ensure the strings gem can be managed via bundler in docs scripts", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Good news, this has been fixed! :D\n\n{code}\n# @param first The first parameter for this class...\n\noutput:\n...\n {\n \"tag_name\": \"param\",\n \"text\": \"The first parameter for this class\",\n \"types\": [\n \"String\"\n ],\n \"name\": \"first\"\n },\n...\n{code}", "created": "2016-11-03T13:39:00.000000" } ], "components": [], "created": "2016-06-27T18:28:00.000000", "creator": "557058:30b5c31c-aff1-4b34-8c3e-742c2327385d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a0cbd87" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz787z:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_34417267_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_11093855136" } ], "description": "When generating the JSON format, it should include the @param help text\n\nFrom the example README on Classes / Defined Types:\n{code}\n# @param first_arg The first parameter for this class\n{code}\n\nThe \"The first parameter for this class\" text should be in the JSON format output.\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32432", "fixedVersions": [], "id": "32432", "issueType": "Improvement", "key": "PDOC-81", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:30b5c31c-aff1-4b34-8c3e-742c2327385d", "resolution": "Fixed", "resolutionDate": "2016-11-03T13:40:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@param tag help text should be in JSON", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "It is probably a transient dependency as I believe that puppet-strings dependency is on puppet. ", "created": "2016-06-22T06:54:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Maybe this can be worked around by using the puppet-agent vendored \"gem\" command to install puppet-strings? Then it should see the existing puppet/facter gems and consider that dependency satisfied already.", "created": "2016-09-21T17:55:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Can we solve this with documentation how to install for PE 3.8 or are the \"out of the box\" work around consequences still so bad that we should avoid doing this, and instead make strings state it is for later PE versions only?", "created": "2016-09-27T14:45:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "I'm hoping we can document an out of the box workaround, but I haven't been able to get strings to function without overwriting PE binaries in {{/usr/local/bin}}.\n\nWhen doing:\n{noformat}\npuppet apply -e \"package {'puppet-strings': provider => gem, install_options => ['--ignore-dependencies']}\"\n{noformat}\n\nthe strings gem is installed without conflicts, but PE puppet can't find the face: {{Error: Unknown Puppet subcommand 'strings'}}. I'm not sure how to work around this.", "created": "2016-09-27T15:39:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Probably does not work because it needs to do what the puppet_gem provider does? Could a user do that manually?", "created": "2016-09-27T16:19:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "{{puppet_gem}} just uses the {{gem}} we ship with puppet agent, in {{/opt/puppetlabs/puppet/bin/gem}} (It uses our vendored ruby) - so we can't replicate that. Installing the strings gem into the PE gemdir {{/opt/puppet/lib/ruby/gems/1.9.1/gems/gems}} results in: \n\n{code}\nroot@cah6tsusw5gkv8b puppet-enterprise-3.8.6-21-g998fda5-el-7-x86_64]# puppet strings\n/opt/puppet/lib/ruby/1.9.1/rubygems/dependency.rb:247:in `to_specs': Unable to find application 'strings'. Could not find puppet (>= 3.7.0) amongst \n{code}", "created": "2016-09-27T16:44:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "We ended up deciding that we can just remove the runtime dependency on puppet, as the gem is not capable of determining when puppet / facter is installed by a means other than the rubygem. Instead, we're going to add a {{requirement}} to the gemspec which will show up on rubygems.org. With this change, the work around for PE 3.8 isn't too bad, and just involves installing the gems into the PE GEM_HOME.\n\nPR: https://github.com/puppetlabs/puppet-strings/pull/103", "created": "2016-09-28T12:48:00.000000" } ], "components": [ "CLI" ], "created": "2016-06-20T17:11:00.000000", "creator": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:4e77c969-1230-455c-9a24-a8b5a750f156", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@31c4f340" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz73av:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jun/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_11717367_*|*_1_*:*_1_*:*_135839260_*|*_10007_*:*_1_*:*_717184_*|*_5_*:*_1_*:*_1026368887_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_88073108_*|*_10005_*:*_1_*:*_8400195597" } ], "description": "> sudo puppet resource package puppet-strings provider=gem\nError: Execution of '/usr/bin/gem install --no-rdoc --no-ri puppet-strings' returned 1: ERROR: Error installing puppet-strings:\n \"facter\" from facter conflicts with /usr/local/bin/facter\nError: /Package[puppet-strings]/ensure: change from absent to present failed: Execution of '/usr/bin/gem install --no-rdoc --no-ri puppet-strings' returned 1: ERROR: Error installing puppet-strings:\n \"facter\" from facter conflicts with /usr/local/bin/facter\npackage { 'puppet-strings':\n ensure => 'absent',\n}\n> sudo gem install puppet-strings\nfacter's executable \"facter\" conflicts with /usr/local/bin/facter\nOverwrite the executable? [yN] n\nERROR: Error installing puppet-strings:\n \"facter\" from facter conflicts with /usr/local/bin/facter\n\nThis appears to be a problem -- we have change controls, so if this gem upgrades our Facter version, we have to do a lot of paperwork and plan in the FSC. Is this really necessary?", "environment": "RHEL 7.0, PE 3.8.3", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32384", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32384", "issueType": "Bug", "key": "PDOC-80", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:4e77c969-1230-455c-9a24-a8b5a750f156", "resolution": "Fixed", "resolutionDate": "2016-09-28T16:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Installation overwrites facter in PE 3.8.3", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623cffe88d8b9c0068b93ebf", "created": "2016-06-20T14:29:00.000000", "name": "Screen Shot 2016-06-20 at 1.23.06 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12386" }, { "attacher": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "created": "2016-06-01T14:20:00.000000", "name": "Screenshot 2016-06-01 13.19.31.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12374" }, { "attacher": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "created": "2016-06-01T14:20:00.000000", "name": "puppet-strings-functions-4.5.0.tar.gz", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12370" } ], "comments": [ { "author": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "body": "I ran strings against the {{lib/puppet/functions/}} directory and got a spray of errors.\n\nIt did produce docs but they are garbled and not many strings are rendered, see attached screenshot.\n\nI've included a tar.gz of the generated directory in case that helps anyone.", "created": "2016-06-01T14:20:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "So for what it's worth the screenshot provided isn't quite an accurate representation of what the strings output will look like for our functions. I ran strings only against the \"new\" function (specifically the 3.x stub in `lib/puppet/parser/functions` since it contains the actual documentation string) where I set the \"--markup markdown\" option in the .yardopts file and it looks much better (see attached screenshot).\n\nThe issue here is that YARD by default will assume it's parsing rdoc (which is why the previous screenshot looks so unreadable), when we want it to parse our comments and Markdown. This is usually dealt with by adding a .yardopts file in the root of the module directory which specifies the Markdown option. I'm not quite sure how we want to deal with this in regards to running against core puppet since we don't want to be dropping .yardopts files everywhere. We will probably have to figure out another way to pass this setting to YARD. This can't be done via the command line because since strings is a face, all arguments are parsed as puppet arguments.", "created": "2016-06-20T14:29:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I seriously doubt that any of the entities being documented by puppet-strings will encounter deliberate rdoc markup that is not also working with markdown. Can we enforce markdown in puppet-string? Ideally allowing it to be modified by a user that opts in to having .yardopts in their module.", "created": "2016-06-22T07:13:00.000000" } ], "components": [], "created": "2016-05-18T14:28:00.000000", "creator": "557058:f1e252bd-73da-4e0e-90f7-f0aefb98d28c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6beb02f8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz7sov:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Jun/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_164956_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_7257019081" } ], "description": "One possibility: concentrate on using strings to fill in existing gaps:\n* 4.x Functions are not processed (the pressing need since we otherwise have to maintain dummy copies in a different format)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32383", "fixedVersions": [], "id": "32383", "issueType": "Task", "key": "PDOC-79", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:f1e252bd-73da-4e0e-90f7-f0aefb98d28c", "resolution": "Fixed", "resolutionDate": "2016-08-10T14:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "[SPIKE] Define the set of tickets needed to get strings working for docs needs", "timeSpent": "PT0S", "updated": "2016-08-18T02:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-05-05T02:37:00.000000", "creator": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3f2eeade" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz6407:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_531358_*|*_10007_*:*_1_*:*_4016827227_*|*_5_*:*_1_*:*_9672397213_*|*_6_*:*_1_*:*_0" } ], "description": "The puppet-strings rubygem should contain the full LICENSE text to accompany the source code that's licensed this way, but currently only contains the source files under lib/ themselves.\n\nIt'd be useful to also include the README.md and other documentation, plus the specs as they can be used in OS packaging (e.g. Fedora).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32595", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32595", "issueType": "Improvement", "key": "PDOC-78", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "70121:d6aac370-4601-44fc-bc1f-2a379fd45fd4", "resolution": "Fixed", "resolutionDate": "2016-06-20T14:33:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Include LICENSE, documentation and tests in gem", "timeSpent": "PT0S", "updated": "2016-10-10T13:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "body": "https://github.com/puppetlabs/puppetlabs-strings/pull/86", "created": "2016-05-04T01:45:00.000000" }, { "author": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "body": "The pull request has been merged, maybe set this to ready so we can cook a new release", "created": "2016-07-04T00:03:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "It is in \"Ready for CI\" which is past \"Ready for Merge\". Someone needs to look at the acceptance test results to move it to the next state: \"Ready for Test\".", "created": "2016-07-05T03:40:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "I believe [~accountid:557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c]'s rewrite addresses this. Once we get that merged in I'll verify it works and we can close this out.", "created": "2016-09-14T14:55:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "With the new {{generate}} task, you should be able to do this:\n\n{code}\nrake strings:generate\\['site/**/*.pp modules/custom/**/*.{rb\\,pp}']\n{code}\n\nThat would filter to only parse Puppet source under {{site/}}, and Ruby and Puppet source under {{modules/custom/}}. No need to write a custom task or any Ruby code.", "created": "2016-09-14T15:07:00.000000" }, { "author": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "body": "I'm not convinced that this is the best approach. Although the extra options defined in https://github.com/puppetlabs/puppetlabs-strings/pull/98/files#diff-04c6e90faac2675aa89e2176d2eec7d8R228 might prove useful, I prefer setting these inside my Rakefile and having configuration settings for each makes it a lot more clear than depending on the order in which an option is provided.", "created": "2016-09-15T00:54:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "The {{strings:generate}} task is itself a simple wrapper of {{PuppetStrings.generate}} (https://github.com/peterhuene/puppet-strings/blob/678c04957d59b297085e2bc6a422801a174a94a7/lib/puppet-strings/tasks/generate.rb), so my recommendation would be to write one's own rake task that passes the desired arguments into {{PuppetStrings.generate}}.\n\nIf that is insufficient, we could add the proposed wrapper here, but I do feel that {{generate}} is already a simple enough API to wrap with one's own rake task if desired.", "created": "2016-09-15T11:25:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "We came to a consensus that Peter's suggestion above is the best way to proceed. The {{generate}} task should be flexible enough to allow any amount of customization via a custom rake task wrapper, if desired. Closing this ticket now, but if anyone has strong objections feel free to leave another comment.", "created": "2016-11-02T15:45:00.000000" } ], "components": [], "created": "2016-05-04T01:35:00.000000", "creator": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "That it is possible to generate a rake task for running strings that is based on user input.\n" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@47036c04" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-100" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8r9r:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "New Feature" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The task `strings:generate` which is provided by including `puppet-strings/rake_tasks` will scan the manifests and lib directory from your single module. If you need to document a complete, or part of a, puppet tree, you can use the `PuppetStrings::RakeTasks::Generate` task. This rake task will by default overwrite strings:generate unless you specify a custom name. See the example in the puppet strings readme and the rake task itself for more information." }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Jul/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_7953938673_*|*_1_*:*_1_*:*_3585954417_*|*_10007_*:*_1_*:*_1985776713_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2250165508" } ], "description": "We will be using puppet strings to document all our modules/classes that we have available in our puppet tree. Currently, this is impossible without hacking a custom rake task to do this.\n\nI would love to be able to do something like:\n\n{noformat}\nPuppetStrings::RakeTasks::Generate.new do |task|\n task.paths = ['site', 'modules/custom']\n task.excludes = ['/vendor/']\n task.options = {}\nend\n{noformat}", "epicLinkSummary": "Strings 1.0 release", "estimate": "PT0S", "externalId": "32579", "fixedVersions": [ "PDOC 1.0.0" ], "id": "32579", "issueType": "New Feature", "key": "PDOC-77", "labels": [], "originalEstimate": "PT0S", "parent": "32600", "parentSummary": "Strings 1.0 release", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "resolution": "Won't Fix", "resolutionDate": "2016-11-02T15:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create an easy way to modify the rake task to include/exclude certain files/folders.", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], I marked this as \"Ready for Review\" just because it's ready for you to look at. Made more sense than In Progress. Anyway, feel free to close when you're done I think.", "created": "2018-01-11T15:34:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Added to strings style guide draft", "created": "2018-01-11T17:45:00.000000" } ], "components": [], "created": "2016-04-14T15:18:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@684c54e2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-218" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyl88v:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jan/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_55041266908_*|*_10009_*:*_1_*:*_7930926_*|*_5_*:*_1_*:*_0" } ], "description": "You can use tags like {{@return}} and {{@example}} to document your classes, functions, types, etc., but as a user, I'm not sure exactly what's available or what I SHOULD be using. It'd be nice to have a list!\n\nFor example: I went looking to see whether there's a way to override the default value for a parameter in a native Ruby resource type (like in cases where the default isn't cleanly introspectable). I can't tell! (If there's not, that'll be another ticket. :) )\n\n*UPDATE*: this ticket already exists! A user recently found that not _all_ of the YARD tags can be used. This information should all go into the style guide.\n\n*This is a list of the built-in YARD tags that are also picked up by puppet-strings. This is NOT a list of all puppet-strings tags.*\nYARD reference: http://www.rubydoc.info/gems/yard/0.6.4/file/docs/Tags.md#List_of_Available_Tags\n\nh3. @example\nShow an example snippet of code for an object. The first line is an optional title. Use for specific examples of a given component. One example tag per example.\nh3. @param\ndefines a parameter for the given component. remember, if Puppet 4 types are present in the source, they will override whatever is in the docs.\nh3. @raise\ncan be used to document any exceptions that may be raised by the given component\n{{# @raise PuppetError this error will be raised if x}}\nh3. @author\nAuthor of the component\nh3. @see\nused to document additional references. comes out in the generated docs as a \"See Also\" section. one tag per reference (website, other method, etc)\nh3. @since\nused to document how long the component has been available.\n{{# @since version 1.1.1}}\nh3. @version\nanother way to talk about which version the component is in or how long it's been available.\nh3. @option\n* only displays if there's actually an options hash being passed to the method\n* should be used in conjunction with a @param tag\ne.g.\n{code}\n# @param [Hash] opts \n# List of options\n# @option opts [String] :option1 \n# option 1 in the hash\n# @option opts [Array] :option2\n# option 2 in the hash\n{code}\n", "epicLinkSummary": "Puppet Strings 1.2.0", "estimate": "PT0S", "externalId": "32367", "fixedVersions": [], "id": "32367", "issueType": "Improvement", "key": "PDOC-76", "labels": [], "originalEstimate": "PT0S", "parent": "32468", "parentSummary": "Puppet Strings 1.2.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2018-01-11T17:45:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Document the available YARD @tags for ruby/pp doc objects", "timeSpent": "PT0S", "updated": "2018-02-27T14:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master: a3227b8", "created": "2016-03-24T17:32:00.000000" } ], "components": [], "created": "2016-03-24T15:08:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6326ea00" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz5b7z:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Mar/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_538373103_*|*_1_*:*_1_*:*_2674624_*|*_10007_*:*_1_*:*_6026458_*|*_6_*:*_1_*:*_0" } ], "description": "Puppet strings uses an API private method in puppet which has been updated to take two parameters instead of one. This means strings is calling it with the wrong number of variables in the host class handler which is causing it to crash:\n\nhttps://github.com/puppetlabs/puppetlabs-strings/blob/master/lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb#L19\n\nThis ticket is for fixing the issue in strings. For details around the fact that strings is using API private puppet methods, see PUP-6088", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32366", "fixedVersions": [ "PDOC 0.4.0" ], "id": "32366", "issueType": "Bug", "key": "PDOC-75", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-03-30T23:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings calls 'interpret_any' with the wrong number of arguments", "timeSpent": "PT0S", "updated": "2016-03-30T23:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2016-03-11T16:15:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3fa8f90e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz519b:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_476124785_*|*_1_*:*_1_*:*_428676168_*|*_10007_*:*_1_*:*_757935207_*|*_10009_*:*_1_*:*_9943_*|*_6_*:*_1_*:*_0" } ], "description": "Since there's pretty much unanimous agreement that strings is a tool better delivered via gem rather than a puppet module, the 0.4.0 will be the first and final release to feature both a gem and a module. The module will need to be updated to explain that it is deprecated and all further updates will come via the gem. \n\nThat means we need to make a few changes for the module release to communicate that it's being deprecated:\n\n# Update the README to explain that the module is deprecated\n# Add a guide for gem installation in the README \n# Go through the Puppet Labs gem checklist\n# Update metadata and gemspec\n# Add CHANGELOG", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32431", "fixedVersions": [ "PDOC 0.4.0" ], "id": "32431", "issueType": "Task", "key": "PDOC-74", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-03-30T23:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Deprecate strings module in favor of gem", "timeSpent": "PT0S", "updated": "2016-03-30T23:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Edit: nevermind, we still need to do this post-Peter's rewrite. Some words from Peter:\n\nThat shouldn't be difficult at all", "created": "2016-09-14T15:03:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "Wishlist: Make it so that used type aliases (e.g. as a class param's type) are linked to the aliases' documentation.", "created": "2016-10-09T14:14:00.000000" } ], "components": [], "created": "2016-03-10T13:24:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7fc27e75" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt33:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Sep/16" } ], "description": "In PUP-5903 the ability to define local type aliases inside a 4.x function was added. These types may need to be processed when producing documentation.\n\nIt may also be just perfectly fine to display only the aliases, but users may want to see the type definitions.\n\nThe first step is to ensure that the addition of type aliases does not trip up the extraction process. Second step is to possibly add a section that shows the type aliases.\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32364", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32364", "issueType": "Bug", "key": "PDOC-73", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "handle type aliases in 4.x ruby functions (introduced in PUP-5903)", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "I'm not sure when it was fixed, but this does not appear to be occurring any longer.", "created": "2016-03-14T18:18:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We had issues with \"puppet_x\" in its many shapes IIRC, (PuppetX, puppet_x, puppetx, etc) and at one point there were errors in that handling. There has also been problems with running on puppet server and finding things in the \"PuppetX\" name space.\n\nWas this perhaps solved by using a gem as opposed to a module?", "created": "2016-03-15T10:30:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "No, it was blowing up in both cases previously. I'm not exactly sure what changed as I tried using a clean environment but it no longer seems to fail.", "created": "2016-03-15T12:54:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "It sounds like this isn't a problem anymore, so I'm closing this out. Feel free to reopen this ticket if the issue resurfaces!", "created": "2016-09-28T16:33:00.000000" } ], "components": [ "DOCS" ], "created": "2016-02-24T04:10:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@45f3a6cd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz8r9j:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Mar/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18789792663_*|*_6_*:*_1_*:*_0" } ], "description": "When running _*PuppetX::PuppetLabs::Strings::Util.generate*_ the following exception is raised:\n\n{noformat}\nLoadError: cannot load such file -- puppet_x/puppetlabs/strings/yard/tags/directives\n{noformat}\n\nThis does not occur with Puppet 3.8.5.\n", "environment": "* Ruby 2.1.8\n* Puppet-Strings 0.3.1\n* YARD 0.8.7.6\n* Puppet 4.3.2", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32518", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32518", "issueType": "Bug", "key": "PDOC-72", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Cannot Reproduce", "resolutionDate": "2016-09-28T16:33:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet 4.3.2 cannot find strings/yard/tags/directives with Strings 0.3.1", "timeSpent": "PT0S", "updated": "2016-10-06T14:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "I saw some noise around the Gem so thought that I'd give it another shot.\n\nThis issue is still occurring in Puppet 3.8 and 4.3.", "created": "2016-03-14T18:19:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Thanks for trying it out [~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9], it is not a new version though, so same problems would still be there. We are aware puppet strings needs some TLC...", "created": "2016-03-15T09:31:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Noting for myself and others: to reproduce this bug using the steps described in the ticket on a CentOS 7 virtual machine, makes sure you install rpm-build and rpm-devel.", "created": "2016-06-28T15:16:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "So unfortunately I had to time box my work on the issue and after some poking around in the debugger I still haven't been able to get to the root of it. I figured I'd leave some notes on where I was planning on going next for my future self or whoever picks up this ticket. I think this is going to be kind of a hairy issue to track down judging by the fact that it only happens at a particular scale and that this file evaluated on its own is fine. \n\nI think, as the ticket description suggests, that it's a fair assumption something is being corrupted somewhere. That being said, comparing our code object in the good case and the code object in the bad case may be the key to tracking things down. Since the exception is occurring in the HostClassHandler the object in question is [this one|https://github.com/puppetlabs/puppetlabs-strings/blob/master/lib/puppet_x/puppetlabs/strings/yard/handlers/host_class_handler.rb#L32]. I think either inspecting this object with the debugger or printing it in both scenarios (a. running it in the batch when it fails and b. running it on it's own when it passes) and seeing what is different should point to where the corruption is potentially happening.", "created": "2016-06-30T11:05:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "A work around for this problem has been merged to master at: 138dc25\nIt catches the spurious errors and keeps the process going after having logged that the issue occurred. This is no replacement for real fixes, but allows as much documentation as can be generated to be produced.", "created": "2016-07-18T05:16:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9] we're going to be releasing strings 0.99.0 (a complete rewrite) on Monday, and we're pretty confident that this won't be an issue in the new code. Definitely let us know if it pops up again, though.", "created": "2016-10-07T14:38:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:62450221ad6b7e006aa4e34c] Awesome! It's really great to hear that there has been some love here. Looking forward to trying the new version.", "created": "2016-10-07T15:03:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9] oh yes, definitely! We've got a new team with strings as a central part of its charter now. We have big plans! :) Please do try it out and let us know if/when you find any issues - we'll be doing the big 1.0.0 soon, after fixing anything found in this one.", "created": "2016-10-07T15:07:00.000000" } ], "components": [ "DOCS" ], "created": "2016-02-24T04:04:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@783bc47f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz4pb3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Mar/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_19560801509_*|*_10009_*:*_1_*:*_4315_*|*_5_*:*_1_*:*_254530552_*|*_6_*:*_1_*:*_0" } ], "description": "Running 'puppet strings' or using the Gem on a large body of modules results in spurious errors and eventually a Stack Level Too Deep exception.\n\nThe following can be used to reproduce the error:\n\n{code:bash}\n#!/bin/sh\ngit clone https://github.com/simp/simp-core puppetdoc_test\ncd puppetdoc_test\ngit checkout 5.1.X\nbundle\nrake deps:checkout\ncd src/doc\ngit remote add doctest https://github.com/trevor-vaughan/simp-doc\ngit fetch --all\ngit checkout autodoc\nbundle\nrake docs:auto\n{code}\n\nRunning `puppet strings` on files that the large run claim are failing indicate no failures and provides correct output. This hints at some level of in memory object corruption but I have been unable to pinpoint the source.\n\nExample of failing output:\n\n{noformat}\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler:\n[error]: in `../../src/puppet/modules/mysql/manifests/server/service.pp`:2:\n\nclass mysql::server::service {\n\n if $mysql::server::real_service_enabled {\n $service_ensure = 'running'\n } else {\n $service_ensure = 'stopped'\n }\n\n if $mysql::server::real_service_manage {\n file { $mysql::params::log_error:\n owner => 'mysql',\n group => 'mysql',\n }\n service { 'mysqld':\n ensure => $service_ensure,\n name => $mysql::server::service_name,\n enable => $mysql::server::real_service_enabled,\n provider => $mysql::server::service_provider,\n }\n }\n\n}\n\n[error]: ParseErrorWithIssue: Syntax error at '{' at line 14:16\n[error]: Stack trace:\n /home/trevor-vaughan/.rvm/gems/ruby-2.1.8/gems/puppet-3.8.5/lib/puppet/pops/parser/parser_support.rb:122:in `on_error'\n /home/trevor-vaughan/.rvm/gems/ruby-2.1.8/gems/puppet-3.8.5/lib/puppet/pops/parser/lexer2.rb:291:in `scan'\n /home/trevor-vaughan/.rvm/rubies/ruby-2.1.8/lib/ruby/2.1.0/racc/parser.rb:319:in `_racc_yyparse_c'\n /home/trevor-vaughan/.rvm/rubies/ruby-2.1.8/lib/ruby/2.1.0/racc/parser.rb:319:in `yyparse'\n /home/trevor-vaughan/.rvm/gems/ruby-2.1.8/gems/puppet-3.8.5/lib/puppet/pops/parser/parser_support.rb:230:in `_parse'\n /home/trevor-vaughan/.rvm/gems/ruby-2.1.8/gems/puppet-3.8.5/lib/puppet/pops/parser/parser_support.rb:129:in `parse_string'\n\n\u230f Parsing ../../src/puppet/modules/postgresql/lib/puppet/parser/functions/postgresql_acls_to_resources_has\u230e Parsing ../../src/puppet/modules/puppetdb/lib/puppet/parser/functions/puppetdb_create_subsetting_resourcrake aborted!\nSystemStackError: stack level too deep\n{noformat}", "environment": "* A large body of modules.\n* Ruby 1.9.3-p551 and Ruby 2.1.8\n* Puppet 3.8.5\n* Puppet Strings 0.3.1\n* YARD 0.8.7.6", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32560", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32560", "issueType": "Bug", "key": "PDOC-71", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Fixed", "resolutionDate": "2016-10-07T14:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Stack Level Too Deep Exception and Spurious Errors", "timeSpent": "PT0S", "updated": "2016-10-10T13:19:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Whew, sorry it took so long but I finally got to test this! It works exactly as planned, and it seems to be like a sane default, especially since rake tasks aren't exactly the \"default\" way to use strings. Plus we haven't done a release with them yet (so this shouldn't break existing behavior for anyone).\n\nWondering though if we want to document the fact that it will create a json file in the root directory, maybe in the [section of the README about rake tasks|https://github.com/puppetlabs/puppetlabs-strings/blob/master/README.md#rake-tasks]? \n\nThoughts [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] [~accountid:557058:b62c47a4-37e4-460d-8791-518bdfebf3e8]?", "created": "2016-03-15T16:54:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The fact it generates json should be documented, what / where it writes data, and if there are options that control that. Seems worth mentioning under the rake section as that is where you would go to understand how to run things. The fact that it outputs Json (always or optionally) deserves a paragraph or so of text to explain what it is intended for and maybe a reference to a schema etc.", "created": "2016-03-15T17:19:00.000000" } ], "components": [], "created": "2016-02-21T10:12:00.000000", "creator": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@952bfbd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz4nef:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Mar/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_476056154_*|*_1_*:*_1_*:*_8501199_*|*_10007_*:*_1_*:*_2841514006_*|*_6_*:*_1_*:*_0" } ], "description": "At the moment it's not possible to generate the JSON output using the rake tasks, without knowing the internals and writing your own rake task.\n\nGiven how useful that output can be, I think it's a reasonable default to always generate it. I've opened https://github.com/puppetlabs/puppetlabs-strings/pull/72/files with that change.\n\nMy rationale for that is by always generating it more people will find out about it, and potentially use it to do awesome. A user that really doesn't want that can always add it to .gitignore or similar, or write there own rake task.\n\nThis could be made configurable later, or split into separate tasks. I'm less bothered about the implementation and more interested in the default. Outputting by default could lead to more visibility/usage of the format, which can only be a good thing.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32464", "fixedVersions": [ "PDOC 0.4.0" ], "id": "32464", "issueType": "Improvement", "key": "PDOC-70", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "resolution": "Fixed", "resolutionDate": "2016-03-30T23:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Always generate JSON output for Rake task", "timeSpent": "PT0S", "updated": "2016-03-30T23:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "yep! PDOC-226", "created": "2018-03-05T12:11:00.000000" } ], "components": [], "created": "2016-02-06T06:56:00.000000", "creator": "557058:c7e2df03-377d-4bf0-9407-106b8483430d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1fbc1154" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz4b9z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_65510086239_*|*_6_*:*_1_*:*_0" } ], "description": "A new syntax for handling type definitions is added by the parser in PUP-5742 which means that a definition is created. This should be included in the documentation.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32516", "fixedVersions": [], "id": "32516", "issueType": "New Feature", "key": "PDOC-69", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c7e2df03-377d-4bf0-9407-106b8483430d", "resolution": "Duplicate", "resolutionDate": "2018-03-05T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Handle new definitions of Puppet Types.", "timeSpent": "PT0S", "updated": "2018-03-05T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Can you clarify what you mean by \"some options are not documented\" - do you mean {{@tags}} that are unsupported, or that there are things that should have been documented, but are missing? Also, what do you mean by \"documentation functions not being preset in the code\", what are those \"functions\"? and in which \"code\"?\n\nI sort of understand what you are asking for in general, but it would help you could be more specific - do you have some examples where you would expect to see the kinds of errors your thinking of?", "created": "2016-02-04T05:54:00.000000" }, { "author": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "body": "I have updated the description and added examples", "created": "2016-02-04T06:02:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Agree that it would be a nice option to have. I am afraid features like this have low priority atm so it may take a while.", "created": "2016-02-04T09:02:00.000000" } ], "components": [], "created": "2016-02-03T08:23:00.000000", "creator": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@62b44b8c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt2v:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Feb/16" } ], "description": "I thnk it would be useful if the rake jobs would get an option to fail is some parameters are not documented or if some documented parameters are not present anymore in the code.\n\nThat would help ensuring in pull requests that the documentation stays complete and as relevant as possible.\n\nExamples that would fail:\n\nh3. failure because of non-documented parameter\n{code:puppet}\n# This class is an example\n#\n# @param foo This parameter is documented\nclass mymodule (\n $foo,\n $bar,\n){\n}\n{code}\n\nh3. failure because of irrelevant documentation\n{code:puppet}\n# This class is an example\n#\n# @param foo This parameter is documented\n# @param bar This parameter is documented but does not exist anymore\nclass mymodule (\n $foo,\n){\n}\n{code}\n\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32511", "fixedVersions": [], "id": "32511", "issueType": "Bug", "key": "PDOC-68", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should be able to fail instead of warn", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hmm, I didn't realize Strings didn't support this. The reason we want ~~~ instead of ``` is for consistency throughout the docs. It's going to prevent problems if and when Forge or module docs (or perhaps just chunks from those docs) move into the main docs page. It would be really lovely if Strings could handle that.", "created": "2015-12-16T17:21:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good news everyone! We no longer need to explicitly prefer ~~~ to ``` in our docs, as some significant improvements have been made. Obviously, at this point, there are quite a few modules that use ~~~ , so I don't know that this issue just goes away immediately. We may still want Strings to support ~~~, though my sense is that the community generally prefers ```.", "created": "2016-01-20T09:58:00.000000" }, { "author": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "body": "Woot. [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] are you going to change the guidance?\n\nMy experience is that the community (and the wider GitHub community) definitely tend to use ```. It's worth bringing up with the wider modules team (Former user for reference) about whether to do in passing or in one go. Using strings for modules and dog fooding it would make a ton of sense.", "created": "2016-01-20T10:02:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Indeed I am [~accountid:5c6157fbdb49e4016460f4a3]. \n\n{quote}\nIt's worth bringing up with the wider modules team about whether to do in passing or in one go.\"\n{quote}\n\n\"... to do\" what? Sorry, not sure what you mean here. If you mean changing the ~~~ back to ```, I'm not sure I see any reason to shift that. As far as I know, they aren't a problem in any way, so my inclination would be to leave them be, and in the interest of consistency, we can change them as we touch READMEs.", "created": "2016-01-20T14:05:00.000000" }, { "author": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "body": "Specifically changing the READMEs as part of starting to use Puppet Strings to publish documentation for some of the supported modules. \n\nI think until Puppet Labs start using Strings it's hard to get other people in the community to adopt it.", "created": "2016-01-21T02:40:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Ah, I see. Oh, yeah, I think that's a ways off yet.", "created": "2016-01-21T11:29:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "{{find | xargs sed -i -e 's/^~~~$/```/'}} is easy, and can be scripted across all modules. I can pull the trigger on the next modulesync run (which is coming up RSN). [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], do I get green lights from you?", "created": "2016-10-09T14:18:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "A question here is if Strings allows the syntax to follow the ``` ? for example {{``` puppet}}", "created": "2016-10-10T08:26:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I don't know why I didn't get/see [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02]'s previous ping on this ticket", "created": "2017-04-25T11:23:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] thanks - sounds good.\n\nDoes it work to use ```puppet or ```ruby etc to tell the renderer about language/syntax coloring ?", "created": "2017-04-27T12:30:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It does, [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]! Language highlighting was added last year, and I love it a lot.", "created": "2017-04-27T14:31:00.000000" } ], "components": [], "created": "2015-12-16T03:14:00.000000", "creator": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4464411" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtof:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Dec/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_70016183966_*|*_5_*:*_1_*:*_0" } ], "description": "From speaking with [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] and others in docs, they recommend using {{~~~}} as the delimiter in README's for code, rather than the more common (in my experience) {{```}}.\n\nHere's an email from the apache module: https://raw.githubusercontent.com/puppetlabs/puppetlabs-apache/master/README.md\n\nHowever strings 0.3.1 doesn't render this as code, specifically it will just pass it through unrendered like so:\n\n{code}\n~~~ kubectl config view \u2013raw=true ~~~\n{code}\n\nThis limits the use of strings for all internal modules at the moment.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32462", "fixedVersions": [], "id": "32462", "issueType": "Bug", "key": "PDOC-67", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:b62c47a4-37e4-460d-8791-518bdfebf3e8", "resolution": "Fixed", "resolutionDate": "2018-03-05T12:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Issue with markdown rendering of code using ~~~", "timeSpent": "PT0S", "updated": "2018-03-05T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c08e1562ab90069f8aed4", "body": "Yikes, I forgot puppet describe even existed. \n\nContext for other readers: \"puppet describe\" is an alternate interface to the old embedded docs code that currently generates the core [resource type reference|http://docs.puppetlabs.com/references/latest/type.html#exec-providers] for the docs website. On the docs site, we do print info about the providers, as well as a bunch of other info that \"puppet describe\" can't do. ", "created": "2015-12-03T12:03:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "I'm of the opinion that any work on puppet describe is wasted effort that we should be spending on Puppet Strings instead. The old embedded docs code is rotting, and if we can get Strings ready for prime-time, we'll win big all over the place. This sounds like a feature request for Strings: it should have a minimal interface for reading docs on the CLI, and should be able to filter down to arbitrary details if needed (so you don't need to scroll a mile back up to find what you were looking for. ", "created": "2015-12-03T12:06:00.000000" }, { "author": "623a46a94a57610068e6760c", "body": "It would be useful to know what Puppet Strings are and perhaps a link to it. I would love to see closer correlations between the web based docs and the CLI. Being able to read docs on the CLI means I can:\n* Work in a very limited environment\n* Don't have to context switch \n* Get to docs much more quickly\n* Don't need the internet ( there is still places like that )\n\nThe last time I taught Puppet Fundamentals, the course material still contained references to puppet describe and various other command line based documentation. I should probably have made this ticket more generic since puppet describe seems to be out of date for almost all build in resource types.", "created": "2015-12-06T07:19:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "[~accountid:557058:8b8ee68d-9213-4499-8e76-36a21cb10c37] https://github.com/puppetlabs/puppetlabs-strings\n\nRight now it has rudamentary support for resource types and providers, but it hasn't been expanded and hardened to make sure it works with the core built-in resource types. ", "created": "2015-12-11T12:10:00.000000" } ], "components": [ "DOCS" ], "created": "2015-12-03T03:23:00.000000", "creator": "623a46a94a57610068e6760c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@138cdd24" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "623e796e8d8b9c0068b9f467" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz3eev:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Dec/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_71138806327_*|*_6_*:*_1_*:*_0" } ], "description": "When running {{puppet describe exec}} it does not contain information about the providers other than listing them. It would be useful to know and understand the behaviour and assumptions with the various providers. Currently if you want to do that you have to read the actual implementation code. \n\npuppet --version\n3.4.3", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32422", "fixedVersions": [], "id": "32422", "issueType": "Improvement", "key": "PDOC-169", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a46a94a57610068e6760c", "resolution": "Won't Do", "resolutionDate": "2018-03-05T12:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings should produce documentation for providers", "timeSpent": "PT0S", "updated": "2018-05-18T16:49:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "We don't do this currently. A nice-to-have.", "created": "2018-03-05T11:58:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "This would be a nice enhancement to the generated types documentation, but [~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de]'s comment is still correct: nice to have, not a blocker or top priority.", "created": "2019-08-12T15:27:00.000000" } ], "components": [], "created": "2015-10-28T06:45:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2b00a0f8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2thr:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "Puppet's subscribe/notify/~> features allow a changed resource to send a \"refresh event\" to another resource. Each type gets to choose whether and how to respond to a refresh, and only a few of them actually do anything.\n\nWe should detect resource types that support refreshing, and document what their refresh behavior is. \n\nThis is easier than it sounds, because all refreshable types do something like this:\n\nexec: \n\n{code}\n # Run the command, or optionally run a separately-specified command.\n def refresh\n if self.check_all_attributes(true)\n if cmd = self[:refresh]\n provider.run(cmd)\n else\n self.property(:returns).sync\n end\n end\n end\n{code}\n\nservice: \n\n{code}\n # Basically just a synonym for restarting. Used to respond\n # to events.\n def refresh\n # Only restart if we're actually running\n if (@parameters[:ensure] || newattr(:ensure)).retrieve == :running\n provider.restart\n else\n debug \"Skipping restart; service is not running\"\n end\n end\n{code}\n\npackage: \n\n{code}\n # When a refresh event is triggered, calls reinstall on providers\n # that support the reinstall_on_refresh parameter.\n def refresh\n if provider.reinstallable? &&\n @parameters[:reinstall_on_refresh].value == :true &&\n @parameters[:ensure].value != :purged &&\n @parameters[:ensure].value != :absent &&\n @parameters[:ensure].value != :held\n\n provider.reinstall\n end\n end\n{code}\n\nI suggest we just look for a `def refresh` in the type, and attach the text of the comment directly preceding that method definition. \n\nIn the json output, maybe add refresh: true and refresh_behavior: doc. ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32461", "fixedVersions": [], "id": "32461", "issueType": "New Feature", "key": "PDOC-66", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Document whether resource types react to refresh events", "timeSpent": "PT0S", "updated": "2019-08-12T15:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:dd7ba664-1e31-4b6c-9525-768d1f3babc2", "body": "It would be nice to have the ability to ensure that all parameters of a class or define are documented in some way. This could be added to tests to enforce quality, such as is common for linting.", "created": "2015-10-24T10:58:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Closing in favor of duplicate PDOC-68.", "created": "2016-09-14T15:16:00.000000" } ], "components": [], "created": "2015-10-24T08:50:00.000000", "creator": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6855cfbb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2s13:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Oct/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_28189548050_*|*_6_*:*_1_*:*_0" } ], "description": "This would make it easy to incorporate Strings into CI pipelines. At the SeaGL conference [~accountid:557058:dd7ba664-1e31-4b6c-9525-768d1f3babc2] described to me a hacky script he uses to do this for several complicated modules he maintains.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32536", "fixedVersions": [], "id": "32536", "issueType": "Bug", "key": "PDOC-65", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "resolution": "Duplicate", "resolutionDate": "2016-09-14T15:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should have a flag to exit abnormally when warnings are issued", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "old code is old. We don't monkey patch anymore and we're dropping Puppet 3 soon anyway.", "created": "2018-03-05T11:55:00.000000" } ], "components": [], "created": "2015-10-16T16:59:00.000000", "creator": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c435b63" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymto7:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_75239736169_*|*_6_*:*_2_*:*_13632" } ], "description": "Currently we monkeypatch Yard's methodObject. Instead, we should subclass it and create a distinct Puppet4xObject and Puppet3xObject.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32430", "fixedVersions": [], "id": "32430", "issueType": "Improvement", "key": "PDOC-64", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "resolution": "Won't Do", "resolutionDate": "2018-03-05T11:55:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create Puppet4xFunction and Puppet3xFunction code objects", "timeSpent": "PT0S", "updated": "2018-03-05T11:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Ping [~accountid:623c08e1562ab90069f8aed4] How can this be reproduced? Just run Strings against Puppet core and it is obvious?", "created": "2016-02-01T17:10:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Yup, I'm pretty sure you won't be able to miss it", "created": "2016-02-01T19:19:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I'm not sure if this is really intended to work with strings as is, especially since the module specifically ignores itself to avoid raising a billion errors. Definitely not disagreeing that this should work, but it might be worth it to identify this as a bug vs a major feature. [~accountid:623e754d94742a00683f7cf0] if you have a chance could you weigh in on this?", "created": "2016-03-09T16:27:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This is a Bug - as it is a major deficiency - the intention all along is to replace the old documentation features in puppet. Being able to generate the documentation for puppet itself is key. Now, this is not completely Puppet String's fault. As an example some of the 4.x functions have som clever constructs for types that we are going to address with the new function local type aliasing in Puppet 4.5.0.\n\nIt may also have worked (or partially worked at some point) - but it is now not working and needs to be fixed.", "created": "2016-03-09T18:53:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Okay I actually looked into this a little bit, basically what I was wondering if this was a regression and/or if significant modification would be required to strings to make this work. Basically what I found is that this is basically a regression, because if you run Strings 0.2.0 against core puppet you get roughly the same errors you get from running just YARD:\n\nStrings 0.2.0: https://gist.github.com/HAIL9000/8dd91d0ab9b896a94859\nYARD: https://gist.github.com/HAIL9000/ef98094d54914d6afc52\n\nHowever if you use Strings 0.3.0 you start to get a ton of issues from the provider handler. I didn't do enough digging to see if these are legit errors (as in it actually is trying to parse a provider and failing) or if it's just strings trying to parse something as a provider when it's not:\n\nStrings 0.3.0: https://gist.github.com/HAIL9000/e131385b2b396cd06a60\n\nHowever even before this regression strings was pretty noisy running against puppet because YARD issues so many warnings. So I think what i'm wondering is if we care about strings running against ALL the code in the core puppet repository, or if we just want to document puppet-ee things like our functions, types, providers, etc. Because I think if we limit the files strings looks at, we'll see a lot less warnings and errors (because they're mostly coming from YARD parsing our ruby classes/methods or the provider handler trying to parse our source code).", "created": "2016-03-09T21:22:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Thanks [~accountid:623cffe88d8b9c0068b93ebf],\n{quote}\nHowever even before this regression strings was pretty noisy running against puppet because YARD issues so many warnings. So I think what i'm wondering is if we care about strings running against ALL the code in the core puppet repository, or if we just want to document puppet-ee things like our functions, types, providers, etc. Because I think if we limit the files strings looks at, we'll see a lot less warnings and errors (because they're mostly coming from YARD parsing our ruby classes/methods or the provider handler trying to parse our source code).\n{quote}\n\nAbsolutely! Strings has no business documenting the rest of Puppet as the intent is documentation from a Puppet Language aspect - not an implementation aspect. For that you would need to run Yard separately and on your own.\n\n", "created": "2016-03-10T06:32:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "I'm also in favor of ignoring non-puppet-y Ruby code.", "created": "2016-03-10T11:18:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Note on this: Peter's work fixes this on the strings side, but we'll still need to go into core and make a lot of docs updates. Peter also mentioned we should limit what strings looks at in core. Right now it globs all of lib/, but really we just want functions, types, providers, etc.\n\nOnce Peter's work is merged in, we can effectively call this ticket done. The work to update core docs is tracked in PDOC-87.", "created": "2016-09-12T17:18:00.000000" } ], "components": [], "created": "2015-10-16T12:28:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@364926c4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-59" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymw9z:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_213036412_*|*_1_*:*_1_*:*_26885125120_*|*_10007_*:*_1_*:*_324109067_*|*_3_*:*_1_*:*_1817139646_*|*_5_*:*_1_*:*_1867688355_*|*_6_*:*_1_*:*_0" } ], "description": "Strings will bring back the goods from the core Puppet code, but it runs into some major problems as well. A bunch of them are probably from trying to gather docs that we don't need to gather? But I'm not sure. \n\nThis ticket represents Peter's general rewrite of strings, including the addition of new spec tests. The rewrite fixes many problems in strings itself, just leaving work on the core side to update docs to adhere to the new YARD standards.", "epicLinkSummary": "Improve behavior of Strings to support integration into Docs workflow ", "estimate": "PT0S", "externalId": "32365", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32365", "issueType": "Bug", "key": "PDOC-63", "labels": [], "originalEstimate": "PT0S", "parent": "32534", "parentSummary": "Improve behavior of Strings to support integration into Docs workflow ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-09-18T22:31:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings outputs errors on puppet core", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Not sure how to read the description", "created": "2016-02-04T05:43:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "It doesn't process .pp functions at all. ", "created": "2016-02-04T12:44:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Peter's rewrite added full support for .pp functions. Resolving!", "created": "2016-09-28T16:51:00.000000" } ], "components": [], "created": "2015-10-16T12:25:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3a53cb0f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2o1r:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_30083125556_*|*_6_*:*_1_*:*_0" } ], "description": "It's now possible to write functions in .pp files, stored in a module's {{functions}} directory. Docs forthcoming; Jorie's working on it. \n\nWe should capture docs for these functions as well, and we should probably store them in the puppet_functions namespace. To distinguish them from Ruby functions, we can either add a new element to them, or use a different value for function_api_version. ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32361", "fixedVersions": [], "id": "32361", "issueType": "New Feature", "key": "PDOC-62", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-09-28T16:51:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support functions written in the Puppet language", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "ping [~accountid:623c08e1562ab90069f8aed4] Are you saying that Strings picks that up and reports it as a single function? (named \"function_definition\" ??)\n\n(The logic in question is what makes it possible to call error, warning, info, notice, etc)", "created": "2016-02-01T17:14:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Uh, I think that's what I meant. It's been a while since I did this. ", "created": "2016-02-01T19:21:00.000000" }, { "author": "623c08e1562ab90069f8aed4", "body": "I think there was a copy-paste mishap in the original description of this ticket. The bogus function_definition function had nothing to do with the loglevel functions (which are just skipped by Strings, and I believe are in a separate ticket). ", "created": "2016-06-20T18:24:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Resolved in the rewrite.", "created": "2016-09-18T22:35:00.000000" } ], "components": [], "created": "2015-10-16T12:23:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@337b2365" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-59" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hynr3j:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_213264767_*|*_1_*:*_1_*:*_28702641560_*|*_10007_*:*_1_*:*_323998666_*|*_5_*:*_1_*:*_1867447751_*|*_6_*:*_1_*:*_0" } ], "description": "This looks like it's part of the implementation for functions written in the Puppet language. ", "epicLinkSummary": "Improve behavior of Strings to support integration into Docs workflow ", "estimate": "PT0S", "externalId": "32323", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32323", "issueType": "Bug", "key": "PDOC-61", "labels": [], "originalEstimate": "PT0S", "parent": "32534", "parentSummary": "Improve behavior of Strings to support integration into Docs workflow ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-09-18T22:35:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings finds bogus \"function_definition\" function", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623c08e1562ab90069f8aed4", "attachments": [ { "attacher": "62450221ad6b7e006aa4e34c", "created": "2016-09-29T12:01:00.000000", "name": "screenshot-1.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12391" } ], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think we do not need the loop. I think adding new log levels is a static thing. \n\nWe can just as well write \"the 7 functions\" instead of the loop. Then strings would find them. We otherwise need to maintain this documentation in meta tags and ensure Strings pick them up.", "created": "2016-02-01T17:34:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Todo: figure out priority on this.", "created": "2016-09-12T17:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Priority: This must be done in order to be able to replace the existing way of extracting the documentation. If not done there would be no documentation for the log functions on the docs site unless added manually.\n\nThere are many different ways to solve this problem. A simple unroll is worth testing as it may be all that is needed.", "created": "2016-09-13T04:34:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Another problem: strings can't seem to find instances of {{newfunction}} inside of a method. The following yields no {{puppet function}} output from strings:\n\n{noformat}\n def self.reset\n # Runs a newfunction to create a function for each of the log levels\n root_env = Puppet.lookup(:root_environment)\n AnonymousModuleAdapter.clear(root_env)\n\n Puppet::Parser::Functions::newfunction(:debug,\n :environment => root_env,\n :doc => \"Log a message on the server at level debug.\") do |vals|\n send(:debug, vals.join(\" \"))\n end\n...\nend\n{noformat}\n\nBut if I move the {{newfunction}} outside of the {{reset}} method, strings picks it up. Will have to investigate getting strings to handle this correctly.", "created": "2016-09-22T17:51:00.000000" }, { "author": "557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c", "body": "The Ruby function handler limits its detection to [\"namespace only\" calls|https://github.com/puppetlabs/puppet-strings/blob/master/lib/puppet-strings/yard/handlers/ruby/function_handler.rb#L20], which is why it won't see a call inside of a method. Users don't generally (if ever) dynamically generate functions, so there's probably a perf benefit for being \"namespace only\" (at least one would hope so given that it could skip over parsing method bodies entirely).\n\nWhen I originally mentioned the logging functions to Nick, we thought perhaps we'd have a special way of documenting dynamically generated functions (sort of like the directives we have for metaprogrammed resource type parameters/properties)", "created": "2016-09-22T18:22:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Ah, thanks for the context [~accountid:557058:372bc64a-3ef7-46ac-9a0a-50bcf4819b9c] - I'll look into separate definitions.", "created": "2016-09-22T18:39:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Another possible approach is to use yard meta tags on the {{create_logging_functions}} method in {{static_loader.rb}}. And then get yard to scan and process those.\n\nMaking them be free standing 3.x or 4.x functions (like all others) would work, but is not the best approach since the static loader is a bit special and we have no mechanism for directing functions being autoloaded to end up in the static loader.\n\n(just some thoughts)", "created": "2016-09-23T04:41:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] makes sense - the only problem there is that {{create_logging_functions}} is private, so YARD won't pick it up :(", "created": "2016-09-23T10:45:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:623c0e7494742a00683e3f3f] came up with a few options for this today. On Monday we'll see what [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] thinks of them.", "created": "2016-09-23T17:37:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] alright, here are the two approaches we've got. Do you have thoughts on which you prefer?\n\n1) Use the YARD {{parse}} directive (http://www.rubydoc.info/gems/yard/file/docs/Tags.md#parse) to give YARD a hint about what the metaprogrammed functions will be: https://gist.github.com/whopper/8c0439e55ccc7c13dbc9ce6a2dd7b482\n\nThis is a simple addition of comments, though it is a bit ugly as YARD doesn't have a mechanism to loop over an array of items. Otherwise, we wouldn't have needed to write out each function.\n\n2) Break each of the functions into their own files and {{eval}} them in the static loader:\n\nhttps://gist.github.com/whopper/b0966df9e155b8fec12448918ff7e9b2\n\nThis requires us to find the proper way to evaluate the new functions in the static loader. For testing, we just used {{eval}} on the path to the function.", "created": "2016-09-26T15:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Solution 1 has the downside that it is using the 3.x function API as meta-meta here. Eventually we want to retire the 3.x function API. We then have an additional problem to solve.\n\nSolution 2 here we risk that functions in the function directory ends up being loaded and ending up in a different loader (by mistakes made in the future). This solution seems harder to maintain as a future change needs to go into all of the files. Here it is also unclear if it will actually work as the dispatcher is fake as the function reimplements the call method. To pursue on this path I think we need to create a new base class that the function inherits from so we can have a minimum of information in it (maintain the functionality in the base class). This seems like a lot of work at higher risk.\n\nWould using the 4.x API in the @!parse comments work? That would remove the only objection I had against Solution 1.\n\n\n\n\n", "created": "2016-09-26T15:52:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] ah, good call. I'll investigate using the 4.x API with @!parse. We should be able to do the same thing with it.", "created": "2016-09-26T15:57:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "PR is up at https://github.com/puppetlabs/puppet/pull/5299. PUP-6742 is the tracking puppet ticket.", "created": "2016-09-26T17:16:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Puppet CI passed with the changes to the logging functions at https://jenkins.puppetlabs.com/job/platform_puppet_intn-van-sys_master/398/. This ticket probably still warrants a review from [~accountid:623c08e1562ab90069f8aed4] before we resolve it.\n\nEdit: added a screenshot of strings output for the {{debug}} function. The JSON output is https://gist.github.com/whopper/980f7233fb99d48a8bdfe5f85ee484e6", "created": "2016-09-28T16:17:00.000000" } ], "components": [], "created": "2015-10-16T12:22:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@447322e3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-97" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hynr3b:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_16383824_*|*_1_*:*_1_*:*_28703128364_*|*_10007_*:*_1_*:*_152812389_*|*_3_*:*_1_*:*_343864196_*|*_10009_*:*_1_*:*_596919024_*|*_5_*:*_1_*:*_429235372_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_865095585" } ], "description": "The functions like notice and warn are all defined in a loop over in lib/puppet/parser/functions.rb, so Strings can't see them the way it sees normal functions. \n\n{code}\n # Runs a newfunction to create a function for each of the log levels\n Puppet::Util::Log.levels.each do |level|\n newfunction(level,\n :environment => Puppet.lookup(:root_environment),\n :doc => \"Log a message on the server at level #{level.to_s}.\") do |vals|\n send(level, vals.join(\" \"))\n end\n end\n end\n{code}", "epicLinkSummary": "Initial increment for puppet strings and docs workflow", "estimate": "PT0S", "externalId": "32578", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32578", "issueType": "Bug", "key": "PDOC-60", "labels": [], "originalEstimate": "PT0S", "parent": "32434", "parentSummary": "Initial increment for puppet strings and docs workflow", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-10-05T14:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings skips docs for the log message functions", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c08e1562ab90069f8aed4", "body": "Also, some of the fixes might involve changes to the code we're targeting, rather than changes to Strings.", "created": "2015-10-16T12:21:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Moving this to triage sprint. These bugs prevents us fro using Strings to document puppet core.", "created": "2016-02-01T17:46:00.000000" } ], "components": [], "created": "2015-10-16T12:19:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Scrum Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Language" }, { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Puppet Developer Experience" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7159407c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-7" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Strings for Docs" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "Done" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "purple" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymvhb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_28783041917_*|*_6_*:*_1_*:*_0_*|*_10013_*:*_1_*:*_681646343" } ], "description": "*Note:* this epic covers precursor work to improving the utility of puppet strings for the puppet docs team. Remaining work required to be minimally useful to the docs team is tracked in PDOC-97. Potential beyond the initial increment is tracked in PDOC-98.\n\nThe purpose of this epic is to allow the docs team to use Strings in order to document 4.x style functions. As part of supporting that goal, this epic will also contain tickets that are needed so that the docs team can integrate strings with their workflow. \n\nYou can point Strings at a checkout of Puppet's core Ruby code, and get something fairly useful! But there are some problems still. \n\nI'm mostly focusing on JSON behavior for this epic; I haven't looked at the yardoc website it generates, and am not sure what I'd find if I did. ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32534", "fixedVersions": [ "PDOC 0.99.0" ], "id": "32534", "issueType": "Epic", "key": "PDOC-59", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "resolution": "Fixed", "resolutionDate": "2016-09-21T12:57:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Improve behavior of Strings to support integration into Docs workflow ", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:8f824870-010d-4f9e-99c7-28e4e3a21752], thanks for reporting this. I'm reproducing this as well as some other similar issues when using the server command. I'll look into this further and see if I can figure out what's going on.", "created": "2015-10-07T13:11:00.000000" }, { "author": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "body": "thanks Hailee, \n\nany progress?", "created": "2015-11-10T13:44:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:8f824870-010d-4f9e-99c7-28e4e3a21752] thanks for reminding me! We're going to pull this into a sprint soon so we can get this resolved for the next release. Sorry this fell off my radar. ", "created": "2015-11-10T16:33:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:8f824870-010d-4f9e-99c7-28e4e3a21752], I fixed some errors that I was seeing with the `puppet strings server` command, but I haven't been able to reproduce the error that you're seeing. I think it may be due to something that changed in the parser, since your stack trace looks like that's where the errors are coming from.\n\nWould it be possible to provide me with the full manifest that you're running strings against so that I can reproduce this? I wasn't sure if that was the whole thing in the stack trace.\n\nThanks!", "created": "2015-12-08T11:18:00.000000" }, { "author": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "body": "thanks Hailee,\n\nsure thing. It's quite simple so here it is:\n\nclass bw_cron::aide {\n case $::operatingsystem {\n 'RedHat': {\n cron { \"old_aide\":\n ensure => absent,\n command => \"root /usr/sbin/aide --check\",\n minute => 05,\n hour => 04,\n user => 'root',\n }\n cron { \"aide\":\n ensure => present,\n command => \"/usr/sbin/aide --check > /dev/null 2>&1\",\n minute => 05,\n hour => 04,\n user => 'root',\n }\n }\n }\n}\n", "created": "2015-12-08T11:42:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Thanks so much for working with me on this, sorry it's taking a while. I still don't seem to be able to reproduce the error you're seeing, even with the manifest and running puppet 3.8.1. My feeling though is that this is something related to puppet itself rather than strings, since the error is coming from the parser (although the fact that this is only popping up in strings and not in general parsing seems very mysterious).\n\nIs there anyway you could quickly test this with a slightly newer version of PE (like 3.8.4) and let me know what happens?", "created": "2015-12-09T16:57:00.000000" }, { "author": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "body": "no change, \nwhat is funny is that running strings against the manifest individually produces no error.\n\n*Here's the output:*\n\n{color:#205081}[courtneybarnett@puppet2.sclab bw_cron]\n$puppet --version\n3.8.4 (Puppet Enterprise 3.8.3)\n$puppet strings server\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler:\n[error]: in `manifests/aide.pp`:4:\n\nclass bw_cron::aide {\n case $::operatingsystem {\n 'RedHat': {\n cron { 'old_aide':\n ensure => absent,\n command => 'root /usr/sbin/aide --check',\n minute => 05,\n hour => 04,\n user => 'root',\n }\n cron { 'aide':\n ensure => present,\n command => '/usr/sbin/aide --check > /dev/null 2>&1',\n minute => 05,\n hour => 04,\n user => 'root',\n }\n }\n default: {}\n }\n}\n\n[error]: ParseError: illegal comma separated argument list\n[error]: Stack trace:\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:68:in `error'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:190:in `rescue in transform_calls'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:182:in `transform_calls'\n egrammar.ra:73:in `_reduce_4'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/lexer2.rb:291:in `scan'\n (eval):3:in `_racc_yyparse_c'\n\nError: Syntax error at '==' at line 1:1\nError: Try 'puppet help strings server' for usage\n{color}", "created": "2015-12-11T13:13:00.000000" }, { "author": "557058:b3e6b0df-198d-45f8-9ba5-d41f90e80ced", "body": "[~accountid:623cffe88d8b9c0068b93ebf], I get a different stack trace from the latest error that [~accountid:557058:8f824870-010d-4f9e-99c7-28e4e3a21752] reported above using latest PE 3.8 build.\n\nversion {{3.8.4 (Puppet Enterprise 3.8.3-7-ga9c656d)}}\n\nh3. Steps to reproduce\n1. Install PE-3.8\n * with beaker, the default answer file is sufficient\n\n2. Enable future parser on master\n {{parser = future}} in {{master}} section of {{puppet.conf}} file on master\n\n3. Install strings module as instructed in the module readme\n{code}\npuppet resource package yard provider=gem\npuppet module install puppetlabs-strings\n{code}\n\n4. Run {{puppet strings server}}\n\nh3. Result\n{code}\n[root@gd1d7t4kk9pjz77 ~]# puppet strings server\n[error]: Unhandled exception in YARD::Handlers::Ruby::ClassHandler:\n[error]: in `lib/puppet_x/puppetlabs/strings/yard/handlers/base.rb`:3:\n\n 3: class PuppetX::PuppetLabs::Strings::YARD::Handlers::Base < YARD::Handlers::Base\n\n[error]: ArgumentError: superclass # cannot be the same as the declared class #\n[error]: Stack trace:\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/code_objects/class_object.rb:139:in `superclass='\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/ruby/class_handler.rb:18:in `block (2 levels) in '\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/base.rb:408:in `block in register'\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/base.rb:405:in `each'\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/base.rb:405:in `register'\n /opt/puppet/lib/ruby/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/ruby/class_handler.rb:17:in `block in '\n\n>> YARD 0.8.7.6 documentation server at http://0.0.0.0:8808\n[2015-12-16 16:04:44] INFO WEBrick 1.3.1\n[2015-12-16 16:04:44] INFO ruby 1.9.3 (2014-11-13) [x86_64-linux]\n[2015-12-16 16:04:44] WARN TCPServer Error: Address already in use - bind(2)\n[2015-12-16 16:04:44] INFO WEBrick::HTTPServer#start: pid=13620 port=8808\n{code}", "created": "2015-12-16T17:09:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:b3e6b0df-198d-45f8-9ba5-d41f90e80ced] Are you using the most recent version of puppet strings master? I was seeing that error too, this pull request fixed it for me: https://github.com/puppetlabs/puppetlabs-strings/pull/69\n\nIt's possible this same error is causing the stack trace Mike is seeing...? But since his errors are coming from the parser that seems a little unlikely. ", "created": "2015-12-17T11:17:00.000000" }, { "author": "557058:b3e6b0df-198d-45f8-9ba5-d41f90e80ced", "body": "Thanks [~accountid:623cffe88d8b9c0068b93ebf]. (facepalm). I was not using the latest puppet strings. When repeating the process with strings at SHA {{3a8067bad5729aa358e5e990a7f9e0737a7aaf58}} the server starts up without error.", "created": "2015-12-17T15:59:00.000000" }, { "author": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "body": "Listen guys, This has been open since september. I see it's not a priority for you. Given that, then this tool and other of your products lose value to us. We'll simply find another way to work that doesn't involve plabs.", "created": "2016-02-08T14:55:00.000000" }, { "author": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "body": "removing myself as a watcher.", "created": "2016-02-08T15:07:00.000000" }, { "author": "557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920", "body": "[~accountid:557058:8f824870-010d-4f9e-99c7-28e4e3a21752] I wouldn't say it's not a priority", "created": "2016-02-08T17:54:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Closing this because it's old, it's puppet 3, and the reporter has left.", "created": "2018-04-12T07:09:00.000000" } ], "components": [], "created": "2015-09-25T14:40:00.000000", "creator": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@61c3e8de" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtr3:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Oct/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1031460045_*|*_3_*:*_2_*:*_26364782986_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_3_*:*_52928699842" } ], "description": "when running puppet strings server I see an unhandled exception. I'm running PE 3.8.1 with the future parser. The manifest it mentions doesn't appear to be the problem. \n\nHere is the complete output:\n{code}\n[foo@puppet2.sclab bw_cron]$puppet strings server\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::HostClassHandler:\n[error]: in `manifests/aide.pp`:4:\n{code}\n{code:puppet}\nclass bw_cron::aide {\n case $::operatingsystem {\n 'RedHat': {\n cron { 'old_aide':\n ensure => absent,\n command => 'root /usr/sbin/aide --check',\n minute => 05,\n hour => 04,\n user => 'root',\n }\n cron { 'aide':\n ensure => present,\n command => '/usr/sbin/aide --check > /dev/null 2>&1',\n minute => 05,\n hour => 04,\n user => 'root',\n }\n }\n default: {}\n }\n}\n{code}\n{code}\n[error]: ParseError: illegal comma separated argument list\n[error]: Stack trace:\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:68:in `error'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:190:in `rescue in transform_calls'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/parser_support.rb:182:in `transform_calls'\n egrammar.ra:72:in `_reduce_4'\n /opt/puppet/lib/ruby/site_ruby/1.9.1/puppet/pops/parser/lexer2.rb:285:in `scan'\n (eval):3:in `_racc_yyparse_c'\n\nError: Syntax error at '==' at line 1:1\nError: Try 'puppet help strings server' for usage\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32559", "fixedVersions": [], "id": "32559", "issueType": "Bug", "key": "PDOC-58", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:8f824870-010d-4f9e-99c7-28e4e3a21752", "resolution": "Fixed", "resolutionDate": "2018-04-12T07:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "strings server throws unhandled exception", "timeSpent": "PT0S", "updated": "2018-04-12T07:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c14e0b75ca8007056d418", "body": "Validated with puppet-strings SHA:5206c8c62e91b564ae1de1341c662a21b5740bb2 using the test file given in the ticket description and the new output does not have the nil and extra quotes\n{code}\n[warn]: @param tag types do not match the code. The s2\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"Enum[\\\"running\\\",\\\"stopped\\\"]\"]\n in the file test.rb near line 5.\n{code}", "created": "2015-09-23T14:09:00.000000" } ], "components": [], "created": "2015-09-18T17:16:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@acc89b1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2acv:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_68415134_*|*_1_*:*_1_*:*_3799084_*|*_10007_*:*_1_*:*_257496751_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_91123748" } ], "description": "In warnings and documentation Strings will sometimes show quotes which aren't necessary. This was pointed out by Branan in the Strings demo. There are also a bunch of annoying 'nil's in the output.\n\nWe got:\n{code}\n[warn]: @param tag types do not match the code. The s2\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [nil, \"'Enum[\\\"running\\\",\\\"stopped\\\"]'\"]\n in the file 4xtyped.rb near line 5.\n{code}\n\nWe expected:\n{code}\n[warn]: @param tag types do not match the code. The s2\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"Enum[\\\"running\\\",\\\"stopped\\\"]\"]\n in the file 4xtyped.rb near line 5.\n{code}\n\nSample code:\n{code}\n# @param a [Hash] comment\n# @param b [String] comment\n# @param s1 [Hash] comment\n# @param s2 [String] comment\nPuppet::Functions.create_function(:min) do\n dispatch :min do\n param 'Hash[String,String]', :a\n param 'Numeric', :b\n end\n\n dispatch :min_s do\n param 'Hash[String,Optional[String]]', :s1\n param 'Enum[\"running\",\"stopped\"]', :s2\n end\n\n def min(x,y)\n x <= y ? x : y\n end\n\n def min_s(x,y)\n cmp = (x.downcase <=> y.downcase)\n cmp <= 0 ? x : y\n end\nend\n\n{code}", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32421", "fixedVersions": [ "PDOC 0.3.1" ], "id": "32421", "issueType": "Bug", "key": "PDOC-57", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-23T14:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings prints unnecessary quotes", "timeSpent": "PT0S", "updated": "2015-10-01T14:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c14e0b75ca8007056d418", "body": "Validated with puppet-strings SHA: d965d06bcab12c9806e46f7f225fe86e90369623\n\n{code}\n\n[root@khmjqkr8x7ocaal bar]# cat manifests/init.pp\n# Docstring\n# @param notatype\n# @param barname Float\n# @param barval [String]\ndefine foo::bar ( String $barname, Float $barval )\n{\n\n notify {'$barname':}\n\n notify {'$barval':}\n\n}\n\n[root@khmjqkr8x7ocaal bar]# puppet strings\n[warn]: The parameter notatype is documented, but doesn't exist in\n your code, in file manifests/init.pp near line 5.\n[warn]: @param tag types do not match the code. The barval\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"Float\"]\n in the file manifests/init.pp near line 5.\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 1 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 100.00% documented\n{code}", "created": "2015-09-22T16:31:00.000000" } ], "components": [], "created": "2015-09-18T17:13:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@715c1a0c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2acn:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_68543579_*|*_1_*:*_1_*:*_3978181_*|*_10007_*:*_1_*:*_257395254_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_13261380" } ], "description": "See Jo Rhett's example on PDOC-21 for an example.\n\nUsing the below file, we got:\n{code}\n[warn]: The parameter notatype is documented, but doesn't exist in\n your code, in file manifests/defined_type.pp near line 6.\n[warn]: @param tag types do not match the code. The barval\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [Puppet::Pops::Types::PFloatType]\n in the file manifests/defined_type.pp near line 6.\n{code}\nWe expected:\n{code}\n[warn]: The parameter notatype is documented, but doesn't exist in\n your code, in file manifests/defined_type.pp near line 6.\n[warn]: @param tag types do not match the code. The barval\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"Float\"]\n in the file manifests/defined_type.pp near line 6.\n{code}\nContents of the file:\n{code}\n\n# Docstring\n# @param notatype\n# @param barname Float\n# @param barval [String]\ndefine foo::bar ( String $barname, Float $barval )\n{\n\n notify {'$barname':}\n\n notify {'$barval':}\n\n}\n\n{code}", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32363", "fixedVersions": [ "PDOC 0.3.1" ], "id": "32363", "issueType": "Bug", "key": "PDOC-56", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-22T16:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings prints type checking warnings incorrectly for defined types.", "timeSpent": "PT0S", "updated": "2015-10-01T14:17:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c08e1562ab90069f8aed4", "body": "This doesn't appear to have any info about what this is for, so in short: Ruby-based types and providers can use all kinds of impenetrable metaprogramming to tersely create objects, and it seems impossible to determine what those objects are (and what their docstrings are) with a YARD-like static analysis of the code. To document things like the core Nagios types, we need an ability to explicitly override metadata for objects in a resource type. ", "created": "2016-09-12T16:01:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Wow. I have no idea if we still need this or not. A lot of the core types have since been moved into modules, but given the types that we still have, maybe this is part of the issue with that output being inaccurate. Consult with Strings devs.", "created": "2019-08-12T15:23:00.000000" } ], "components": [], "created": "2015-09-18T11:39:00.000000", "creator": "623c08e1562ab90069f8aed4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17f775c5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtnz:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Aug/19" } ], "description": "You can use a YARD tag to add a docstring for a non-discoverable parameter. It should also be possible to add default values and allowed values for that parameter. ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32564", "fixedVersions": [], "id": "32564", "issueType": "Improvement", "key": "PDOC-55", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c08e1562ab90069f8aed4", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@!puppet.type.parameter (and property) directive should be able to add metadata", "timeSpent": "PT0S", "updated": "2019-08-12T15:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "Thanks to Rob Reynolds for reporting the Chocolatey issue.", "created": "2015-09-16T18:01:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated in puppet-strings SHA: d965d06bcab12c9806e46f7f225fe86e90369623\n1) With puppetlabs-apt module: \n{code}\n[root@khmjqkr8x7ocaal apt]# pwd\n/etc/puppetlabs/code/environments/production/modules/apt\n[root@khmjqkr8x7ocaal apt]# puppet strings\nFiles: 13\nModules: 1 ( 1 undocumented)\nClasses: 1 ( 1 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 1 ( 0 undocumented)\nPuppet Classes: 4 ( 4 undocumented)\nPuppet Defined Types: 6 ( 3 undocumented)\nPuppet Types: 1 ( 1 undocumented)\nPuppet Providers: 1 ( 1 undocumented)\n 26.67% documented\n\n[root@khmjqkr8x7ocaal apt]# ls -l doc/apt_key*\n-rw-r--r--. 1 root root 3268 Sep 22 16:23 doc/apt_key_provider.html\n-rw-r--r--. 1 root root 6069 Sep 22 16:23 doc/apt_key_type.html\n[root@khmjqkr8x7ocaal apt]# cat doc/puppet_provider_list.html\n...\n
    \n
  • apt_keyTop Level Namespace
    • \n\n[root@khmjqkr8x7ocaal apt]# cat doc/puppet_type_list.html\n
      \n
    • apt_keyTop Level Namespace
      • \n\n{code}\n\n2) With puppet-chocolatey module\n\n{code}\n\n[root@khmjqkr8x7ocaal chocolatey]# pwd\n/etc/puppetlabs/code/environments/production/modules/chocolatey\n[root@khmjqkr8x7ocaal chocolatey]# puppet strings\nFiles: 5\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 4 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented\n\n[root@khmjqkr8x7ocaal chocolatey]# ls -l doc/chocolatey*\n-rw-r--r--. 1 root root 6496 Sep 22 16:45 doc/chocolatey.html\n-rw-r--r--. 1 root root 4085 Sep 22 16:45 doc/chocolatey_provider.html\n\n[root@khmjqkr8x7ocaal chocolatey]# cat doc/puppet_provider_list.html\n
        \n
      • chocolateyTop Level Namespace
        • \n\n{code}\n", "created": "2015-09-22T18:01:00.000000" } ], "components": [], "created": "2015-09-16T17:42:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@bf86bf5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz2907:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_68362643_*|*_1_*:*_1_*:*_432555300_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_159667865" } ], "description": "When you run strings on the apt module it says in the statistics that it is documenting the provider but not the type. When you look at the resulting documentation it links to the provider page in the type menu. The provider menu is empty. The provider page does not exist anywhere in the documented html.\n\nSimilarly, when you document the chocolatey module the provider is not listed in the menu.\n\n{code}\nFiles: 18\nModules: 1 ( 1 undocumented)\nClasses: 1 ( 1 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 1 ( 0 undocumented)\nPuppet Classes: 8 ( 5 undocumented)\nPuppet Defined Types: 8 ( 6 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 1 ( 1 undocumented)\n 30.00% documented\n{code}\n\nThis is because the apt module's type and provider are both named apt_key and there is a puppet class named chocolatey as well as a provider.\n\nActual behavior:\nApt module:\n* Strings only documents the provider and puts it under the type menu!\nChocolatey module:\n* Strings only documents the class\n\nExpected behavior (new):\nFor the apt module:\n* Strings documents the apt_key provider in doc/apt_key_provider.html\n* Strings documents the apt_key type in doc/apt_key_type.html\n* apt_key is present in the Puppet Types menu\n* apt_key is present in the Puppet Providers menu\n* 1 type is documented in the statistics output\n* 1 provider is documented in the statistics output\n\nFor the chocolatey module:\n* Strings documents the chocolatey provider in doc/chocolatey_provider.html\n* Strings documents the chocolatey type in doc/chocolatey.html\n* chocolatey is present in the Puppet Providers menu\n* chocolatey is present in the Puppet Classes menu\n* 1 provider is documented in the statistics output\n* 1 puppet class is documented in the statistics output'\n\nApt module: https://github.com/puppetlabs/puppetlabs-apt\nChocolatey module: https://github.com/chocolatey/puppet-chocolatey", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32359", "fixedVersions": [ "PDOC 0.3.1" ], "id": "32359", "issueType": "Bug", "key": "PDOC-54", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-24T09:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Types, Providers, and Classes with the same names may conflict.", "timeSpent": "PT0S", "updated": "2015-10-01T14:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c14e0b75ca8007056d418", "body": "{code}\n[root@x7dmn8uep2jaty0 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@x7dmn8uep2jaty0 foo]# cat lib/puppet/type/book.rb\n\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc = \"Get a book from somewhere\"\n\n feature :draw, \"The ability to draw.\"\n\n # This function does some metaprogramming on the new type.\n mk_resource_methods\n\n ensurable\n\n newparam(:name) do\n isnamevar\n desc \"The name of the book\"\n end\n\n newparam(:color) do\n desc <<-'EOT'\n The color of the book\n EOT\n newvalues(:red, :green, :blue, :purple)\n end\n\n newproperty(:enable) do\n newvalue(:true)\n newvalue(:false)\n end\n\n newproperty(:covertype) do\n desc \"Specify hardcover or paperback\"\n defaultto \"paperback\"\n end\nend\n\n[root@x7dmn8uep2jaty0 foo]# puppet strings\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::PuppetTypeHandler:\n[error]: in `lib/puppet/type/book.rb`:3:\n\n\t3: Puppet::Type.newtype(:book) do\n\n[error]: TypeError: no implicit conversion of nil into Array\n[error]: Stack trace:\n\t/etc/puppetlabs/code/environments/production/modules/strings/lib/puppet_x/puppetlabs/strings/yard/tags/directives.rb:6:in `+'\n\t/etc/puppetlabs/code/environments/production/modules/strings/lib/puppet_x/puppetlabs/strings/yard/tags/directives.rb:6:in `call'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/tags/library.rb:246:in `directive_call'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/tags/library.rb:200:in `puppet_type_param_directive'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/tags/library.rb:292:in `directive_create'\n\t/opt/puppetlabs/puppet/lib/ruby/gems/2.1.0/gems/yard-0.8.7.6/lib/yard/docstring_parser.rb:216:in `create_directive'\n\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 1 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented\n{code}\n\nIt does not crash if the '=' symbol is removed after '@doc'. But the html output is not getting generated for the new type.\nPuppet Types: 0 ( 0 undocumented)\nThere is no book.html file in the 'doc' directory.\n\n{code}\n[root@x7dmn8uep2jaty0 foo]# head -4 lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc \"Get a book from somewhere\"\n[root@x7dmn8uep2jaty0 foo]# puppet strings\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented\n{code}", "created": "2015-09-14T17:06:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated with puppet-strings SHA: 3c885cf550b71f3550f35af6b4821e3846a761e3 and no crashing observed.\n{code}\n[root@tjsif1buguekw02 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@tjsif1buguekw02 foo]# head -4 lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc = \"Get a book from somewhere\"\n\n*[root@tjsif1buguekw02 foo]# puppet strings\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 1 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented*\n\n{code}", "created": "2015-09-16T17:51:00.000000" } ], "components": [], "created": "2015-09-14T16:54:00.000000", "creator": "623c14e0b75ca8007056d418", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4953bc6f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyoehj:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Found" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Found as part of review for PDOC-35" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_77001404_*|*_1_*:*_1_*:*_58801844_*|*_10007_*:*_1_*:*_26837924_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_13587662" } ], "description": "puppet-string crashes when '@doc = some text' statement is used along with `@!puppet.type.param` directive when describing a custom type as described in the README.\n\n{code}\n[root@x7dmn8uep2jaty0 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@x7dmn8uep2jaty0 foo]# head -4 lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc = \"Get a book from somewhere\"\n{code}\n\nIf the '=' symbol is omitted after '@doc', then it does not crash. But the html output is not getting generated in this case\n{code}\n[root@x7dmn8uep2jaty0 foo]# head -4 lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc \"Get a book from somewhere\"\n{code}\n\nSee comments for the test file.\n\n", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32532", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32532", "issueType": "Bug", "key": "PDOC-53", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c14e0b75ca8007056d418", "resolution": "Fixed", "resolutionDate": "2015-09-16T17:51:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings crashing when \"@doc =\" is used along with `@!puppet.type.param`", "timeSpent": "PT0S", "updated": "2015-09-21T17:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c14e0b75ca8007056d418", "body": "Validated with puppet-strings SHA: 3c885cf550b71f3550f35af6b4821e3846a761e3 \n{code}\n[root@tjsif1buguekw02 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@tjsif1buguekw02 foo]# cat lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly documented\nPuppet::Type.newtype(:book) do\n @doc = \"Get a book from somewhere\"\n feature :draw, \"The ability to draw.\"\n\n mk_resource_methods\n\n ensurable\n\n newparam(:name) do\n isnamevar\n desc \"The name of the book\"\n end\n newparam(:color) do\n desc \"Your color\"\n newvalues(:red, :green, :blue, :purple)\n end\n\n newproperty(:enable) do\n newvalue(:true)\n newvalue(:false)\n end\n newproperty(:covertype) do\n desc \"Specify hardcover or paperback\"\n defaultto \"paperback\"\n end\nend\n*[root@tjsif1buguekw02 foo]# puppet strings\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 1 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented*\n[root@tjsif1buguekw02 foo]# cat doc/book.html\n

      • enable (Property) \n Allowed Values:
        • :true
        • :false
      • property_hash. -

        \n

        This parameter needs to be explicitly documented

        \n{code}", "created": "2015-09-16T18:05:00.000000" } ], "components": [], "created": "2015-09-14T16:38:00.000000", "creator": "623c14e0b75ca8007056d418", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@687f1ea4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyoehb:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Found" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Found as part of review for PDOC-35" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_76999095_*|*_1_*:*_1_*:*_60368494_*|*_10007_*:*_1_*:*_26245623_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_79049823" } ], "description": "The special directive `@!puppet.provider.param` does not generate a description of the parameter in the output html as described in the puppet-strings README.\n{code}\n[root@x7dmn8uep2jaty0 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@x7dmn8uep2jaty0 foo]# cat lib/puppet/type/book.rb\n# @!puppet.type.param property_hash. This parameter needs to be explicitly\n# documented as it is generated by mk_resource_methods\nPuppet::Type.newtype(:book) do\n @doc \"Get a book from somewhere\"\n\n feature :draw, \"The ability to draw.\"\n\n # This function does some metaprogramming on the new type.\n mk_resource_methods\n\n ensurable\n\n newparam(:name) do\n isnamevar\n desc \"The name of the book\"\n end\n\n newparam(:color) do\n desc <<-'EOT'\n The color of the book\n EOT\n newvalues(:red, :green, :blue, :purple)\n end\n\n newproperty(:enable) do\n newvalue(:true)\n newvalue(:false)\n end\n\n newproperty(:covertype) do\n desc \"Specify hardcover or paperback\"\n defaultto \"paperback\"\n end\nend\n{code}\n\nThe book.html generated by $puppet strings does not include a description of property_hash parameter", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32459", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32459", "issueType": "Bug", "key": "PDOC-52", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c14e0b75ca8007056d418", "resolution": "Fixed", "resolutionDate": "2015-09-17T12:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "The special directive `@!puppet.type.param` is not working with types", "timeSpent": "PT0S", "updated": "2015-09-21T17:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a480b9b54ec0068b0724e", "body": "Very close to done - when https://github.com/puppetlabs/puppetlabs-strings/pull/96 is merged this could be closed.", "created": "2016-09-02T11:31:00.000000" } ], "components": [], "created": "2015-09-14T16:10:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7aed7ae8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtnr:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Sep/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_78007427409_*|*_6_*:*_1_*:*_0" } ], "description": "We monkey patch enough of yard that we will be sensitive to changes in Yards private API (such as it is). We should make Strings depend on a minor and probably even bugfix version of Yard.\nWe are currently at version 0.8.7.6 of yard. I think we will want to pin to 0.8.7.* and evaluate compatibility with future yard releases as they come.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32362", "fixedVersions": [], "id": "32362", "issueType": "Bug", "key": "PDOC-51", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2018-03-05T11:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Pin yard to a very specific version", "timeSpent": "PT0S", "updated": "2018-03-05T11:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "Thanks for taking the time to report this.\n\nThis is actually what we expect. The most recent version of the README documentation instructs you to install the Yard gem after installing Strings. Please reread the README and let us know if you think out instructions are unclear or if you have ideas on how to make this more obvious.\n\n", "created": "2015-09-14T16:01:00.000000" }, { "author": "557058:3f6d53ac-921c-44ec-a73f-89a50ea7e0a9", "body": "This was an error on my part. Didn't add yard and redcarpet to Gemfile.\n\nThanks!", "created": "2015-09-18T14:03:00.000000" } ], "components": [], "created": "2015-09-14T07:21:00.000000", "creator": "557058:3f6d53ac-921c-44ec-a73f-89a50ea7e0a9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a74989b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz26jz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10546735931_*|*_6_*:*_1_*:*_0" } ], "description": "When running puppet strings using the puppet 4.2.1 gem I receive the following error:\n\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ puppet strings\nError: The 'yard' gem must be installed in order to use this face.\nError: Try 'puppet help strings yardoc' for usage\n{noformat}\n\nUsing `puppet resource` with the `puppet_gem provider` fails since this is a gem install of puppet.\n\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ puppet resource package yard provider=puppet_gem\nError: /Package[yard]: Provider puppet_gem is not functional on this host\nError: Could not run: Provider puppet_gem is not functional on this host\n{noformat}\n\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ irb\n1.9.3-p551 :001 > require 'puppet'\n => true \n1.9.3-p551 :002 > Puppet.features.yard?\n => false\n{noformat}\n", "environment": "\n{noformat}\n[ptierno@petes-thinkpad besagent]$ puppet --version\np4.2.1\n{noformat}\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ puppet module list\n/home/ptierno/.puppetlabs/etc/code/modules\n\u2514\u2500\u2500 puppetlabs-strings (v0.2.0)\n{noformat}\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ rvm list\n\nrvm rubies\n\n=> ruby-1.9.3-p551 [ x86_64 ]\n ruby-2.1.7 [ x86_64 ]\n * ruby-2.2.3 [ x86_64 ]\n\n# => - current\n# =* - current && default\n# * - default\n{noformat}\n\n{noformat}\n[ptierno@petes-thinkpad besagent]$ gem list yard\n\n*** LOCAL GEMS ***\n\nyard (0.8.7.6)\n{noformat}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32457", "fixedVersions": [], "id": "32457", "issueType": "Bug", "key": "PDOC-50", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:3f6d53ac-921c-44ec-a73f-89a50ea7e0a9", "resolution": "Fixed", "resolutionDate": "2016-01-14T07:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "The `yard` feature missing on gem install of puppet `4.2.1`", "timeSpent": "PT0S", "updated": "2016-01-14T07:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:8872d0b6-d198-4e25-92ad-02776be82d59", "body": "Verified that the warnings now are multiline and are prefixed with \"[warn]\".\nAlso verified the variety of cases of name and type mismatches in addition to unused documented parameter name cases.\nOne scenario that does not generate a warning is the use of a parameter that is not described in a doc string. In this case Yard does not generate a warning, so strings does not.", "created": "2015-09-16T11:08:00.000000" } ], "components": [], "created": "2015-09-11T15:00:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@469ecf23" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz269j:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Needed for 0.3.0 release." }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_317152354_*|*_1_*:*_1_*:*_3022123_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_97871597" } ], "description": "Someday we'll need our own logger but for now just a little cleanup.\n\n1. All warnings should start with 'warn:'\n2. Long warnings should be broken onto multiple lines.\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32455", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32455", "issueType": "Bug", "key": "PDOC-49", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-16T11:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Improve warnings", "timeSpent": "PT0S", "updated": "2015-09-16T17:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "We currently don't do anything with the @author tag and have no plans to. Do you think this is an important feature which should appear in the documentation? If so, where would you like it to appear in the code and the documentation?\n\nI don't see the usecase for sprinkling an @author on every puppet function and provider.", "created": "2015-09-14T16:05:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "The default template current sets up a large header area to list the authors. Why not use the tag and take advantage of YARD's capability?", "created": "2015-09-14T16:21:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "This has recently been revisited and we've decided not to display the @author tag. From a docs perspective, the author information muddies up the document itself without adding a lot of value. We want this to be reference material that contributes to the usability of the module and we feel like listing the author doesn't do that.", "created": "2018-03-05T11:53:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "So this answer would make sense if Author information didn't currently consume multiple lines in the template. Are you removing the author content from the module skeleton?\n\nMy proposal doesn't increase the information, it makes it indexable and linkable.\n\n{code}\n$ puppet module generate --skip-interview author-tag\nNotice: Generating module at /Users/jorhett/src/tag... (snip)\n\n$ grep -i author tag/manifests/init.pp\n# Authors\n# Author Name \n{code}", "created": "2018-03-05T12:16:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Apologies, from the description I thought you were referring to the yard-style @author tag.\n\nYeah, I do see the author content in the module skeletons used by {{puppet module generate}}. However, we are encouraging users to try the new PDK for this task. It uses https://github.com/puppetlabs/pdk-templates and no author content is present in those templates. ", "created": "2018-03-05T13:08:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "I was referring to that author tag. My idea was that if we are going to waste a few lines with that detail, let's use the tag. Since the PDF templates don't contain this it does seem to be going away so I agree that it's not helpful. I never loved that part of the template.", "created": "2018-03-05T20:39:00.000000" } ], "components": [], "created": "2015-09-07T20:57:00.000000", "creator": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@38e545f9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtnj:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_78594943462_*|*_6_*:*_1_*:*_0" } ], "description": "Tagged authors do not appear in the final output. They are completely consumed.\n\n{code}\n# @author Jo Rhett \n{code}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32577", "fixedVersions": [], "id": "32577", "issueType": "Bug", "key": "PDOC-48", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "resolution": "Won't Do", "resolutionDate": "2018-03-05T11:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "@author tag is swallowed up", "timeSpent": "PT0S", "updated": "2018-03-05T20:39:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Not sure this was ever implemented. Sounds like a nice-to-have, but I don't see it happening in the near future.", "created": "2018-03-05T11:44:00.000000" } ], "components": [], "created": "2015-09-02T17:54:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@996a17f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt2n:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Mar/18" } ], "description": "Complicated types and providers need a \"table of contents\" of parameters and providers kind of like this:\nhttp://docs.puppetlabs.com/references/latest/type.html#file-attributes\n\nOr the contents menu after the article abstract on wikipedia:\nhttps://en.wikipedia.org/wiki/Puppet_Labs", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32420", "fixedVersions": [], "id": "32420", "issueType": "Bug", "key": "PDOC-47", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet types and providers need in page navigation menu", "timeSpent": "PT0S", "updated": "2019-08-06T17:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623c17d4761efb0069ce0954", "created": "2015-09-02T17:51:00.000000", "name": "Screen Shot 2015-09-02 at 4.50.48 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12387" } ], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "No longer an issue with YARD 0.9.5.", "created": "2016-11-04T13:06:00.000000" } ], "components": [], "created": "2015-09-02T17:51:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@35dfc8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz218v:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_37048479598_*|*_6_*:*_1_*:*_0" } ], "description": "The dropdown menus at the top of yard are all fixed on the upper right corner. They should float under the menu being clicked on.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32356", "fixedVersions": [], "id": "32356", "issueType": "Bug", "key": "PDOC-46", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2016-11-04T13:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Dropdown menus are in wrong place", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at: eeeb89f", "created": "2015-09-07T06:25:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated with puppet-strings SHA:811df7d84dc205a9063d36a21ab3bbc67c799791\n\n{code}\n[root@pxsv4a598l89tqu modules]# puppet strings /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/functions/defined.rb\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 2 ( 1 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 50.00% documented\n\n[root@pxsv4a598l89tqu ~]# puppet strings test.rb\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 2 ( 2 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 0.00% documented\n\n[root@pxsv4a598l89tqu ~]# cat test.rb\nPuppet::Functions.create_function :'max' do\n def max(num_a, num_b)\n num_a >= num_b ? num_a : num_b\n end\nend\n{code}\n\nBefore fix, Strings crashed with error message:\n{code}\n[root@e77ig9jpwfyd6i3 puppetlabs-strings]# puppet strings /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/functions/defined.rb\n[error]: Unhandled exception in Puppet4xFunctionHandler:\n[error]: in `/opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/functions/defined.rb`:69:\n\n\t69: Puppet::Functions.create_function(:'defined', Puppet::Functions::InternalFunction) do\n\n[error]: ArgumentError: invalid empty object name\n[error]: Stack trace:\n{code}", "created": "2015-09-10T10:54:00.000000" } ], "components": [], "created": "2015-09-01T16:32:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7bf44674" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz22dj:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Before this, some unusual ruby constructs used as function names in the Ruby API could cause Puppet Strings to crash." }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Found" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "was found and worked on, but tagged wrong - did not show up on board." }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_269025733_*|*_1_*:*_2_*:*_481506610_*|*_10007_*:*_2_*:*_297665_*|*_3_*:*_1_*:*_150901_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_6347325" } ], "description": "This file has very unusual, but still apparently legal, syntax.\n{code}\nPuppet::Functions.create_function(:'defined', ....\n{code}\nA simple fix, handle that type of symbol.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32531", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32531", "issueType": "Bug", "key": "PDOC-45", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-10T10:55:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings crashes when documenting puppet's defined.rb", "timeSpent": "PT0S", "updated": "2017-06-19T11:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "No longer an issue in strings 0.99.0.", "created": "2016-11-04T13:08:00.000000" } ], "components": [], "created": "2015-09-01T16:28:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5bdd275a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz1z9j:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_37139962071_*|*_6_*:*_1_*:*_0" } ], "description": "{{code}}\nerror]: Exception occurred while generating 'Puppet4xFunctions.html'\n[error]: ParseErrorWithIssue: Syntax error at '|' at line 1:14\n[error]: Stack trace:\n\t/Users/iankronquist/gg/puppet/lib/puppet/pops/parser/parser_support.rb:123:in `on_error'\n\t/Users/iankronquist/gg/puppet/lib/puppet/pops/parser/lexer2.rb:297:in `scan'\n\t/Users/iankronquist/derpbundle/ruby/1.9.1/gems/racc-1.4.9/lib/racc/parser.rb:150:in `_racc_yyparse_c'\n\t/Users/iankronquist/derpbundle/ruby/1.9.1/gems/racc-1.4.9/lib/racc/parser.rb:150:in `yyparse'\n\t/Users/iankronquist/gg/puppet/lib/puppet/pops/parser/parser_support.rb:236:in `_parse'\n\t/Users/iankronquist/gg/puppet/lib/puppet/pops/parser/parser_support.rb:130:in `parse_string'\n\n{{code}}\n\nProbably happens here: \nhttps://github.com/puppetlabs/puppetlabs-strings/blob/2ceead0822d266c93a9f1f0010d3eab08f301ad0/lib/puppet_x/puppetlabs/strings/yard/templates/default/template_helper.rb#L121\n\nThat's the only place I can think of where things in comments are parsed as puppet code.\n\nSolution if my theory is true:\n1. Split types on on '|' before passing to the type parser\n2. Catch this exception and issue a warning. People may put crazy things in those brackets we can't parse.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32558", "fixedVersions": [], "id": "32558", "issueType": "Bug", "key": "PDOC-44", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2016-11-04T13:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings crashes when documenting Puppet's regsubst.rb", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64] Did you give up on this because you ran into issues? Not sure what exactly the feature was supposed to do, so hard to say how valuable your idea is. We are going to come back and do work on Strings but we have been busy with other things for a while.", "created": "2016-02-19T16:10:00.000000" }, { "author": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "body": "Well the issue is simple:\n\nit was about being able to have formatting in parameters description (bold, links...): \n{code}\n@param foo enables foo *warning: a super warning*\n{code}\n\nI gave up because no progress was made for months and I ran into several issues.", "created": "2016-02-19T16:14:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Ok, were there more formatting than bold? I would like to keep the ticket and modify it to describe the features that are missing. We may adopt your PR even and continue the work. Sorry for the long silence.", "created": "2016-02-19T16:25:00.000000" }, { "author": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "body": "Current we do not allow any formatting. I wanted to write the description in markdown directly.\n\nMy main usecase was links.", "created": "2016-02-19T16:27:00.000000" } ], "components": [], "created": "2015-08-31T09:19:00.000000", "creator": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b44f0a5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz1xbr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Feb/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_179983_*|*_10009_*:*_1_*:*_13476205125_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32557", "fixedVersions": [], "id": "32557", "issueType": "Bug", "key": "PDOC-43", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "resolution": "Won't Fix", "resolutionDate": "2016-02-03T07:45:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Allow more advanced formatting in parameters descriptions", "timeSpent": "PT0S", "updated": "2016-02-19T16:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "body": "wold be a nice way to fix PDOC-43", "created": "2015-09-01T02:53:00.000000" }, { "author": "557058:c5aa36ba-0d5b-4f03-866d-b7c36b853f64", "body": "Maybe the fix for this is PDOC-23", "created": "2015-09-01T02:54:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Looks like this was fixed", "created": "2018-03-05T11:42:00.000000" } ], "components": [], "created": "2015-08-27T16:57:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2773f1c6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtnb:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_79559126469_*|*_6_*:*_1_*:*_0" } ], "description": "They may allow arbitrary injection if you have maliciously formatted code.\n\nConsider the case where Strings documentation is included in PE console or some other web application (this isn't science fiction, this has been mentioned as a future possibility before). Perhaps the people who use the console depend on some module they didn't write and blindly pull down the latest version which contains code which has been maliciously formatted. The code has embedded html or an embedded script. The next time they regenerate the documentation and look at it the script will execute. Maybe this is my imagination running wild, but I bet this could be leveraged into what amounts to a cross site scripting attack. A cross site scripting attack against the console would be really cool and very dangerous.\n\nHere is an example of a maliciously formatted puppet type which runs a short bit of javascript which shows an alert. Run strings on it and visit the documentation page.\n\n{code}\nrequire 'puppet/parameter/package_options'\nrequire 'puppet/parameter/boolean'\n\nPuppet::Type.newtype(:package) do\n @doc = \"Manage packages.\"\n newparam(:p) do\n desc <<-EOT\n desc\n EOT\n defaultto \"\"\n end\nend\n\n{code}\n\n\nThe mitigation is simple: use an erb template, this is why they exist. They will automatically escape the malicious code for you.\nAlternately, write our own html escaping function and make sure to run it on the non-html parts which we want to include in our output. This sounds like a lot more work and opens the door to somebody forgetting to escape something important.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32354", "fixedVersions": [], "id": "32354", "issueType": "Bug", "key": "PDOC-42", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2018-03-05T11:42:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Make generate_properties and generate_parameters functions into erb templates", "timeSpent": "PT0S", "updated": "2018-03-05T11:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623c17d4761efb0069ce0954", "created": "2015-09-11T11:54:00.000000", "name": "4xtyped.rb", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12378" } ], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "This actually already works. This ticket should have been resolved.\n{code}\niankronquist@puppettop:(test)(master) \u2192 cat 4xtyped.rb \n# @param a [Numeric] comment\n# @param b [String] comment\n# @param s1 [String] comment\n# @param s2 [String] comment\nPuppet::Functions.create_function(:min) do\n dispatch :min do\n param 'Numeric', :a\n param 'Numeric', :b\n end\n\n dispatch :min_s do\n param 'String', :s1\n param 'String', :s2\n end\n\n def min(x,y)\n x <= y ? x : y\n end\n\n def min_s(x,y)\n cmp = (x.downcase <=> y.downcase)\n cmp <= 0 ? x : y\n end\nend\niankronquist@puppettop:(test)(master) \u2192 ppuppet strings 4xtyped.rb \n@param tag types do not match the code. The b parameter is declared as types [\"String\"] in the docstring, but the code specifies the types [\"'Numeric'\", nil] in file 4xtyped.rb near line 5\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 3 ( 2 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 33.33% documented\n\n{code}", "created": "2015-09-11T11:50:00.000000" }, { "author": "557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920", "body": "Cool! I marked as Ready for Test then, so QA can review", "created": "2015-09-11T12:40:00.000000" }, { "author": "557058:8872d0b6-d198-4e25-92ad-02776be82d59", "body": "The code changes that make this work appear to have been merged with Ian's PDOC-49 PR.\nI have verified that the type mismatch error is properly reported in the current Master branch of puppetlabs-strings and that the error message is not correct in the currently available version from the forge.\n\nThe module includes a unit test to verify the error message generation.\n\n", "created": "2015-09-15T00:15:00.000000" } ], "components": [], "created": "2015-08-18T12:15:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7e6dcf99" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyotdz:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "This was fixed as part of the solution for a previous issue." }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2072163463_*|*_3_*:*_1_*:*_2915431_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_300908281" } ], "description": "We'd like to have consistent warnings for classes, defined types, and puppet 4x functions. This means that we need to add parameter type checking and warnings for for puppet 4x functions which will involve extracting type information from the AST.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32563", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32563", "issueType": "Bug", "key": "PDOC-41", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-09-15T00:15:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add type checking for puppet 4x functions", "timeSpent": "PT0S", "updated": "2015-09-16T17:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Closing this ticket since it's a duplicate of one that was already opened", "created": "2015-08-18T11:13:00.000000" } ], "components": [], "created": "2015-08-18T11:10:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c38d6b3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz1pon:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_196855_*|*_6_*:*_1_*:*_0" } ], "description": "YARD is giving duplicate warnings for puppet 4x functions when there is a parameter that is documented that is not present in the source code. Ideally we'd like to only see one warning, and have warnings that are consistent with the format we see from classes and defined types as well.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32454", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32454", "issueType": "Bug", "key": "PDOC-40", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Duplicate", "resolutionDate": "2015-08-18T11:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Fix parameter missing warnings for 4x functions", "timeSpent": "PT0S", "updated": "2015-08-18T11:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "623c17d4761efb0069ce0954", "created": "2015-07-10T11:24:00.000000", "name": "lookup_simple2.rb", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12390" } ], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Is this fixed by the PR merged for PDOC-38 ?", "created": "2015-09-07T06:34:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "This was not resolved by PDOC-38. I know why this is happening, but no way to fix it leaps to mind.\nMaybe this is actually desired behavior. Maybe those methods deserve their very own docstrings explaining what they do in the context of the puppet function.", "created": "2015-09-08T11:38:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Yes, that is a good way of doing it IMO (each method dispatched to becomes one \"overload\" entry of the one and only function). The entries for the methods dispatched to should be suppressed as their names are of no value (just confusing to a user). Alternatively, the same method (i.e. \"the function name\") appears multiple times (not sure what yard does then).\n\nThe stats are kind of confusing in general, since it requires an understanding of the mapping from ruby code to the puppet domain. Maybe suppress the Modules, Classes, Constants and Methods - since they are in the Ruby domain, and instead output a count for Functions, and Function Signatures. Each named function counts as 1, each dispatch counts as 1 against Function Signatures. (Thus, if all functions are single dispatch, the counts for Functions, and Function Signatures are identical).\n\nTo do this right, there needs to be validation/cross-checking of what is documented and what is actually there (like for parameters). A user may document all signatures in the main body, or may divide it per dispatch, or dispatched to method. Warnings should be issued for duplicated documentation, or for documentation of no longer present signature(s), etc.", "created": "2015-09-08T13:56:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "This is fixed in strings 0.99.0.", "created": "2016-11-04T13:10:00.000000" } ], "components": [], "created": "2015-07-10T11:25:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a4d9769" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz0z07:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_41737491929_*|*_6_*:*_1_*:*_0" } ], "description": "Yard counts helper methods and dispatch implementations as individual functions which should be documented, even though the whole puppet 4x function has been documented. Consult an example on GitHub[1]. It has also been attached.\n\n[1]: https://github.com/iankronquist/puppet-test-files/blob/master/lookup_simple2.rb\nActual value:\niankronquist@puppettop:(test)(master) \u2192 puppet strings lookup_simple2.rb\n{code}\nFiles: 1 \nModules: 0 ( 0 undocumented) \nClasses: 0 ( 0 undocumented) \nConstants: 0 ( 0 undocumented) \nMethods: 4 ( 3 undocumented) \nPuppet Classes: 0 ( 0 undocumented) \nPuppet Types: 0 ( 0 undocumented) \n 25.00% documented \n{code}\nExpected results:\n{code}\niankronquist@puppettop:(test)(master) \u2192 puppet strings lookup_simple2.rb\nFiles: 1 \nModules: 0 ( 0 undocumented) \nClasses: 0 ( 0 undocumented) \nConstants: 0 ( 0 undocumented) \nMethods: 1 ( 0 undocumented) \nPuppet Classes: 0 ( 0 undocumented) \nPuppet Types: 0 ( 0 undocumented) \n 100.00% documented \n{code} \n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32429", "fixedVersions": [], "id": "32429", "issueType": "Bug", "key": "PDOC-39", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2016-11-04T13:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Stats misleading/meaningless for puppet 4x functions", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Merged to master at: d6c8bc5", "created": "2015-09-07T06:29:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "hasn't made it into an agent build yet", "created": "2015-09-16T13:05:00.000000" }, { "author": "557058:8872d0b6-d198-4e25-92ad-02776be82d59", "body": "[~accountid:623cffe88d8b9c0068b93ebf] I tested this, using the same test.rb text in the description and found that it is still producing the same incorrect output (indicating 2 methods documented, when there is only one). I installed from source using the master branch. I don't see a merge. ", "created": "2015-09-21T17:24:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I thought the solution was to redirect the yard output to a file so that only things related to strings appeared. I am not sure though. There is also PDOC-39 which seems very similar to this.\n", "created": "2015-09-21T17:49:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:8872d0b6-d198-4e25-92ad-02776be82d59] The commit d6c8bc5 was noted as merged, it may be part of another ticket? The stats are really not very meaningful in a puppet context (as noted in PDOC-39) and the best would be if they did not show at all and that we only showed puppet related stats.", "created": "2015-09-21T17:52:00.000000" }, { "author": "557058:8872d0b6-d198-4e25-92ad-02776be82d59", "body": "\n\n1. This bug is about duplicate warnings seen when a parameter is documented, but not used in the function, not so much that the reported counts are not useful. There is another ticket for that problem, PDOC-39 (Stats misleading/meaningless for puppet 4x functions).\n\n2. I verified that the version 0.2.0 of strings did produce a duplicate warning and that version 0.3.0 does not.\n\nHere is the file with the documented function, test.rb:\n\n{code}\n[root@xolaci1xwx4kkv0 ~]# cat test.rb\n# When given two numbers, returns the one that is larger.\n# You could have a several line description here if you wanted,\n# but I don't have much to say about this function.\n#\n# @example using two integers\n# $bigger_int = max(int_one, int_two)\n#\n# @return [Integer] the larger of the two parameters\n#\n# @param not_used [Integer] the first number to be compared\nPuppet::Functions.create_function(:max) do\n def max(num_a, num_b)\n num_a >= num_b ? num_a : num_b\n end\nend\n{code}\n\nversion 0.2.0 result:\n\n{code}\n[root@xolaci1xwx4kkv0 ~]# puppet strings test.rb\n[warn]: @param tag has unknown parameter name: not_used\n in file `test.rb' near line 11\n[warn]: @param tag has unknown parameter name: not_used\n in file `test.rb' near line 11\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 2 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 100.00% documented\ntrue\n[root@xolaci1xwx4kkv0 ~]#\n{code}\n\n\nversion 0.3.0 result:\n{code}\nroot@xolaci1xwx4kkv0 ~]# puppet strings test.rb\n[warn]: The parameter not_used is documented, but doesn't exist in\n your code, in file test.rb near line 11.\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 2 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 100.00% documented\n\n[root@xolaci1xwx4kkv0 ~]#\n{code}", "created": "2015-09-23T17:18:00.000000" } ], "components": [], "created": "2015-06-30T16:10:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@753cff21" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyoeh3:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Not Needed" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Some Puppet related constructs when interpreted by both Yard and Puppet Strings caused problems to be reported twice. Elements were also reported twice in the summary counts reported at the end." }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_280534950_*|*_1_*:*_1_*:*_4313863886_*|*_10007_*:*_1_*:*_1445338589_*|*_3_*:*_1_*:*_167491180_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_1140861133" } ], "description": "Run strings on this file, called test.rb:\n{noformat}\n# When given two numbers, returns the one that is larger.\n# You could have a several line description here if you wanted,\n# but I don't have much to say about this function.\n#\n# @example using two integers\n# $bigger_int = max(int_one, int_two)\n#\n# @return [Integer] the larger of the two parameters\n#\n# @param num_c [Integer] the first number to be compared\n# @param num_b [Integer] the second number to be compared\nPuppet::Functions.create_function(:max) do\n def max(num_a, num_b)\n num_a >= num_b ? num_a : num_b\n end\nend\n{noformat}\n\nWhen this file is run, two warnings will be issued for the same mismatched parameter (when only one should be issued) due to the nested nature of puppet functions.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32594", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32594", "issueType": "Bug", "key": "PDOC-38", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2015-09-23T17:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings Prints Duplicate parameter Warnings Twice For Puppet 4x Functions", "timeSpent": "PT0S", "updated": "2017-06-13T10:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at: 2e3821c", "created": "2015-07-13T16:52:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Oops. I validated this a couple of days ago and didn't update the ticket. Specifics are gone but using Hailee's example code, I produced the expected warning.", "created": "2015-07-22T09:57:00.000000" } ], "components": [], "created": "2015-06-24T10:54:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@258202ad" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Risk Probability Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "module authors" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "attempting document a missing/typo'd parameter name" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyongf:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Jul/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_3_*:*_82805178_*|*_1_*:*_1_*:*_16882349_*|*_10007_*:*_6_*:*_538354719_*|*_3_*:*_4_*:*_1084446599_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_2_*:*_693244920" } ], "description": "Make sure YARD will now issue a warning if the name of the parameter you documented does not match an existing parameter in the source code. For example when parsing:\n\n{noformat}# @param not_a_param [Integer] the first number to be compared\n# @param also_not_a_param [Integer] the second number to be compared\nPuppet::Functions.create_function(:max) do\n def max(num_a, num_b)\n num_a >= num_b ? num_a : num_b\n end\nend{noformat}\n\nstrings will produce the following warnings:\n{noformat}[warn]: @param tag has unknown parameter name: not_a_param\n in file `(stdin)' near line 3\n[warn]: @param tag has unknown parameter name: also_not_a_param\n in file `(stdin)' near line 3{noformat}\n\nThis is true for classes, defined types, and puppet 4x functions. The way parameters work for puppet 3x functions is a little different, so warnings like this do not make sense.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32507", "fixedVersions": [], "id": "32507", "issueType": "Bug", "key": "PDOC-37", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-07-22T09:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Warn when documented parameter name does not match source code", "timeSpent": "PT0S", "updated": "2015-07-22T09:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "This is still an issue as of strings 0.99.0. The 'setup' link in the table of contents leads to the URL file:///blah/puppetlabs-apache/doc/index.html#setup but the actual anchor is file:///blah/puppetlabs-apache/doc/index.html#label-Setup.\n\nI believe this is a bug in YARD itself, so I wrote up https://github.com/lsegal/yard/issues/1032.", "created": "2016-11-03T14:14:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "Turns out this could be a redcarpet bug. Perhaps we should evaluate some other markdown handlers (e.g. https://rubygems.org/gems/commonmarker)", "created": "2018-01-25T14:22:00.000000" } ], "components": [], "created": "2015-06-23T12:00:00.000000", "creator": "623c17d4761efb0069ce0954", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@37a19453" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-183" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykt7j:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Modules" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_43121658741_*|*_10007_*:*_1_*:*_409675973_*|*_3_*:*_1_*:*_4872577_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_43549848667_*|*_10005_*:*_1_*:*_2876" } ], "description": "Issue:\n\nSteps to reproduce:\nInstall some module, let's choose apache:\n{noformat}\n$ puppet module install puppetlabs-apache && cd apache\n{noformat}\nRun strings:\n{noformat}\n$ puppet strings\n{noformat}\nOpen the file doc/index.html with your favorite browser. Click on the first link in the table of contents, \"Overview - What is the apache module?\". Observe that nothing happens. The URL should be something like:\n{noformat}\nfile:///.../etc/code/modules/apache/doc/index.html#overview\n{noformat}\n\nTo see the expected behavior, change the URL to:\n{noformat}\nfile:///.../etc/code/modules/apache/doc/index.html#Overview\n{noformat}\nThat's a capital O in overview.\n\nTo fix:\nadd an id to the Overview h2 element. This may be a bug in yard.\nNote that the links in \"Class list\" work.", "epicLinkSummary": "Puppet Strings 2.0.0", "estimate": "PT0S", "externalId": "32419", "fixedVersions": [], "id": "32419", "issueType": "Bug", "key": "PDOC-36", "labels": [], "originalEstimate": "PT0S", "parent": "32609", "parentSummary": "Puppet Strings 2.0.0", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623c17d4761efb0069ce0954", "resolution": "Fixed", "resolutionDate": "2018-03-27T10:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Generated document internal links don't always work", "timeSpent": "PT0S", "updated": "2018-03-27T10:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c14e0b75ca8007056d418", "body": "Validated on redhat-6-x86_64 with puppet-strings SHA: 782fee5d0be9585aa58e5c3d69377f9ca2726a11\n\n{code}\n1) Clone puppet-strings to local machine\ngit clone https://github.com/puppetlabs/puppetlabs-strings.git\n2) Build and install puppet-strings\n[root@x7dmn8uep2jaty0 ~]# cd puppetlabs-strings/\n[root@x7dmn8uep2jaty0 puppetlabs-strings]# puppet module build\nNotice: Building /root/puppetlabs-strings for release\nModule built: /root/puppetlabs-strings/pkg/puppetlabs-strings-0.2.0.tar.gz\n[root@x7dmn8uep2jaty0 puppetlabs-strings]# puppet module install /root/puppetlabs-strings/pkg/puppetlabs-strings-0.2.0.tar.gz\nNotice: Preparing to install into /etc/puppetlabs/code/environments/production/modules ...\nNotice: Downloading from https://forgeapi.puppetlabs.com ...\nNotice: Installing -- do not interrupt ...\n/etc/puppetlabs/code/environments/production/modules\n\u2514\u2500\u2500 puppetlabs-strings (v0.2.0)\n\n3) Install yard\n[root@x7dmn8uep2jaty0 puppetlabs-strings]# puppet resource package yard provider=puppet_gem\nNotice: /Package[yard]/ensure: created\npackage { 'yard':\n ensure => ['0.8.7.6'],\n}\n\n4) Create Types and Providers\n[root@x7dmn8uep2jaty0 foo]# pwd\n/etc/puppetlabs/code/environments/production/modules/foo\n[root@x7dmn8uep2jaty0 foo]# tree\n.\n\u2514\u2500\u2500 lib\n \u2514\u2500\u2500 puppet\n \u251c\u2500\u2500 provider\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 book\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 amazon.rb\n \u2514\u2500\u2500 type\n \u2514\u2500\u2500 book.rb\n[root@x7dmn8uep2jaty0 foo]# cat lib/puppet/type/book.rb\nPuppet::Type.newtype(:book) do\n @doc = \"Get a book from somewhere\"\n feature :draw, \"The ability to draw.\"\n\n ensurable\n\n newparam(:name) do\n isnamevar\n desc \"The name of the book\"\n end\n newparam(:color) do\n desc \"Your color\"\n newvalues(:red, :green, :blue, :purple)\n end\n\n newproperty(:enable) do\n newvalue(:true)\n newvalue(:false)\n end\n newproperty(:covertype) do\n desc \"Specify hardcover or paperback\"\n defaultto \"paperback\"\n end\nend\n\n[root@x7dmn8uep2jaty0 foo]# cat lib/puppet/provider/book/amazon.rb\nPuppet::Type.type(:book).provide(:amazon, :parent => Puppet::Provider) do\n desc \"Buy from Amazon\"\n mk_resource_methods\n\n confine :operatingsystem => :RedHat\n defaultfor :operatingsystem => :RedHat\n has_feature :draw\n commands :echo => \"/bin/echo\"\n\n def initialize(value={})\n super(value)\n @property_flush = {}\n end\n\n def create\n @property_flush[:ensure] = :present\n end\n def destroy\n @property_flush[:ensure] = :absent\n end\n def exists?\n @property_hash[:ensure] == :present\n end\n def self.instances\n puts ( \"checking instances\")\n instances = []\n instances << new(:name => 'Alchemist', :ensure => 'present', :covertype => 'Hardcover')\n instances\n end\nend\n\n[root@x7dmn8uep2jaty0 foo]# puppet resource book\nchecking instances\nbook { 'Alchemist':\n ensure => 'absent',\n\n5) Run puppet strings from module root\n[root@x7dmn8uep2jaty0 foo]# puppet strings\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 1 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented\n}\n\n[root@x7dmn8uep2jaty0 foo]# cat doc/book.html\n\n...\n

        \n Puppet Type: book\n

        \n
        \n\n
        \n
        Defined in:
        \n
        lib/puppet/type/book.rb
        \n\n
        \n
        \n\n

        Overview

        \n
        \n

        \n

        Get a book from somewhere

        \n

        \n
        \n
        \n
        \n
        \n

        Parameter Summary

        \n
        \n
          \n
        • name (Parameter) (Namevar) -

          \n

          The name of the book

          \n

        • color (Parameter) -

          \n

          Your color

          \n

          Allowed Values:
          • :red
          • :green
          • :blue
          • :purple
        • covertype (Property) Default value: \"paperback\" -

          \n

          Specify hardcover or paperback

          \n

        • enable (Property) Allowed Values:
          • :true
          • :false
          • \n
        \n
        \n

        Features

        \n
        \n
          \n
        • draw -

          The ability to draw.

        • draw -

          The ability to draw.

          • \n
        \n
        \n

        Available Providers

        \n\n
        \n \n
        \n\n\n\n[root@x7dmn8uep2jaty0 foo]# cat doc/amazon.html\n...\n\n
        \n \n\n \n\n
        \n

        \n Puppet Provider: amazon\n

        \n
        \n\n
        \n
        Defined in:
        \n
        lib/puppet/provider/book/amazon.rb
        \n\n
        \n
        \n\n

        Overview

        \n
        \n

        \n

        Buy from Amazon

        \n

        \n
        \n
        \n
        \n\n\n\n
        \n

        Commands Summary

        \n
        \n
          \n\n
        • echo
          • \n\n
        \n
        \n

        Confines

        \n\n
        \n
          \n\n
        • operatingsystem - :RedHat
          • \n\n
        \n
        \n\n

        Defaults

        \n\n
        \n
          \n
        • operatingsystem - :RedHat
          • \n\n
        \n
        \n\n

        Features

        \n\n
        \n
          \n\n
        • :draw
          • \n\n
        \n
        \n\n
        \n\n[root@x7dmn8uep2jaty0 foo]# cat doc/puppet_type_list.html\n...\n
          \n
        • bookTop Level Namespace
          • \n
        \n\n[root@x7dmn8uep2jaty0 foo]# cat doc/puppet_provider_list.html\n
          \n
        • amazonTop Level Namespace
          • \n
        \n{code}\n\n[~accountid:623c17d4761efb0069ce0954]\nJust a trivial thing. Looks like one line break is missing from the type's output html between the property and the allowed values for parameter. Rest all looks great.", "created": "2015-09-14T12:49:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "[~accountid:623c17d4761efb0069ce0954] pointed out that I missed one of the feature, the special directive `@!puppet.type.param`'in my previous testing. Found some issues with the special directive and logged PDOC-52 and PDOC-53 to track them. \n\nThis ticket can be resolved after merging the new line fix (mentioned in the previous comment) and puppet-strings README fix to change the special directive text from `@!puppet.provider.param` to '`@!puppet.type.param` in the \"### Types and Providers\" section\n", "created": "2015-09-14T17:21:00.000000" } ], "components": [], "created": "2015-06-22T15:21:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7611ec58" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyoegv:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "Bandwidth" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_59410369_*|*_1_*:*_1_*:*_3371770640_*|*_10007_*:*_2_*:*_2444735621_*|*_3_*:*_2_*:*_1013700656_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_615471350_*|*_10006_*:*_1_*:*_26769" } ], "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32428", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32428", "issueType": "New Feature", "key": "PDOC-35", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-09-17T12:06:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Support Types and Providers", "timeSpent": "PT0S", "updated": "2015-09-17T12:06:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "What's the ETA for this release? If I put this in the book, will Strings 0.3.0 be out before the book? (3-4 weeks minimum)", "created": "2015-09-18T00:11:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "The ETA of this release is next Tuesday the 22nd. If a disaster arises (hardly likely), the release will be delayed until the 29th.", "created": "2015-09-18T16:26:00.000000" }, { "author": "557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920", "body": "Jira hygiene. Closing. All tickets are resolved.", "created": "2016-06-11T08:22:00.000000" } ], "components": [], "created": "2015-06-19T16:58:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@64b1ce98" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-3" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Strings 0.3.0" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "yellow" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz0lbj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_30900298697_*|*_6_*:*_2_*:*_7010" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32593", "fixedVersions": [], "id": "32593", "issueType": "Epic", "key": "PDOC-34", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-06-11T08:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings 0.3.0 Release ", "timeSpent": "PT0S", "updated": "2016-06-22T17:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "The easiest cross platform way to do this is actually to just use puppet.", "created": "2015-07-29T13:50:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Most people don't manage their personal PCs or Macbooks on which they do development with Puppet. As you can't use \"puppet doc\" without yard, and as it won't use the yard gem in your normal gemfile people are confused. They report puppet doc as broken.\n\nThe answer is simply \"/opt/puppetlabs/puppet/bin/gem install yard\" but you need to put this somewhere people can find it. This is not intuitive.", "created": "2015-07-29T14:42:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Documentation update, resolving.", "created": "2015-07-30T14:01:00.000000" } ], "components": [], "created": "2015-05-17T16:11:00.000000", "creator": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@52a2e05" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyol9z:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jul/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_78504063_*|*_1_*:*_1_*:*_6121364586_*|*_10007_*:*_1_*:*_104814258_*|*_3_*:*_1_*:*_74233613_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_7009318" } ], "description": "{{gem install yard}} won't work on a Puppet 4 system. Document the appropriate way to install the yard gem for use as a puppet face in Puppet 4.\n\nDescribe installation process for *nix Puppet 4 and Windows.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32576", "fixedVersions": [], "id": "32576", "issueType": "Improvement", "key": "PDOC-33", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "resolution": "Fixed", "resolutionDate": "2015-07-30T14:03:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "documentation doesn't inform reader how to install yard gem in Puppet 4", "timeSpent": "PT0S", "updated": "2015-07-30T14:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623e7728761efb0069cf4730", "body": "[~accountid:557058:f1e252bd-73da-4e0e-90f7-f0aefb98d28c] Is this still active?", "created": "2015-09-24T15:00:00.000000" }, { "author": "557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920", "body": "Jira hygiene. Closing. Only ticket in the epic is closed and this doesn't represent planned work.", "created": "2016-06-11T08:22:00.000000" } ], "components": [], "created": "2015-03-31T17:49:00.000000", "creator": "557058:f1e252bd-73da-4e0e-90f7-f0aefb98d28c", "customFieldValues": [ { "fieldName": "Scrum Team/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "Language" }, { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@65eece45" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-5" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet-strings 1.0 completers" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_teal" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyqhjb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_37809146332_*|*_6_*:*_1_*:*_0" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32504", "fixedVersions": [], "id": "32504", "issueType": "Epic", "key": "PDOC-32", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:f1e252bd-73da-4e0e-90f7-f0aefb98d28c", "resolution": "Fixed", "resolutionDate": "2016-06-11T08:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "puppet-strings 1.0 completers", "timeSpent": "PT0S", "updated": "2016-06-11T08:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "This is simply not possible with a reasonable fidelity since it requires evaluating the code to produce a catalog and this is not something that the static documentation tooling provides. The result will differ based on node, ENC, etc.\n\nThe Geppetto IDE helps you with issues like these", "created": "2015-04-14T11:34:00.000000" } ], "components": [], "created": "2015-03-17T10:23:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1c277ba5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyywjz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Apr/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2423496927_*|*_6_*:*_1_*:*_0" } ], "description": "After digging through some heavy uses of the Roles and Profiles Pattern, I've realized that I would really like it if something could tell me what classes were including other classes as well as what classes are included by other classes.\n\nThis could make it a LOT easier to track down where to override variables, etc... over time.\n\nIt wouldn't have to be perfect, just correct for all instances of 'include' and 'class' in the code. I.e. I don't care if it's in an 'if' statement, I just care that it's there.", "environment": "Any", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32418", "fixedVersions": [], "id": "32418", "issueType": "Improvement", "key": "PDOC-31", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Won't Fix", "resolutionDate": "2015-04-14T11:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet Strings should tell me what classes include other classes and what classes are included by other classes.", "timeSpent": "PT0S", "updated": "2015-04-14T11:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Thanks for reporting this issue!\n\nJust curious, do you see this also when running against the 0.1.1 release on the Forge? Trying to determine if this was a bug I introduced, since I recently did a bunch of work around the HTML generation, or one that already existed.", "created": "2015-03-12T10:53:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Just kidding, I was able to reproduce it in both places. Let me look into this a little more can get back to you. Thanks again for reporting.", "created": "2015-03-12T11:14:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "It looks like there are more issues with parsing markdown lists. I'm trying to determine the scope.\nIn short, markdown like this:\n{code}\n# This is markdown\n#\n# * a list\n# * b list\n# * c list\n# * d list\n#\n{code}\nRenders like this:\n{code}\n
        \n
        \n

        This is markdown

        \n\n

        * a list\n* b list\n* c list\n* d list

        \n{code}\n\nrelevant portion of the markdown \"spec\": http://daringfireball.net/projects/markdown/syntax#list", "created": "2015-06-24T10:35:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Hmmmm... I am not sure what changed but I don't seem to be able to reproduce this anymore. Here's the HTML I'm seeing now:\n\n{code:html}

        Overview

        \n
        \n

        \n

        Paragraph.

        \n
        • \n

          List entry

          \n
        • \n

          And another list entry

          \n
        \n\n

        Heading (or anything really)

        \n
        \n

        \n
        \n
        {code}\n\nThe list seems to be getting closed off as expected now. This is running with the most recent commit on master: (SHA: 2e3821c2af4a833eb08586ff8948c7a8c951f093). I'm not sure what changed... but I'm not seeing the issue anymore.\n\n[~accountid:557058:54921db7-0271-4f8f-be78-bf68cccb06d2], would you mind seeing if this is still an issue on your end?", "created": "2015-07-15T12:25:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Whoops, my bad. I did not have my .yardopts file when I ran that. The issue appears when I add in the --markup markdown option", "created": "2015-07-15T12:27:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated on SHA:abf3b786c5c3c9ec0190a767af6abde5b76bf695\n\nSteps to reproduce:\n{code}\n1) Install yard \n$/opt/puppetlabs/puppet/bin/gem install yard\n\n2) Install puppet-strings module\n$git clone https://github.com/puppetlabs/puppetlabs-strings.git\n\n$cd /root/puppetlabs-strings\n[root@ey7vzwhgll49tjt puppetlabs-strings]# puppet module build\nNotice: Building /root/puppetlabs-strings for release\nModule built: /root/puppetlabs-strings/pkg/puppetlabs-strings-0.2.0.tar.gz\n\n[root@ey7vzwhgll49tjt puppetlabs-strings]# puppet module install /root/puppetlabs-strings/pkg/puppetlabs-strings-0.2.0.tar.gz\nNotice: Preparing to install into /etc/puppetlabs/code/environments/production/modules ...\nNotice: Downloading from https://forgeapi.puppetlabs.com ...\nNotice: Installing -- do not interrupt ...\n/etc/puppetlabs/code/environments/production/modules\n\u2514\u2500\u2500 puppetlabs-strings (v0.2.0)\n\n3) Create .yardopts file in the module's root directory\n[root@ey7vzwhgll49tjt test]# cat /etc/puppetlabs/code/modules/test/.yardopts\n--markup markdown\n\n4) Run puppet strings\n[root@ey7vzwhgll49tjt test]# pwd\n/etc/puppetlabs/code/modules/test\n\n[root@ey7vzwhgll49tjt test]# puppet strings\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 1 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 100.00% documented\ntrue\n\n[root@ey7vzwhgll49tjt modules]# cat /etc/puppetlabs/code/modules/test/manifests/test.pp\n# Paragraph.\n#\n# * List entry\n#\n# Heading (or anything really)\n# ---\nclass test {\n notify{'hello':}\n}\n\n\n# cat /etc/puppetlabs/code/modules/test/doc/test.html\n==\n

        Overview

        \n
        \n

        \n

        Paragraph.

        \n
        • \n

          List entry

          \n
        \n\n

        Heading (or anything really)

        \n

        \n
        \n
        \n
        \n\n\n==\n{code}\n\nFor the following input corresponding output was created.\n{code}\n\n[root@ey7vzwhgll49tjt modules]# cat /etc/puppetlabs/code/modules/test/manifests/test.pp\n# This is markdown\n#\n# * a list\n# * b list\n# * c list\n# * d list\nclass test {\n notify {'hello':}\n}\n\n\n# cat /etc/puppetlabs/code/modules/test/doc/test.html\n===\n

        Overview

        \n
        \n

        \n

        This is markdown

        \n
        • \n

          a list

          \n
        • \n

          b list

          \n
        • \n

          c list

          \n
        • \n

          d list

          \n
        \n

        \n
        \n
        \n===\n{code}", "created": "2015-07-27T12:54:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "This issue is marked Resolved however I see no patch, and the problem is still evident. The headers as generated by the skeleton today appear as text appended to the previous paragraph.", "created": "2015-09-07T20:52:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:c5ea6c35-c500-4334-8131-e031af9f81a4] are you testing against the most recent SHA on the master branch? Here is the patch that we believed fixed the issue:\n\nhttps://github.com/puppetlabs/puppetlabs-strings/commit/6137e94a25d18a48298c0130724441c83d9649e7\n\nBut if you're still seeing the problem with a version of strings that includes that patch then it sounds like we have some investigation to do.", "created": "2015-09-08T10:28:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Ah no. According to what I read in this issue, someone was testing with 0.2.0 which is the version I'm using. I'll pull down master tonight and compare.\n\nNote: I've been using ##markdown headers instead and they work fine with the option enabled in {{.yardopts}}. I was referring to bone-stock skeleton with bone-stock strings and setext headers.", "created": "2015-09-08T12:54:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Sorry, [~accountid:623cffe88d8b9c0068b93ebf] I dropped the ball on this. I have cloned from master as of tonight, and did see and appreciate the type checking from PDOC-21 ", "created": "2015-09-18T00:25:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "[~accountid:557058:c5ea6c35-c500-4334-8131-e031af9f81a4] I believe that markdown is enabled in .yardopts on puppet's master branch.\nhttps://github.com/puppetlabs/puppet/blob/master/lib/puppet/module_tool/skeleton/templates/generator/.yardopts#L1\n\nAs for the header formats, I just used what I was most familiar with when I updated the module skeleton. If you think that it would be better to be consistent with the skeleton's README, feel free to submit a PR.", "created": "2015-09-18T15:08:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Would love to know when {{.yardopts}} is going to hit a release. It's tagged for 4.2.1 but it's not in 4.2.2...", "created": "2015-09-18T17:33:00.000000" } ], "components": [], "created": "2015-03-06T05:57:00.000000", "creator": "557058:54921db7-0271-4f8f-be78-bf68cccb06d2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7fab553b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Probability Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "pdoc" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Risk Severity Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "eats some of the doc" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyolaf:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "More work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Mar/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_55256334_*|*_1_*:*_1_*:*_3385907655_*|*_10007_*:*_1_*:*_358702184_*|*_3_*:*_1_*:*_73701272_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_531425518_*|*_10005_*:*_1_*:*_7971637286" } ], "description": "If I have this doc at the top and run with {{--markup markdown}} in my {{.yardopts}} (as recommended by the readme):\n\n{noformat}\n# Paragraph.\n#\n# * List entry\n#\n# Heading (or anything really)\n# ---\n{noformat}\n\nThe resulting HTML looks like this\n\n{code:html}\n
        \n

        \n

        Paragraph.

        \n\n
          \n
        • List entry\nHeading (or anything really)\n---
          • \n
        \n

        \n
        \n{code}\n\nIgnoring the {{p}} tag encompassing the whole thing, the heading has been subsumed into the preceding list item. \n\nTested on latest commit (93e584524df6). Running the same content (without the # comments) through Redcarpet works fine, so maybe caused by some custom preprocessing.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32452", "fixedVersions": [], "id": "32452", "issueType": "Bug", "key": "PDOC-30", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:54921db7-0271-4f8f-be78-bf68cccb06d2", "resolution": "Fixed", "resolutionDate": "2015-07-27T12:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Markdown list item absorbs content after it", "timeSpent": "PT0S", "updated": "2015-09-18T17:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2015-03-04T14:15:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2d0ab68f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyp3k7:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8422_*|*_3_*:*_1_*:*_364890263_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_765409728" } ], "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32360", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32360", "issueType": "Task", "key": "PDOC-29", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-03-17T17:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Release Strings 0.2.0", "timeSpent": "PT0S", "updated": "2015-03-19T16:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Thanks for filing this ticket! I think releasing strings as a gem would be pretty simple, but I need to look into a little more.\n\nIf it's not too difficult I think this is something we would like to do, I'm just not sure exactly when. I'll update this ticket as decisions are made.", "created": "2015-02-23T15:08:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "Wanted to come in and vote for this.\n\n1) I don't want strings installed on my servers\n2) It's a pain in the rear to try to munge around this to get something that works at the command line\n3) Why does this need to be a face? Seems like overkill for a documentation processor", "created": "2015-07-07T10:52:00.000000" }, { "author": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "body": "{quote}\nIt also strikes me that puppet modules should not be (ab)used for exposing new puppet features that are unrelated to the catalog.\n{quote}\n\n[~accountid:557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576] interesting ... can you explain your philosophy more? there are tons of modules that install things like report processors", "created": "2015-07-13T15:44:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:623c0a337910a200718b9059] So, it may be that I'm doing something horribly, horribly, wrong, but let's suppose you're developing on two different systems, one RHEL7 and one RHEL6. Let's also suppose that you need to test everything against Ruby 1.9, 2.0, 2.1, 2.2, 1.8 and Puppet 2.7, 3.7, 4.X, whatever.... And therefore, you're using something like RVM.\n\nRight now, as far as I can tell, I have to actually load the puppet command line utility to run strings.\n\nThis gets *massively* irritating when I can't just run 'bundle' and have a command (puppet-strings?) at my fingertips. Instead, it seems that I have to figure out my module path, figure out where I stuck whatever version of Puppet this version of Strings is compatible with, get all that loaded into my path and then run '~/some/massively/long/path/to/puppet strings --modulepath=~/something/else/long/and/irritating/modules' and hope that I got everything right (which I usually don't due to multiple versions of Ruby, gemsets, conflicting versions of Puppet, whatever).\n\nIf there's some easier way to do this that doesn't involve the use of the Internet (I like building everything on my laptop on planes) ", "created": "2015-07-13T16:02:00.000000" }, { "author": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "body": "I've noticed this was in testing. So I kindly did.\n\nI ran into a crash trying to use the Rake tasks:\n\n\n{code:shell}\n$ bundle exec rake strings:generate\n/home/jan/.gem/ruby/2.0.0/gems/yard-0.8.7.6/lib/yard/code_objects/base.rb:50: warning: already initialized constant YARD::CodeObjects::CONSTANTMATCH\n/home/jan/Src/puppet-strings/lib/puppet_x/puppetlabs/strings/yard/core_ext/yard.rb:10: warning: previous definition of CONSTANTMATCH was here\nrake aborted!\nNoMethodError: undefined method `each' for nil:NilClass\n/home/jan/.gem/ruby/2.0.0/gems/yard-0.8.7.6/lib/yard/core_ext/symbol_hash.rb:65:in `update'\n/home/jan/.gem/ruby/2.0.0/gems/yard-0.8.7.6/lib/yard/core_ext/symbol_hash.rb:72:in `merge'\n/home/jan/Src/puppet-strings/lib/puppet_x/puppetlabs/strings/util.rb:18:in `generate'\n/home/jan/Src/puppet-strings/lib/puppet-strings/rake_tasks.rb:9:in `block (2 levels) in '\nTasks: TOP => strings:generate\n{code}", "created": "2016-02-01T12:22:00.000000" }, { "author": "557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920", "body": "Thanks for trying it out [~accountid:557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576]! I just tried to reproduce that with master of puppetlabs-strings (678ba735e8d62ff59339b04644fc335ba20799e8)", "created": "2016-03-01T14:19:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576] How large is the codebase that you're trying to run on? I didn't have any issues running, but you may be having weird issues on large codebases per PDOC-71. You may also be having issues depending on what version of Puppet you're using per PDOC-72. I'm not sure if there are any other breaking combinations.", "created": "2016-03-01T14:26:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I also tested building and running the gem and didn't encounter any issues, so I suspect the issue you're seeing [~accountid:557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576] is an issue with strings in general and not the gem specifically, so I'm going to resolve this ticket. However, if you'd like to provide some more details about your setup, what module you're running against, etc I'd be happy to see if I can trouble shoot the problem. It may be an existing issue or one that we need to file a new ticket for.\n\nThanks for your help!", "created": "2016-03-14T17:55:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Thanks [~accountid:623cffe88d8b9c0068b93ebf] for bringing this to completion!", "created": "2016-03-15T10:32:00.000000" } ], "components": [], "created": "2015-02-17T23:56:00.000000", "creator": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@72158ab5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz4yev:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Feb/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_3037203370_*|*_1_*:*_1_*:*_486728187_*|*_10007_*:*_1_*:*_616688160_*|*_5_*:*_1_*:*_1401126178_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_10721587460_*|*_10006_*:*_1_*:*_18894890238" } ], "description": "Document generation is done on our build server and having this puppet face available as a gem would make administration a whole lot easier. \n\nIt also strikes me that puppet modules should not be (ab)used for exposing new puppet features that are unrelated to the catalog.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32592", "fixedVersions": [ "PDOC 0.4.0" ], "id": "32592", "issueType": "Improvement", "key": "PDOC-28", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:49ceab3c-ff4b-4621-bdcc-c10cbd1c1576", "resolution": "Fixed", "resolutionDate": "2016-03-14T17:55:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Make puppet strings available as a gem", "timeSpent": "PT0S", "updated": "2016-10-06T14:14:00.000000", "votes": "2", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "[adding context]\nWhile verifying PDOC-26, which was filed as a result of PDOC-24, we came across this bug, which pre-dates Puppet strings. The specific failure occurred at SHA=d9d5ae6, but this bug predates Puppet strings, so that may not matter.\n\n{code}\n# threex.rb\nmodule Puppet::Parser::Functions\n newfunction(:threex) do |args|\n filename = args[0]\n str = args[1]\n File.open(filename, 'a') {|fd| fd.puts str }\n end\nend\n\n# puppet strings threex.rb\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler:\n[error]: in `threex.rb`:5:\n\n\t5: newfunction(:threex) do |args|\n\n[error]: NoMethodError: undefined method `map' for nil:NilClass\n[error]: Stack trace:\n\t/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb:69:in `process_parameters'\n\t/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb:7:in `block in '\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:114:in `block (2 levels) in process'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:112:in `each'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:112:in `block in process'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:111:in `each'\n\nFiles: 1\nModules: 1 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 100.00% documented\ntrue\n\n# puppet apply -e 'threex(\"/tmp/foo\", \"bar\")\nNotice: Compiled catalog for ubuntu.corp.puppetlabs.net in environment production in 0.01 seconds\nNotice: Finished catalog run in 0.01 seconds\n# cat /tmp/foo\nbar\n{code}\n", "created": "2015-02-10T21:06:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "A note for QA: It might be worthwhile to confirm that the output for 3x functions is the same before/after this change. It seemed the same to me but I did not try many permutations (obviously due to the bug you can only test 3x functions that give at least two arguments to newfunction).", "created": "2015-02-17T12:36:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "I verified this in Hailee's branch at SHA=849c731511615cb9e6b6eca83f05a774415f2825. Using the same example file, a single argument to a 3x function doesn't cause an exception:\n{code}\n# puppet strings threex.rb\nFiles: 1\nModules: 1 ( 1 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 1 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 50.00% documented\ntrue\n\n# puppet apply -e 'threex(\"foo\",\"bar\")\nNotice: Compiled catalog for fssj4fv37zulfl9.delivery.puppetlabs.net in environment production in 0.03 seconds\nNotice: /File[/etc/puppet/environments/production]/seluser: seluser changed 'unconfined_u' to 'system_u'\nNotice: Finished catalog run in 0.01 seconds\n\n# cat foo\nbar\n{code}\n", "created": "2015-02-17T16:24:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Did not detect a visible difference between the pre-fix and post-fix output for 3.x functions, so I'm calling it good. When this clears CI, it can be pulled through to Resolved.", "created": "2015-02-17T16:34:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master: 6f7a983", "created": "2015-02-17T18:38:00.000000" } ], "components": [], "created": "2015-02-10T16:44:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@20961fb7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyybhb:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Feb/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_60131910_*|*_1_*:*_1_*:*_36919_*|*_10007_*:*_2_*:*_105595359_*|*_3_*:*_2_*:*_355531060_*|*_5_*:*_1_*:*_2350551715_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_150456092" } ], "description": "The way the 3x function handler is written it expects that there are at least two arguments passed into newfunction, and when only the name is given strings with throw an exception. However it is not required to specify anything other than the function name, so the handler should be fixed so that it does not throw an exception with only one argument.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32556", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32556", "issueType": "Bug", "key": "PDOC-27", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-02-18T11:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "3x functions cause exception with less than two arguments", "timeSpent": "PT0S", "updated": "2016-05-11T17:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We had a confusion over Puppetx. It should be PuppetX, and files goes into a directory named puppet_x. For a while on master this has been wrong but is now corrected - hence the downstream failure in strings. (At least I think that is what is causing this problem).", "created": "2015-02-03T10:06:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "As Henrik described, this failure is due to the renaming of the Puppetx namespace on the master branch of puppet.\n\nA pull request has been opened to fix this issue, but merging it will break strings with versions of puppet older than 4.0. This will require us to bump the version of strings. As such, we're going to wait to merge the pull request until puppet 4 is release. In the mean time, we will be unable to test strings against the most recent version of master. It will have to be tested with a version of puppet before the pull request for PUP-3900 was merged.", "created": "2015-02-04T12:33:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "PR 25 was merged to master at d9d5ae6 - this fixes both the reported problem, as well as handling the PuppetX namespace change.", "created": "2015-02-06T17:51:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Verified at SHA=. Puppet strings doesn't fail while processing 3.x function prototypes, but it does emit an exception using the same code above (threex.rb):\n{code}\nroot@ubuntu:~# puppet strings threex.rb\n[error]: Unhandled exception in PuppetX::PuppetLabs::Strings::YARD::Handlers::Puppet3xFunctionHandler:\n[error]: in `threex.rb`:5:\n\n\t5: newfunction(:threex) do |args|\n\n[error]: NoMethodError: undefined method `map' for nil:NilClass\n[error]: Stack trace:\n\t/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb:69:in `process_parameters'\n\t/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppet_x/puppetlabs/strings/yard/handlers/puppet_3x_function_handler.rb:7:in `block in '\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:114:in `block (2 levels) in process'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:112:in `each'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:112:in `block in process'\n\t/var/lib/gems/1.9.1/gems/yard-0.8.7.6/lib/yard/handlers/processor.rb:111:in `each'\n\nFiles: 1\nModules: 1 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 100.00% documented\ntrue\n\n# puppet apply -e 'threex(\"/tmp/foo\", \"bar\")\nNotice: Compiled catalog for ubuntu.corp.puppetlabs.net in environment production in 0.01 seconds\nNotice: Finished catalog run in 0.01 seconds\nroot@ubuntu:~# cat /tmp/foo\nbar\n{code}\n\nThis bug reported in this ticket is resolved. PDOC-24 maybe not.", "created": "2015-02-10T11:39:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I just went back to the 0.1.1 release of strings and I'm seeing this exception, so it's unrelated to PDOC-24 and has been around for quite some time. I'm digging into it now, trying to figure out why I've never encountered this before with the modules I've documented.", "created": "2015-02-10T15:12:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I've tracked down the issue. The problem is that the way the 3x function handler is written it expects that at least two arguments are passed into newfunction (the name and something else like :type or :doc). The reason we haven't encountered this before is because all the 3x functions that we've used for testing have had at least two arguments.\n\nIf my understanding is correct though this bug has existed basically since strings was created, so it's not actually related to PDOC-24 or PDOC-26. I'll file a separate ticket for it.", "created": "2015-02-10T15:58:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "PDOC-27 has been filed for the 3x function bug.", "created": "2015-02-10T16:50:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Pulling through. Tested and working.", "created": "2015-02-10T21:34:00.000000" } ], "components": [], "created": "2015-02-02T16:59:00.000000", "creator": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3bbb4e88" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyy82f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Feb/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_235531828_*|*_1_*:*_1_*:*_156898758_*|*_10007_*:*_1_*:*_191707895_*|*_10009_*:*_1_*:*_38223796_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_85299124" } ], "description": "From master at SHA=f94e84467d6efba95b274eaaded4945e156a9ac6.\nGiven this file:\n{code}\n# threex.rb\nmodule Puppet::Parser::Functions\n newfunction(:threex) do |args|\n filename = args[0]\n str = args[1]\n File.open(filename, 'a') {|fd| fd.puts str }\n end\nend\n{code}\n\nPuppet strings fails with an uninitialized constant:\n{code}\n[root@kll9xtq49l9makd ~]# puppet strings threex.rb --trace\nError: uninitialized constant Puppetx\n/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppetx/puppetlabs/strings.rb:8:in `'\n/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:53:in `require'\n/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:53:in `require'\n/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppetx/puppetlabs/strings/actions.rb:1:in `'\n/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:53:in `require'\n/usr/share/rubygems/rubygems/core_ext/kernel_require.rb:53:in `require'\n/etc/puppet/environments/production/modules/puppetlabs-strings/lib/puppet/face/strings.rb:36:in `block (3 levels) in '\n/usr/share/ruby/vendor_ruby/puppet/interface/action.rb+eval[wrapper]:242:in `yardoc'\n/usr/share/ruby/vendor_ruby/puppet/application/face_base.rb:248:in `main'\n/usr/share/ruby/vendor_ruby/puppet/application.rb:352:in `run_command'\n/usr/share/ruby/vendor_ruby/puppet/application.rb:344:in `block in run'\n/usr/share/ruby/vendor_ruby/puppet/util.rb:438:in `exit_on_fail'\n/usr/share/ruby/vendor_ruby/puppet/application.rb:344:in `run'\n/usr/share/ruby/vendor_ruby/puppet/util/command_line.rb:124:in `run'\n/usr/share/ruby/vendor_ruby/puppet/util/command_line.rb:72:in `execute'\n/usr/bin/puppet:5:in `
        '\nError: Try 'puppet help strings yardoc' for usage\n{code}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32352", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32352", "issueType": "Bug", "key": "PDOC-26", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "resolution": "Fixed", "resolutionDate": "2015-02-10T21:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Puppet strings fails while processing 3.x functions", "timeSpent": "PT0S", "updated": "2016-05-11T17:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "[~accountid:557058:54921db7-0271-4f8f-be78-bf68cccb06d2], thanks so much for reporting this, I will try to look into it ASAP", "created": "2015-02-03T11:17:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I've submitted an [upstream pull request|https://github.com/lsegal/yard/pull/843] to YARD to allow us to patch the regular expressions doing the namespace matching. If this change is accepted I'll just need to make a quick change to strings and this issue should be resolved.\n\nI'm going to move this ticket to blocked until we hear back form YARD's author on how he feels about the patch. If the response time is very long, or he doesn't like the patch then I can just patch the method that is a problem. This will be a little messy as it's a private method, but it's a plausible solution. Just not the best one.", "created": "2015-03-06T11:23:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "QA Risk assessment = Medium\nProbability: medium, docs produced on all custom types and classes\nSeverity: low, docs only. annoying, but doesn't affect functionality\nTest layer prediction: unit\nCurrently, risk assessment of medium targets manual validation with possible future automation by QA", "created": "2015-03-09T09:31:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "The patch has been merged into the master branch of YARD! Leaving this in blocked for now while I inquire about the next release of the YARD gem. If it's soon we may just want to wait, but if it will be a while we'll have to find another work around.", "created": "2015-03-09T11:34:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "yard patch merged to master: 56ab5f2", "created": "2015-03-13T16:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Marking as resolved", "created": "2015-03-17T17:13:00.000000" } ], "components": [], "created": "2015-01-27T07:16:00.000000", "creator": "557058:54921db7-0271-4f8f-be78-bf68cccb06d2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@599ec762" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyp3if:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Feb/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_347409399_*|*_1_*:*_1_*:*_620419115_*|*_10007_*:*_1_*:*_16164390_*|*_3_*:*_3_*:*_1051936239_*|*_5_*:*_1_*:*_239669_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_1339614_*|*_10004_*:*_2_*:*_327521924_*|*_10006_*:*_1_*:*_1901023250" } ], "description": "If I have a class called *role::peoplesearch::app*, it appears in the manifest list dropdown as *rolerole::peoplesearch::app*. *role::peoplesearch::app:xyz* is displayed as *rolerole::peoplesearchrole::peoplesearch::app::xyz*. \n\nTested on current master (345d72b2d7).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32575", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32575", "issueType": "Bug", "key": "PDOC-25", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:54921db7-0271-4f8f-be78-bf68cccb06d2", "resolution": "Fixed", "resolutionDate": "2015-03-17T17:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Manifest list names are wrong for deeply nested classes", "timeSpent": "PT0S", "updated": "2015-03-19T16:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "merged to master at 1377132", "created": "2015-01-28T17:54:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Failed review as described in related bug PDOC-26.", "created": "2015-02-03T09:13:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "This failed review due to a change in puppet which was causing downstream failures in strings.\n\nSince the fix will break strings with versions of puppet older than 4.0, we've decided not to merge the change in just yet. As such, this and any further work on strings will need to be tested before the pull request for PUP-3900 was merged until we implement the namespace change.", "created": "2015-02-04T12:14:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "I see that the PDOC-24 change isn't going in. Could you help me parse, \"this and any further work on strings will need to be tested before the pull request for PUP-3900 was merged until we implement the namespace change,\" please?", "created": "2015-02-04T13:39:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Sure, basically the pull request for PUP-3900 updated the Puppetx namespace to PuppetX. However we are not yet ready to update strings so that is compatible with this change. As such, it will not run with any commit on the master branch of puppet since these changes have been merged in. The merge commit is [635d560|https://github.com/puppetlabs/puppet/commit/635d5600c7cbbeeb0072389ba82c9a7e77ab0b3d] so if you want to test strings you will have to check out a puppet commit before this one.\n\nAlternatively just use a tagged version of puppet or the stable branch.", "created": "2015-02-04T14:08:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "I can test against stable or a tagged version. After giving it some thought, though, I would have to say that PUP-3900 breaks (and blocks) PDOC-24. I don't think it makes sense to test strings until it catches up to the current state of the codebase.", "created": "2015-02-05T10:18:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "That's a fair point, but since the decision was not to update strings until we release puppet 4 I think not testing it until then presents a pretty serious issue. \n\nWe want to have a release of strings ready to go with puppet 4, and if we block all tickets because of the namespace change in puppet, we can't do the work that needs to be done for the release. That would mean releasing the new version of strings _after_ puppet 4, but as it stands the current version is only compatible with puppet 3 (and not puppet 4). It's a tricky situation, because we don't want to break strings for the people currently using it with puppet 3 but we need to have it compatible with puppet 4 when it is released.\n\nThe best solution I see is to finish up development on strings while testing it with an older version so that we can make the breaking namespace change at the same time puppet 4 is released. \n\nTotally happy to hear other thoughts on this though. [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] and/or [~accountid:557058:c9e9d862-990b-48eb-b4e3-2e4daf1e6920], would either of you like to weigh in on this?", "created": "2015-02-05T10:53:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Spoke with [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] and he thinks we may be able to implement a workaround to support both versions of the namespace. More on that soon.", "created": "2015-02-05T12:03:00.000000" } ], "components": [], "created": "2015-01-06T15:55:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@134849c5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyp54f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jan/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_2_*:*_67665974_*|*_1_*:*_2_*:*_28607516_*|*_10007_*:*_2_*:*_411903633_*|*_3_*:*_4_*:*_1483354169_*|*_10009_*:*_1_*:*_1870611329_*|*_5_*:*_1_*:*_1134136873_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_3_*:*_970178236_*|*_10006_*:*_1_*:*_82829052" } ], "description": "Since the completion of PDOC-17, strings now has basic templates for classes and defined types. \n\nWe've decided that having our own templates rather than inheriting functionality from YARD is preferable because it will allow us to control which tags we support and make it easier to customize the HTML in the future.\n\nAs such, it is necessary to get some basic templates written for 3x and 4x functions.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32358", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32358", "issueType": "Improvement", "key": "PDOC-24", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-03-04T13:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add basic templates for puppet functions ", "timeSpent": "PT0S", "updated": "2015-03-17T17:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623c17d4761efb0069ce0954", "body": "*NOTE this needs to be updated because the format has evolved.*\nIt was decided that strings should be able to emit our structured data model as json.\n\nStrings now creates a file at {./doc/registry_dump.json} which has almost all of the data which yard extracted from the code. This file has the following structure:\nIt is a json object which has 4 keys representing the different types of Puppet code and extension functions Strings reads. The value for each key is a list of json objects representing each puppet class, function, etc.\nHere is an example of the top level structure:\n{code}\n{\n\"defined_types\": [...],\n\"puppet_classes\": [...],\n\"puppet_functions\": [...],\n\"puppet_types\": [...],\n\"puppet_providers\": [...]\n}\n{code}\n\nEach defined type or puppet class object has the following properties and values:\n* name: A string representing the name of the defined type\n* file: The file the defined type came from. A string.\n* line: The line in the file the defined type came from. A number.\n* docstring: A string. The docstring describing our defined type.\n* signatures: A list of function signatures which may be supported by the defined type. Each function signature is a json object whose keys are the parameter names, and whose values are the types those parameters may take. This is extracted from the code itself.\n* parameters: An object whose keys are the parameter names and whose values are the parameter's types or null. This is extracted from the docstring.\n\nPuppet 4x and 3x functions are in the same list but have different shapes.\n\nPuppet 3x functions have:\n* name: A string representing the name of the defined type\n* file: The file the defined type came from. A string.\n* line: The line in the file the defined type came from. A number.\n* docstring: A string. The docstring describing our defined type.\n* puppet_version: the number 3.\n* documented_params: A object whose keys are the parameters which were\ndocumented and whose values are the types they may take, or null.\n\nPuppet 4x functions have everything 3x functions do as well as:\n* The puppet_version is the number 4, not 3 (surprise!)\n* signatures: A list of function signatures which may be supported by the defined type. Each function signature is a json object whose keys are the parameter names, and whose values are the types those parameters may take. This is extracted from the code itself.\n\nEach puppet type object has the following properties and values:\n* name: A string representing the name of the defined type\n* file: The file the defined type came from. A string.\n* line: The line in the file the defined type came from. A number.\n* docstring: A string. The docstring describing our object.\n* parameters: A list of objects with the following shape:\n\t* allowed_vales: a list of strings representing the allowed values.\n\t* default: a string or null.\n\t* desc: like the docstring\n\t* exists?: A boolean\n\t* name: the parameter name\n\t* parameter: A boolean\n\t* puppet_type: A boolean\n* properties: A list of objects with a shape very similar to parameters but also including:\n\t* namevar: A boolean.\n\t* Does not include the parameter key.\n\t* property: A boolean.\n* features: Please see the features section in the puppet provider object description.\n\nEach puppet provider object has the following properties and values:\n* name: A string representing the name of the defined type\n* file: The file the defined type came from. A string.\n* line: The line in the file the defined type came from. A number.\n* docstring: A string. The docstring describing the object.\n* commands: A list of the names of the commands available.\n* confines: An object whose keys are the confine keys and whose values are the confine values\n* defaults: Similar to above.\n* features: A list of objects representing possible features. They have the following shape:\n\t* desc: the description of the feature\n\t* methods: null or a list of the available methods as strings.\n\t* name: the feature's name.\n* type_name: The type this provider accompanies.\n", "created": "2015-09-17T11:21:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "If all of that is confusing or you want an example, please consult this gist: https://gist.github.com/iankronquist/cf2141a662bf1651bc9f", "created": "2015-09-17T12:20:00.000000" }, { "author": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "body": "I lost access to my old JIRA account when my internship ended so I can't edit the original comment.\nQA: the document describing the schema of the structure has been placed in the repo. It is in the file {./json_schema.md}.", "created": "2015-10-07T19:24:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I'm going to go ahead and test this ticket so we can get it through functional review. It's been drifting in and out of sprints for months and I'd just like to take some time and get it knocked out.", "created": "2016-03-09T16:16:00.000000" }, { "author": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "body": "[~accountid:623cffe88d8b9c0068b93ebf] Thanks! If you need any help or have any questions, let me know!", "created": "2016-03-09T18:39:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Here's the JSON schema produced for the entire puppetdb module: https://gist.github.com/HAIL9000/93dcfc091d5391385cad\n\nHere's the result of running this against a few various files in the [puppetdb module|https://forge.puppetlabs.com/puppetlabs/puppetdb]:\n\nAgainst a provider, {{lib/puppet/provider/puppetdb_conn_validator}}:\n{noformat}[root@s5lt2wrzmow34kg puppetdb_conn_validator]# bundle exec puppet strings puppet_https.rb --emit-json provider.json\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\nPuppet Providers: 1 ( 0 undocumented)\n 100.00% documented\n\n[root@s5lt2wrzmow34kg puppetdb_conn_validator]# python -m json.tool provider.json\n{\n \"defined_types\": [],\n \"puppet_classes\": [],\n \"puppet_functions\": [],\n \"puppet_providers\": [\n {\n \"commands\": [],\n \"confines\": {},\n \"defaults\": {},\n \"docstring\": \"This file contains a provider for the resource type `puppetdb_conn_validator`,\\nwhich validates the puppetdb connection by attempting an https connection.\",\n \"examples\": [],\n \"features\": [],\n \"file\": \"puppet_https.rb\",\n \"line\": 15,\n \"name\": \"puppet_https_provider\",\n \"type_name\": \"puppetdb_conn_validator\"\n }\n ],\n \"puppet_types\": []\n}{noformat}\n\nAgainst a puppet type, {{lib/puppet/type/puppetdb_conn_validator.rb}}:\n\n{noformat}[root@s5lt2wrzmow34kg type]# bundle exec puppet strings puppetdb_conn_validator.rb --emit-json type.json\nFiles: 1\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Defined Types: 0 ( 0 undocumented)\nPuppet Types: 1 ( 0 undocumented)\nPuppet Providers: 0 ( 0 undocumented)\n 100.00% documented\n\n[root@s5lt2wrzmow34kg type]# python -m json.tool type.json\n{\n \"defined_types\": [],\n \"puppet_classes\": [],\n \"puppet_functions\": [],\n \"puppet_providers\": [],\n \"puppet_types\": [\n {\n \"docstring\": \"Verify that a connection can be successfully established between a node\\nand the puppetdb server. Its primary use is as a precondition to\\nprevent configuration changes from being applied if the puppetdb\\nserver cannot be reached, but it could potentially be used for other\\npurposes such as monitoring.\",\n \"examples\": [],\n \"features\": [],\n \"file\": \"puppetdb_conn_validator.rb\",\n \"line\": 1,\n \"name\": \"puppetdb_conn_validator\",\n \"parameters\": [\n {\n \"allowed_values\": [],\n \"default\": null,\n \"docstring\": \"An arbitrary name used as the identity of the resource.\",\n \"name\": \"name\",\n \"namevar\": true\n },\n {\n \"allowed_values\": [],\n \"default\": null,\n \"docstring\": \"The DNS name or IP address of the server where puppetdb should be running.\",\n \"name\": \"puppetdb_server\",\n \"namevar\": false\n },\n {\n \"allowed_values\": [],\n \"default\": null,\n \"docstring\": \"The port that the puppetdb server should be listening on.\",\n \"name\": \"puppetdb_port\",\n \"namevar\": false\n },\n {\n \"allowed_values\": [],\n \"default\": \"true\",\n \"docstring\": \"Whether the connection will be attemped using https\",\n \"name\": \"use_ssl\",\n \"namevar\": false\n },\n {\n \"allowed_values\": [],\n \"default\": null,\n \"docstring\": \"URL to use for testing if the PuppetDB database is up\",\n \"name\": \"test_url\",\n \"namevar\": false\n },\n {\n \"allowed_values\": [],\n \"default\": \"15\",\n \"docstring\": \"The max number of seconds that the validator should wait before giving up and deciding that puppetdb is not running", "created": "2016-03-10T17:02:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "This appears to work as described! A few improvements we may want to file tickets for (but that needn't hold up this ticket):\n\n# Add some spec test that make sure we get the expected json for a given file\n# It doesn't seem to be getting the entire namespace for defined types and classes (e.g. we get mod when we should get apache:: mod)", "created": "2016-03-10T17:18:00.000000" }, { "author": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:cea1b0f5-fa7c-414b-9854-4f3e564a1f4c", "body": "[~accountid:623cffe88d8b9c0068b93ebf] Interesting. I wish I had time to address those tickets, but I'm really busy right now. Thanks for finally getting this reviewed!", "created": "2016-03-10T18:35:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "bq. Hailee Kenney Interesting. I wish I had time to address those tickets, but I'm really busy right now. Thanks for finally getting this reviewed!\n\nDon't worry about it at all! Just want to get them recored for prosperity in case this project gets picked up again. The JSON stuff we have right now is real cool so I'd like to get it into the hands of users and see what they do with it.", "created": "2016-03-10T18:43:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "We should get the tickets [~accountid:623cffe88d8b9c0068b93ebf] mentioned (before removing this ticket from Language Triage sprint).", "created": "2016-03-15T10:36:00.000000" } ], "components": [], "created": "2014-11-10T11:47:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71d78fd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz4yf3:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "4.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_2010796353_*|*_1_*:*_1_*:*_29622081134_*|*_5_*:*_1_*:*_1678969596_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_10443744862" } ], "description": "Add functionality to strings that allows us to output documentation as our own structured data model. This will involve translating YARD's Registry of code objects into our own output rather than using handlers to generate HTML", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32529", "fixedVersions": [ "PDOC 0.4.0" ], "id": "32529", "issueType": "New Feature", "key": "PDOC-23", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-03-11T11:44:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add the ability to output JSON", "timeSpent": "PT0S", "updated": "2016-10-06T14:14:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Docs will be using the newly enhanced JSON output to populate all internal documentation, so I don't think this is needed anymore.", "created": "2016-11-03T13:53:00.000000" } ], "components": [], "created": "2014-11-10T11:44:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50c5e4bd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyx43r:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_62557747383_*|*_6_*:*_1_*:*_0" } ], "description": "Since we want the docs team to be able to generate documentation using strings, figure out exactly what kind of format they would like. Rather than replacing YARD's intermediate code object model, we're going to add our own structured data model as a potential output (just like HTML or JSON)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32555", "fixedVersions": [], "id": "32555", "issueType": "Task", "key": "PDOC-22", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2016-11-03T13:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Talk to docs to figure out what our own DOM should look like", "timeSpent": "PT0S", "updated": "2017-03-01T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Merged into master in [2ceead0|https://github.com/puppetlabs/puppetlabs-strings/commit/2ceead0822d266c93a9f1f0010d3eab08f301ad0]", "created": "2015-07-15T17:36:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "There are no warnings when there is a parameter type mismatch in a defined type. Should be caused by the same issue as mentioned in PDOC-19 (works for class definitions).\n\n{code}\n[root@ey7vzwhgll49tjt foo]# cat manifests/init.pp\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n\n# @param [String] barval barvalue\ndefine foo::bar ( String $barname, Float $barval)\n {\n notify {'$barname':}\n notify {'$barval':}\n}\n[root@ey7vzwhgll49tjt foo]# puppet strings\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 2 ( 2 undocumented)\nPuppet Types: 1 ( 0 undocumented)\n 33.33% documented\ntrue\n{code}\n", "created": "2015-07-27T17:51:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Those examples would not trigger the warning - the warning is issued when you have documented the type one way, and the actual type is something else. i.e. if you do something like this:\n\n{code:puppet}\n# @param Integer a - the a param\ndefine foo(String $a) { }\n{code}\n", "created": "2015-07-28T08:47:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "\nIn the example, $barval is declared as Float and is documented as String. Shouldn't that produce a warning?\n\n{code}\n# @param [String] barval barvalue\ndefine foo::bar ( String $barname, Float $barval)\n{code}\n\nA similar documentation mismatch for class definition produces a warning.\n\n{code}\n# @param [Float] age\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n[root@ey7vzwhgll49tjt foo]# puppet strings\n[warn]: @param tag types do not match the code. The age parameter is declared as types [\"Float\"] in the docstring, but the code specifies the types [#] in file manifests/init.pp near line 2\n\n{code}", "created": "2015-07-28T11:33:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I misread. Yes you are right. The case for the user defined type is wrong - it should warn, just like the class case.\nPing [~accountid:623c17d4761efb0069ce0954]", "created": "2015-07-28T14:21:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "Addressed in GitHub PR #41. It turns out I forgot to add the logic which parses the types and attaches them to the code object in the handler.\nhttps://github.com/puppetlabs/puppetlabs-strings/pull/41", "created": "2015-07-28T15:01:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated again in SHA:b1b27a33d32c6f37152a53dad9018b9aace3f0a5 and still a warning is not created for the defined type. According to [~accountid:623c17d4761efb0069ce0954], the fix for PDOC-35 will only resolve that issue.", "created": "2015-07-31T16:02:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "I think I might be a little confused... there are no warnings for defined types? That should definitely be dealt with in this ticket. PDOC-35 is about supporting types and providers and shouldn't have an effect on defined types.", "created": "2015-07-31T16:34:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "\nThis is what I see.\n{code}\n[root@s87ruicnjxz6ps4 foo]# cat /etc/puppetlabs/code/modules/foo/manifests/init.pp\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n# @param [Integer] barval barvalue\ndefine foo::bar ( String $barname, Float $barval)\n {\n notify {'$barname':}\n notify {'$barval':}\n}\n[root@s87ruicnjxz6ps4 foo]# puppet strings\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 2 ( 2 undocumented)\nPuppet Types: 1 ( 0 undocumented)\n 33.33% documented\ntrue\n{code}", "created": "2015-07-31T16:51:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Hmmm... that doesn't seem right since you have some mismatched types there. [~accountid:623c17d4761efb0069ce0954] do you know why that's happening? ", "created": "2015-07-31T17:18:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "[~accountid:623c17d4761efb0069ce0954], [~accountid:623cffe88d8b9c0068b93ebf]\n\nThe warning is now working for both defined type and class definitions. But for class definitions each warning is printed out twice to the stdout. It will be neat if this can be restricted to once.\n{code}\n [root@gk5pj5xsk8fsogp foo]# cat /etc/puppetlabs/code/modules/foo/manifests/init.pp\n# @param [Float] ident identification\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n# @param [Integer] barname\ndefine foo::bar ( String $barname, Float $barval)\n {\n notify {'$barname':}\n notify {'$barval':}\n}\n[root@gk5pj5xsk8fsogp foo]# puppet strings\n[warn]: @param tag types do not match the code. The ident parameter is declared as types [\"Float\"] in the docstring, but the code specifies the types [#] in file manifests/init.pp near line 2\n[warn]: @param tag types do not match the code. The ident parameter is declared as types [\"Float\"] in the docstring, but the code specifies the types [#] in file manifests/init.pp near line 2\n[warn]: @param tag types do not match the code. The barname parameter is declared as types [\"Integer\"] in the docstring, but the code specifies the types [#] in file manifests/init.pp near line 9\nFiles: 2\nModules: 0 ( 0 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 0 ( 0 undocumented)\nMethods: 0 ( 0 undocumented)\nPuppet Classes: 2 ( 1 undocumented)\nPuppet Types: 1 ( 0 undocumented)\n 66.67% documented\n\n{code}\n\nNote: The resulting html seems to take the parameter type from the documented type and not from the declared type. Is that the right behavior? So if the documentation is wrong as in the above example, the resulting html has the wrong parameter type.\n{code}\n\n[root@gk5pj5xsk8fsogp doc]# cat /etc/puppetlabs/code/modules/foo/doc/foo.html\n\n
          \n
        • ident (Float) => \"Bob\"-

          identification

        • age (Integer) => 10
          • \n
        \n\n\n[root@gk5pj5xsk8fsogp doc]#cat /etc/puppetlabs/code/modules/foo/doc/foo/bar.html\n
          \n
        • barname (Integer)
        • barval (Float)
          • \n
        \n\n\n\n{code}", "created": "2015-08-10T12:54:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "1. We originally thought this had to do with yard parsing nested puppet types incorrectly and ignored it. It turns out yard is executing a block of code twice when I thought it should only be executed once. I'm not sure if this is intended behavior on Yard's part but I extracted the code from the block, put it somewhere else, and have an open PR to fix this.\n\n2. The documented type should take precedence over the actual type because it may be narrower than the actual type. This is intended behavior even though I told you the wrong thing the other day.", "created": "2015-08-12T11:35:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "risk assessment is low. no further validation at this time.\nFYI: [~accountid:623cffe88d8b9c0068b93ebf] [~accountid:623c17d4761efb0069ce0954]", "created": "2015-08-20T16:52:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "I'm very glad to see the type checking, however the output doesn't match the documented Types from Puppet documentation. Here are some examples:\n\n{code}\n[warn]: @param tag types do not match the code. The config\n parameter is declared as types [\"Hash\"] in the docstring,\n but the code specifies the types [Puppet::Pops::Types::PHashType]\n in the file manifests/user.pp near line 30.\n{code}\n\nThis definition was actually {{Hash[String,String]}}\n\n{code}\n[warn]: @param tag types do not match the code. The config\n parameter is declared as types [\"Hash\"] in the docstring,\n but the code specifies the types [Puppet::Pops::Types::PHashType]\n in the file manifests/init.pp near line 50.\n{code}\n\nThis definition was actually {{Hash[String,Optional[String]]}}\n\n{code}\n[warn]: @param tag types do not match the code. The status\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [Puppet::Pops::Types::PEnumType]\n in the file manifests/agent.pp near line 38.\n{code}\n\nThis definition was actually {{Enum[\"running\",\"stopped\"]}}\n\n\nSo I'm very glad to see this, but it may generate some confusion for users not familar with Puppet internals.", "created": "2015-09-18T00:19:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "[~accountid:557058:c5ea6c35-c500-4334-8131-e031af9f81a4] What version of puppet are you using? Can I see the source files you're testing on?\nMy guess is that the inspect method was added to Puppet types after your version of puppet was released, but I'll have to confirm this after a meeting.\n\nWith puppet 4.2.1 and the file below I'm getting:\n{code}\n[warn]: @param tag types do not match the code. The a\n parameter is declared as types [\"Hash\"] in the docstring,\n but the code specifies the types [\"'Hash[String,String]'\"]\n in the file 4xtyped.rb near line 5.\n[warn]: @param tag types do not match the code. The b\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"'Numeric'\"]\n in the file 4xtyped.rb near line 5.\n[warn]: @param tag types do not match the code. The s1\n parameter is declared as types [\"Hash\"] in the docstring,\n but the code specifies the types [\"'Hash[String,Optional[String]]'\"]\n in the file 4xtyped.rb near line 5.\n[warn]: @param tag types do not match the code. The s2\n parameter is declared as types [\"String\"] in the docstring,\n but the code specifies the types [\"'Enum[\\\"running\\\",\\\"stopped\\\"]'\"]\n in the file 4xtyped.rb near line 5\n{code}\n{code}\n# @param a [Hash] comment\n# @param b [String] comment\n# @param s1 [Hash] comment\n# @param s2 [String] comment\nPuppet::Functions.create_function(:min) do\n dispatch :min do\n param 'Hash[String,String]', :a\n param 'Numeric', :b\n end\n\n dispatch :min_s do\n param 'Hash[String,Optional[String]]', :s1\n param 'Enum[\"running\",\"stopped\"]', :s2\n end\n\n def min(x,y)\n x <= y ? x : y\n end\n\n def min_s(x,y)\n cmp = (x.downcase <=> y.downcase)\n cmp <= 0 ? x : y\n end\nend\n{code}", "created": "2015-09-18T15:22:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "I'm using Puppet 4.2.2 with Puppet Strings straight from GitHub. The definitions are pretty much exactly what I showed above.\n\nYou can see the exact code at the following places:\n* https://github.com/jorhett/puppet4-module/blob/master/manifests/user.pp#L31\n* https://github.com/jorhett/puppet4-module/blob/master/manifests/init.pp#L54\n* https://github.com/jorhett/puppet4-module/blob/master/manifests/agent.pp#L40\n\nI've fixed the definitions now, but if you pull from hash https://github.com/jorhett/puppet4-module/commit/62096a0797bf5864fd9fac70f2266f35263ee5c7 you can test with the same inputs.\n\n", "created": "2015-09-18T17:14:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "This issue only happens in Puppet code, not types and providers, which is why it initially evaded my detection. An issue has been opened, PDOC-56, and a PR is pending. Thank you for the report!", "created": "2015-09-18T17:19:00.000000" } ], "components": [], "created": "2014-11-10T11:37:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71f36c1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Risk Probability Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "pdoc" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "warn to prevent bad docs" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyogyn:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "More work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Jul/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_5_*:*_354478381_*|*_1_*:*_1_*:*_13388424199_*|*_10007_*:*_6_*:*_582922291_*|*_3_*:*_2_*:*_274854382_*|*_10009_*:*_1_*:*_118706_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_4_*:*_1753338488_*|*_10006_*:*_3_*:*_2137235295_*|*_10005_*:*_1_*:*_5975152581" } ], "description": "Warn when a parameter\u2019s documented type (\u201c@param [Type] name comment\u201d) does not match the type declared in the manifest (\u201cclass b(DifferentType $name)\u201d)", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32417", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32417", "issueType": "Improvement", "key": "PDOC-21", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-08-20T16:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Warn when documented type does not match declared type", "timeSpent": "PT0S", "updated": "2015-09-18T17:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "What is not working wrt. nested constructs?", "created": "2015-04-14T11:38:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Please attach the link to the PR.", "created": "2015-07-27T15:13:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "Sorry, still trying to get the workflow down.", "created": "2015-07-28T14:57:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Merged into master in [b1b27a3|https://github.com/puppetlabs/puppetlabs-strings/commit/b1b27a33d32c6f37152a53dad9018b9aace3f0a5]", "created": "2015-07-30T15:07:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "totally covered by unit tests including output html file parsing. resolving", "created": "2015-08-04T10:59:00.000000" } ], "components": [], "created": "2014-11-10T11:36:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3118e1e8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Unit" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyolbj:" }, { "fieldName": "Scope Change Category", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Adopted" }, { "fieldName": "Scope Change Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "More work for Ian" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Apr/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_330144002_*|*_1_*:*_1_*:*_13388529717_*|*_10007_*:*_1_*:*_268400648_*|*_3_*:*_1_*:*_617100276_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_87013978_*|*_10004_*:*_1_*:*_5975012367_*|*_10006_*:*_1_*:*_2396809851" } ], "description": "Handle nested classes and defines (\u201cclass a() { class b() {} }\u201d is a and a::b).\n\nCurrently nested classes are not properly parsed and do not appear in emitted documentation.\nThis is because classes are being handled in the wrong order. Superclasses need to be parsed before their subclasses.", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32591", "fixedVersions": [ "PDOC 0.3.0" ], "id": "32591", "issueType": "Improvement", "key": "PDOC-20", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-08-04T10:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for nested classes and defines", "timeSpent": "PT0S", "updated": "2015-08-04T10:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The class {{Puppet::Pops::Types::TypeParser}} is your friend. It can do two things:\n\n* The method {{typeparser.parse(string)}} takes a string expressing a puppet type (e.g \"Array[String[1]]\") and turn that into an instance of a type.\n* The method {{typeparser.interpret(ast)}} takes an AST model and turns into an instance of a type. It only evaluates expressions that are safe (i.e. constants/literals)\n\nBoth of these methods only accepts literal/static types (it is not possible to use variables, calls, or other expressions) and will raise an exception if an attempt is made, or if referencing something that is not a type.\n\nThus, the parse method is suitable for getting the type of what the user wrote in documentation, and the interpret method to get the type of what use wrote in the code.\n\nThere is one quirk to deal with in the future when users can define types in the puppet language - currently all types are defined in the type system itself, and if a user were to reference a type such as Car, it means Resource['car']. Later, the runtime will try to first load the type 'Car' before deciding that it must be a Resource type. (We can deal with these kinds of problems at that point though).", "created": "2015-06-25T06:26:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Merged into master in [16186ef|https://github.com/puppetlabs/puppetlabs-strings/commit/16186ef91172b79322ce270aaf0256b4352e374d]", "created": "2015-07-15T17:49:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "Notes for the future: PDOC 19 and PDOC 21 had a fair amount of overlap in terms of scope. PDOC 21 focused on building the infrastructure to compare objects and then emitting warnings on the command line if the types did not match. PDOC 19 focused on taking that type information and putting it in the generate HTML.", "created": "2015-07-21T11:50:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "[~accountid:623c17d4761efb0069ce0954]\nWhen the manifest includes a defined type as below, the parameter type is not getting reflected in the html file, instead the type is given as 'Unknown'. Is this expected ? Class definition works fine.\n\n{code}\n[root@ey7vzwhgll49tjt foo]# cat /etc/puppetlabs/code/modules/foo/manifests/init.pp\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\ndefine foo::bar ( String $barname, Float $barval )\n {\n notify {'$barname':}\n notify {'$barval':}\n}\n\n
        \n

        Parameter Summary

        \n
        \n
          \n
        • barname (Unkown)
        • barval (Unkown)
          • \n
        \n
        \n
        \n{code}\n", "created": "2015-07-27T16:25:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "That is not expected. It is supposed to include the type in the documentation, not Unknown. Don't think we ever want a type called {{Unknown}} to be output either. It is either typed, an error in the type specification, or nothing (implied Any, which we do not output unless it was explicit).", "created": "2015-07-27T16:30:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "Validated in puppet-strings SHA:e9167b11e6021abad522d0e1e5d41d8b1eeb63ed\n{code}\n\n[root@mlxbrgjzz0ujob6 foo]# cat /etc/puppetlabs/code/modules/foo/manifests/init.pp\nclass foo( String $ident = \"Bob\" , Integer $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n\ndefine foo::bar ( String $barname, Float $barval)\n {\n notify {'$barname':}\n notify {'$barval':}\n}\n[root@mlxbrgjzz0ujob6 foo]# cat /etc/puppetlabs/code/modules/foo/manifests/baz.pp\nclass foo::baz ( String $bazname = \"Portland\" , Float $bazval = 30.5, )\n{\n notify {'$bazname':}\n notify {'$bazval':}\n}\n\n[root@mlxbrgjzz0ujob6 foo]#cat /etc/puppetlabs/code/modules/foo/doc/foo.html\n\n Hostclass: foo\n\n &mdash", "created": "2015-07-29T14:16:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "[~accountid:623c17d4761efb0069ce0954] If I use a custom type like \"MyType\" in the class declaration, in the resulting html the \"T\" is getting replaced by \"t\". Not sure whether this is a valid test case.\n\n{code}\n\n[root@mlxbrgjzz0ujob6 foo]# cat manifests/init.pp\nclass foo( MyType $ident = \"Bob\" , MyInt $age = 10, )\n{\n notify {'$ident':}\n notify {'$age':}\n}\n\n[root@mlxbrgjzz0ujob6 foo]# cat /etc/puppetlabs/code/modules/foo/doc/foo.html\n <ul class=\"param\">\n <li><span class=\"name\">ident </span><span class=\"type\">(<tt>Mytype</tt>)</span><tt> => \"Bob\"</tt></li><li><span class=\"name\">age </span><span class=\"type\">(<tt>Myint</tt>)</span><tt> => 10</tt></li>\n{code}", "created": "2015-07-29T14:37:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Puppet is case independent in names except for the first letter in each segment, so it is expected that {{MyType}} becomes {{Mytype}} - both names (camel case or no camel case) is a reference to the exact same type. Idiomatic Puppet would name the type {{My_type}} if word separation was wanted.", "created": "2015-07-29T16:10:00.000000" }, { "author": "623c14e0b75ca8007056d418", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Thanks for explaining. Resolving the ticket now.", "created": "2015-07-29T16:25:00.000000" } ], "components": [], "created": "2014-11-10T11:29:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4fcf7034" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-34" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Highest Test Level", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Acceptance" }, { "fieldName": "QA Risk Probability", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Medium" }, { "fieldName": "QA Risk Probability Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "any module with defined parameter types" }, { "fieldName": "QA Risk Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Low" }, { "fieldName": "QA Risk Severity Reason", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "value": "short-cuts for users" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyola7:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jun/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_487723051_*|*_1_*:*_1_*:*_176976267_*|*_10007_*:*_1_*:*_87401451_*|*_3_*:*_5_*:*_1757000177_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_716927849_*|*_10006_*:*_5_*:*_19338577025" } ], "description": "Derive class and define parameter types (\u201c@param name comment\u201d) from the declared type in the manifest (\u201cclass b(Type $name)\u201d)", "epicLinkSummary": "Puppet Strings 0.3.0 Release ", "estimate": "PT0S", "externalId": "32554", "fixedVersions": [], "id": "32554", "issueType": "Improvement", "key": "PDOC-19", "labels": [], "originalEstimate": "PT0S", "parent": "32593", "parentSummary": "Puppet Strings 0.3.0 Release ", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-07-29T16:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Derive class and define type parameters from declared type", "timeSpent": "PT0S", "updated": "2015-07-29T16:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "created": "2015-01-15T17:18:00.000000", "name": "testthis.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/12377" } ], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Tags we want to add support for: @see, @since, @param, @example, @return, @option (stretch goal)", "created": "2014-11-10T11:04:00.000000" }, { "author": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "body": "Others that would be good to consider for eventual implementation: {{@deprecated}}, {{@todo}}, {{@note}} and maybe even {{@private}}.", "created": "2014-12-21T14:44:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Merged PR 21 at https://github.com/puppetlabs/puppetlabs-strings/commit/345d72b2d7f75b1949d9bff1e8528807f7d8051c", "created": "2015-01-06T13:49:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "For FR, it looks like I create a manifest that uses (at least) the tags below and then validate the output HTML after running through {{puppet strings _manifest_.pp}}:\n\n* {{@example}}\n* {{@param}}\n* {{@return}}\n* {{@see}}\n* {{@since}}\n", "created": "2015-01-14T08:38:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Verified in master at SHA=345d72b2d7f75b1949d9bff1e8528807f7d8051c. {{puppet strings}} handles YARD tags {{@example}}, {{@param}}, {{@return}}, {{@see}}, and {{@since}}. Using the code here:\n{code}\n# init.pp\n# This class is just to test puppet strings yardoc\n# @param person [String] Person's name\n# @param number [Float] Person's telephone number\n# @return [Integer] A testthis object\n# @example class testthis(person, number)\n# @see http://puppet.allthethingsnow.com\n# @since The beginning of time\n# === Authors\n#\n# Author Name <kurtwall@example.com>\n#\n# === Copyright\n#\n# Copyright 2015 Bond, James Bond\n#\nclass testthis( $person = 'Jenny', $number = 867.5309) { }\n{code}\n\nI get the output in the attached image.", "created": "2015-01-15T17:17:00.000000" }, { "author": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "body": "(y) Looks great!", "created": "2015-01-20T12:20:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "TestRail test case C62457", "created": "2015-01-29T16:20:00.000000" } ], "components": [], "created": "2014-10-17T18:05:00.000000", "creator": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c66d91b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hypc6f:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Nov/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_89755263_*|*_1_*:*_1_*:*_2230404919_*|*_10007_*:*_3_*:*_1045207839_*|*_3_*:*_5_*:*_3574416946_*|*_10009_*:*_1_*:*_413247896_*|*_5_*:*_2_*:*_4853531697_*|*_6_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_700359015_*|*_10006_*:*_3_*:*_136576552" } ], "description": "Puppet Strings currently doesn't do anything with YARD tags like {{@param}} that are used to document Classes or Defined Types. Tags are parsed and processed, but are not used when HTML output is generated.\n\nThe reason for this is, that the HTML template for Defined Types [is very sparse|https://github.com/puppetlabs/puppetlabs-strings/blob/0.1.0/lib/puppetx/puppetlabs/strings/yard/templates/default/definedtype/setup.rb#L3-L5] and does not include many sections in the output:\n\n{code}\ndef init\n sections :header, :box_info, :pre_docstring, T('docstring'), :parameter_details\nend\n{code}\n\n(The Class template inherits behavior from the Defined Type template)\n\nCompare this to the sections used in the [YARD template for Ruby modules|https://github.com/lsegal/yard/blob/v0.8.7.4/templates/default/module/setup.rb#L3-L11]:\n\n{code}\ndef init\n sections :header, :box_info, :pre_docstring, T('docstring'), :children,\n :constant_summary, [T('docstring')], :inherited_constants,\n :attribute_summary, [:item_summary], :inherited_attributes,\n :method_summary, [:item_summary], :inherited_methods,\n :methodmissing, [T('method_details')],\n :attribute_details, [T('method_details')],\n :method_details_list, [T('method_details')]\nend\n{code}\n\nWe need to decide which YARD tags to use for Class and Type documentation and add section(s) to the template that expose their content.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32382", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32382", "issueType": "Improvement", "key": "PDOC-17", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "resolution": "Fixed", "resolutionDate": "2015-01-20T12:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add support for YARD tags in class and defined type documentation", "timeSpent": "PT0S", "updated": "2015-03-17T17:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Yes, very much so. In particular, the current module skeleton puts out text which isn't formatted as headers. The only way I can generate proper headers is using proper markdown {{== Header}} notation rdoc-style. If I enable the {{--markup markdown}} option in {{.yardopts}} then the only thing that works is \n\n{code}\n##Header\n{code}\n\nSetext headers don't work at all -- they flow into a single long paragraph.", "created": "2015-09-07T21:35:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "Furthermore, add {{@param}} to the module skeleton as it makes the Parameter Summary significantly more useful.\n\n{code}\n# @param [Type] parameter Description of parameter\n{code}", "created": "2015-09-07T21:48:00.000000" }, { "author": "623c17d4761efb0069ce0954", "body": "[~accountid:557058:c5ea6c35-c500-4334-8131-e031af9f81a4] Your first comment really belongs in a separate bug. The Yard markdown parser is goofy, to put it politely. I may investigate replacing it with something else.\nAs for your second comment, the module skeleton provided in Puppet doesn't have any parameters by default. Maybe we should add some dummy ones and add the @param tag.", "created": "2015-09-08T11:46:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "I totally use @param in all my documentation. Look here:\n https://rawgit.com/jorhett/puppet4-module/master/doc/puppet4.html\n\nYARD took me a bit to learn, but I've come to love all the things it enables. I'm more on the \"add more of the YARD\" syntax bandwagon right now. Like @author which totally doesn't appear in the output.\n\nIn specific I think we should fix it to handle markup without a thousand {{.yardopts}} files scattered around the repository. If you want people to migrate to markdown (yay!) make it easier. Go all the way in.", "created": "2015-09-08T13:02:00.000000" }, { "author": "557058:c5ea6c35-c500-4334-8131-e031af9f81a4", "body": "FWIW fine if you do want to use something other than YARD, but please document it better as you move forward. I had to read source to figure out how to document in YARD :(\n\nAlso FWIW, I've written it up in detail in Learning Puppet 4 for O'Reilly which goes to print in a few weeks. It would be best if we can clean up the mismash and make it easy to migrate to Markdown since this book has almost 40 pages encouraging and helping people use it.", "created": "2015-09-08T13:03:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "We're creating a style guide now \\o/\nSee PDOC-186", "created": "2018-03-05T11:37:00.000000" } ], "components": [], "created": "2014-10-16T17:03:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3050957c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymtn3:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Sep/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_106774472823_*|*_6_*:*_1_*:*_0" } ], "description": "We need to figure out how we want people to document their modules and ruby extensions to work with strings. We should nail down some specifics and write them up in a place where people can reference them.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32381", "fixedVersions": [], "id": "32381", "issueType": "Task", "key": "PDOC-15", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Duplicate", "resolutionDate": "2018-03-05T11:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Nail down specifics around suggested documentation style", "timeSpent": "PT0S", "updated": "2018-03-05T11:37:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4bee866b810069e3689a", "body": "Just for clarity, I did a {{puppet parser --parser future validate}} on the manifest in question and that passes just fine.", "created": "2014-10-12T04:30:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Hey Daniele, thanks for filing this ticket! I totally got caught up working on other things last week and forgot to get around to fixing this. I've got a pull request up which should be merged soon.", "created": "2014-10-13T09:35:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Notably this issue also suggests that we could use some more test coverage around the future parser", "created": "2014-10-13T12:22:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Merged at 0a3c60a", "created": "2014-10-14T17:33:00.000000" }, { "author": "62450221ad6b7e006aa4e34c", "body": "Functional review: verified at SHA 78ba39b0:\n\nWhen running {{puppet strings}} with the future parser enabled:\n{noformat}\nroot@lze578js60y7odb:/etc/puppet/modules# puppet strings --parser future ntp\n\nFiles: 2\nModules: 1 ( 1 undocumented)\nClasses: 0 ( 0 undocumented)\nConstants: 1 ( 1 undocumented)\nMethods: 1 ( 0 undocumented)\nPuppet Classes: 0 ( 0 undocumented)\nPuppet Types: 0 ( 0 undocumented)\n 33.33% documented\ntrue\n{noformat}\n\nWhere previoiusly (SHA 1abca4705f), we would see:\n{noformat}\nroot@lze578js60y7odb:/etc/puppet/modules/puppetlabs-strings# puppet strings --parser future ntp\n\nError: uninitialized constant Puppet::Pops\nError: Try 'puppet help strings yardoc' for usage\n{noformat}\n", "created": "2014-10-24T12:00:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "TestRailed as test case C62460", "created": "2015-01-29T16:24:00.000000" } ], "components": [], "created": "2014-10-12T04:29:00.000000", "creator": "623a4bee866b810069e3689a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@788c54e5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyu4xz:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_63170413_*|*_1_*:*_1_*:*_112648603_*|*_10007_*:*_1_*:*_107195383_*|*_10009_*:*_1_*:*_780860034_*|*_5_*:*_1_*:*_0" } ], "description": "While working on a new module that uses future parser features, and specifically the Type system to annotate parameters I ran into this:\n\n{code}\n12:20:06 ~/D/g/d/p/apt (master) $ puppet strings\n[error]: Unhandled exception in Puppetx::PuppetLabs::Strings::YARD::Handlers::DefinedTypeHandler:\n[error]: in `manifests/conf.pp`:1:\n[.. snip .. ]\n[error]: ParseError: Syntax error at '}' at line 15:45\n[error]: Stack trace:\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/puppet-3.7.1/lib/puppet/pops/parser/parser_support.rb:113:in `on_error'\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/puppet-3.7.1/lib/puppet/pops/parser/lexer2.rb:285:in `scan'\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/2.1.0/racc/parser.rb:319:in `_racc_yyparse_c'\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/2.1.0/racc/parser.rb:319:in `yyparse'\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/puppet-3.7.1/lib/puppet/pops/parser/parser_support.rb:204:in `_parse'\n\t/usr/local/var/rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/puppet-3.7.1/lib/puppet/pops/parser/parser_support.rb:121:in `parse_string'\n\nError: Syntax error at '}' at line 17:3\nError: Try 'puppet help strings yardoc' for usage\n{code}\n\n\n-Now I can understand that error since it's using the current parser from what I can see. However, if I try to switch it to future parser:-\n\nWhen I use the {{--parser future}} flag it gets weirder.\n\n{code}\n12:21:42 ~/D/g/d/p/apt (master) $ puppet strings --parser future\nError: uninitialized constant Puppet::Pops\nError: Try 'puppet help strings yardoc' for usage\n{code}\n\nAccording to [~accountid:557058:aa277a93-6688-4f34-ad9d-e53477acf74b] that bug is just a {{require}} call in strings that needs to be flipped.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32349", "fixedVersions": [ "PDOC 0.1.1" ], "id": "32349", "issueType": "Bug", "key": "PDOC-14", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4bee866b810069e3689a", "resolution": "Fixed", "resolutionDate": "2014-10-24T12:00:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Doesn't work with future parser and type annotations", "timeSpent": "PT0S", "updated": "2015-01-29T16:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Since we don't have a lot of documentation around how to document manifests and functions, I'm going to use this ticket as a place to collect some examples temporarily. \n\nHere's a README template for modules:\nhttps://docs.puppetlabs.com/puppet/latest/reference/modules_documentation.html", "created": "2014-10-16T15:39:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Puppet style guide (although this says to use rdoc): \n\nhttps://docs.puppetlabs.com/guides/style_guide.html", "created": "2014-10-16T15:41:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Here's YARD's guide, this is probably a good reference for documenting Puppet extensions written in Ruby:\n\nhttp://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md", "created": "2014-10-16T15:45:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Using YARD's meta-data tags:\n\nhttp://www.rubydoc.info/gems/yard/file/docs/Tags.md", "created": "2014-10-16T15:59:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "Merged into master in [78ba39|https://github.com/puppetlabs/puppetlabs-strings/commit/78ba39b08bc0cd7463e8f2bc011b0949f6944550].", "created": "2014-10-21T10:06:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "these helped me verify the other pdoc ticket... ", "created": "2014-10-23T17:46:00.000000" } ], "components": [], "created": "2014-10-09T10:58:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@49927e18" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyu4wn:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_182462856_*|*_1_*:*_1_*:*_620560345_*|*_10007_*:*_1_*:*_77638253_*|*_3_*:*_1_*:*_335312872_*|*_10009_*:*_1_*:*_17934599_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_161655" } ], "description": "Have some examples we can point to of the desired way to document modules when using Puppet Strings.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32347", "fixedVersions": [ "PDOC 0.1.1" ], "id": "32347", "issueType": "Task", "key": "PDOC-13", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2014-10-23T17:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Put together examples of how to document modules", "timeSpent": "PT0S", "updated": "2014-10-23T17:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:11a50a90-5585-4229-994a-72322be4a7d7", "body": "CentOS 6 and RedHat 6 can use Software Collections for Ruby 1.9: http://wiki.centos.org/AdditionalResources/Repositories/SCL", "created": "2014-10-07T13:11:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "I know. Many locations still won't support it though. They're usually the same places that don't like EPEL (wonderful people).\n\nI mainly wanted to get it on the radar so that the decision could be officially recorded when people complain about it later.", "created": "2014-10-07T13:15:00.000000" }, { "author": "623a4bee866b810069e3689a", "body": "I think we shouldn't support 1.8.7 anymore for new stuff. This is a new tool, still very much in development. Yes it's supposed to replace {{doc}} in due time but I think it's perfectly acceptable at this point to tell people \"You need 1.9 to generate the documentation\".\n\nSince this doesn't necessarily need to be done on a Puppet master, heck it should probably be done on your local workstation and ship it into the {{gh-pages}} branch of your module, I see no reason why this can't be 1.9+.", "created": "2014-10-12T04:27:00.000000" }, { "author": "623a4744a95758006959fe55", "body": "If the answer is \"use the ruby193 SCL\" then shouldn't the OSS puppet packages be installing into the ruby193 SCL? :)", "created": "2014-10-14T09:05:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "+1 to Joshua's comment.\n\nThere was a thread going on about using an AIO package but that might mean a lot of people are going to have to roll their own anyway for various reasons.\n\nI'll go poke that thread and see what's going on.", "created": "2014-12-07T16:31:00.000000" }, { "author": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "body": "The {{puppet-strings}} project was initiated because the current documentation functionality for manifests provided by {{puppet doc}} will be broken when Puppet 4.0 ships. This is because {{puppet doc}} is tightly integrated with the current parser which has already been removed in the {{master}} branch that will become Puppet 4.\n\nAdditionally, Puppet 4.0 will be dropping support for Ruby 1.8.7. This situation is compounded by the fact that YARD requires building out entirely new and separate code in order to support parsing Ruby code when running under 1.8.7 (Ruby 1.8.x doesn't include the Ripper library). This means that {{puppet-strings}} would have to implement and maintain two parsers for Functions, Types, Providers, etc. Supporting and maintaining Ruby 1.8.7 in {{puppet-strings}} would require a non-trivial amount of development.\n\nGiven that the goal of this project is to support Puppet 4.0 and newer, {{puppet-strings}} will only be compatible Ruby versions supported by Puppet 4.0.", "created": "2014-12-07T21:45:00.000000" } ], "components": [], "created": "2014-10-07T12:14:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ccc84cd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hywmfr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5308299670_*|*_6_*:*_1_*:*_0" } ], "description": "Many organizations will not allow deviations from the vendor installed version of Ruby. This is still 1.8.7 in Red Hat and CentOS 6.", "environment": "Any", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32416", "fixedVersions": [], "id": "32416", "issueType": "Bug", "key": "PDOC-12", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Won't Fix", "resolutionDate": "2014-12-07T21:45:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Strings should support Ruby 1.8.7", "timeSpent": "PT0S", "updated": "2014-12-07T21:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "62450221ad6b7e006aa4e34c", "body": "Errors and warnings are now well covered at the spec level. Closing this out.", "created": "2016-11-03T13:50:00.000000" } ], "components": [], "created": "2014-10-06T16:32:00.000000", "creator": "623a4c3b4a57610068e6782b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@737c145b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hylw13:" }, { "fieldName": "Scrum Team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Language" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/16" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_769751234_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_64798167668" } ], "description": "PDOC-9 was supposed to add both a happy and a sad path case. However, it was only able to achieve a happy path case. There is still a need for a sad path system test.\n\n * install puppetlabs-string\n * generate documentation that results in an error (not a module or maybe a module with syntax errors)\n * assert that the error is reported to the user\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32415", "fixedVersions": [], "id": "32415", "issueType": "Task", "key": "PDOC-11", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4c3b4a57610068e6782b", "resolution": "Fixed", "resolutionDate": "2016-11-03T13:50:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add sad path system test", "timeSpent": "PT0S", "updated": "2017-05-31T07:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4c3b4a57610068e6782b", "body": "Merged PR 12 into master in [bf24ae2|https://github.com/puppetlabs/puppetlabs-strings/commit/bf24ae2092af76da515f2666de7f7d59269c5010].", "created": "2014-10-03T16:09:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "Merged PR 11 into master in [b07fc4|https://github.com/puppetlabs/puppetlabs-strings/commit/b07fc4a661805be669e0dd8ef6f69f5305b9dc6b]", "created": "2014-10-03T18:16:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "No need for FR. These were all documentation changes.", "created": "2014-10-03T18:17:00.000000" } ], "components": [], "created": "2014-09-24T17:01:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@737e5ae6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyw6q7:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_24683_*|*_1_*:*_1_*:*_149045439_*|*_10007_*:*_1_*:*_180924479_*|*_3_*:*_2_*:*_344464048_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_107711150" } ], "description": "Since this project is becoming more visible to the community, we should update the README to be a little bit more helpful and include some more specific details. ", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32345", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32345", "issueType": "Task", "key": "PDOC-10", "labels": [], "originalEstimate": "PT0S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2014-10-03T18:17:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Update README to be more helpful/verbose", "timeSpent": "PT0S", "updated": "2014-10-03T18:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4c3b4a57610068e6782b", "body": "Merged happy path test case into master in [67c42a|https://github.com/puppetlabs/puppetlabs-strings/commit/67c42a2f49033d589db1c6e60cc06f5fea1c14bf]", "created": "2014-10-06T16:30:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "The PR only created the happy path case. I've opened PDOC-11 to add the sad path.", "created": "2014-10-06T16:32:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "No FR. Just a new automated test.", "created": "2014-10-06T17:22:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "TestRailed as test case C62470", "created": "2015-01-29T17:05:00.000000" } ], "components": [], "created": "2014-09-04T15:02:00.000000", "creator": "623a4c3b4a57610068e6782b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4f7321f2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyw6r3:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Jan/15" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_2956736_*|*_1_*:*_1_*:*_2330046049_*|*_10007_*:*_1_*:*_18362686_*|*_3_*:*_1_*:*_415402931_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_6424353" } ], "description": "There needs to be at least on full-system test. \n\nOne test is:\n\n * install the puppetlabs-strings module (built in an earlier stage of CI)\n * install other modules that contain items to document:\n * manifests (yard markup)\n * functions (3x and 4x)\n * generate documentation for those modules\n * assert that the generated pages contain the correct information\n\nAnother test is:\n\n * install puppetlabs-string\n * generate documentation that results in an error (not a module or maybe a module with syntax errors)\n * assert that the error is reported to the user", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32590", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32590", "issueType": "Task", "key": "PDOC-9", "labels": [], "originalEstimate": "PT0S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4c3b4a57610068e6782b", "resolution": "Fixed", "resolutionDate": "2014-10-06T17:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create basic full system test", "timeSpent": "PT0S", "updated": "2015-01-29T17:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "Merged in [adae47b|https://github.com/puppetlabs/puppetlabs-strings/commit/adae47b90fd0dce48c8d00e1dad786690820d91e] to be released in 0.2.0", "created": "2014-10-14T17:29:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Dealt with in spec", "created": "2015-01-29T16:25:00.000000" } ], "components": [], "created": "2014-09-04T14:53:00.000000", "creator": "623a4c3b4a57610068e6782b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3f44f8e5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hypnpb:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_63317439_*|*_1_*:*_1_*:*_2330601252_*|*_10007_*:*_1_*:*_523085985_*|*_3_*:*_1_*:*_103408314_*|*_10009_*:*_1_*:*_7566700_*|*_5_*:*_1_*:*_13233907281_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_508385559" } ], "description": "To keep a consistent code quality there need to be some static checks using rubocop. These should run as part of the spec test suite.", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32574", "fixedVersions": [ "PDOC 0.2.0" ], "id": "32574", "issueType": "Task", "key": "PDOC-8", "labels": [], "originalEstimate": "PT0S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4c3b4a57610068e6782b", "resolution": "Fixed", "resolutionDate": "2014-10-15T13:12:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Check for code style and static problems with rubocop", "timeSpent": "PT0S", "updated": "2015-03-17T17:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a4c3b4a57610068e6782b", "body": "Merged into master in [e2e288|https://github.com/puppetlabs/puppetlabs-strings/commit/e2e2880473d7950de77e45519e43000783c07b9d].", "created": "2014-09-26T13:12:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Skipping functional review since there was no change to the source code itself", "created": "2014-10-01T10:08:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "No testing required for Travis.", "created": "2015-01-29T17:03:00.000000" } ], "components": [], "created": "2014-09-04T14:52:00.000000", "creator": "623a4c3b4a57610068e6782b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@53dd5496" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hypokv:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_420937635_*|*_1_*:*_1_*:*_1729533549_*|*_10007_*:*_1_*:*_159790659_*|*_3_*:*_1_*:*_5435120_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_86531" } ], "description": "The PRs against the project should be tested using travis to give early feedback on any problems.", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32528", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32528", "issueType": "Task", "key": "PDOC-7", "labels": [], "originalEstimate": "PT0S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4c3b4a57610068e6782b", "resolution": "Fixed", "resolutionDate": "2014-10-01T10:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Setup project to test pull requests with travis", "timeSpent": "PT0S", "updated": "2015-01-29T17:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Skipping functional review since there was no change to the source code, just a CI job added and the Gemfile updated", "created": "2014-10-01T10:06:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "No additional test necessary", "created": "2015-01-29T17:03:00.000000" } ], "components": [], "created": "2014-09-04T14:51:00.000000", "creator": "623a4c3b4a57610068e6782b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17fbea35" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyvln3:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_21437057_*|*_1_*:*_1_*:*_1123532811_*|*_10007_*:*_1_*:*_68770467_*|*_3_*:*_1_*:*_15927739_*|*_10009_*:*_1_*:*_4099157_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_589872395" } ], "description": "The project needs to have its spec tests run continuously against several versions of puppet (whatever it is supporting at the time).", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32496", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32496", "issueType": "Task", "key": "PDOC-6", "labels": [], "originalEstimate": "PT0S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623a4c3b4a57610068e6782b", "resolution": "Fixed", "resolutionDate": "2014-09-25T17:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Create jenkins job to run spec tests", "timeSpent": "PT0S", "updated": "2015-01-29T17:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeestimate": "201600", "aggregatetimeoriginalestimate": "345600", "aggregatetimespent": "57600", "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2014-09-03T14:34:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@142f1b4b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-4" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Puppet Strings Project Creation" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_blue" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hyw67j:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_24262_*|*_6_*:*_1_*:*_0_*|*_10013_*:*_1_*:*_18843908893_*|*_10006_*:*_1_*:*_412900649" } ], "description": "Since puppet strings began as a prototype, there is some work that must be done in order to promote it to long-term project status. For example, it needs tests, a build pipeline, and some of the code needs to be cleaned up.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "32357", "fixedVersions": [], "id": "32357", "issueType": "Epic", "key": "PDOC-4", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2015-04-14T11:41:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Set up puppet strings as a sustainable long-term project", "timeSpent": "PT0S", "updated": "2015-04-28T16:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeestimate": "115200", "aggregatetimeoriginalestimate": "115200", "assignee": null, "attachments": [], "comments": [ { "author": "623cffe88d8b9c0068b93ebf", "body": "Due to the size of some of these refactors, there will be more than one pull request for this ticket. ", "created": "2014-09-15T12:16:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "PR 4 merged into master in [6fb4a3|https://github.com/puppetlabs/puppetlabs-strings/commit/6fb4a39536bcc8e41e824cd357083841095f2304]", "created": "2014-09-17T11:33:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "Merged PR 7 into master in [970b60|https://github.com/puppetlabs/puppetlabs-strings/commit/970b60481fb181112e2890a7dbbc0dd451a942c5]", "created": "2014-09-30T15:59:00.000000" }, { "author": "623cffe88d8b9c0068b93ebf", "body": "Skipping functional review since this is just a refactor and there was no change in functionality", "created": "2014-10-01T10:05:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "TestRailed as test case C62469", "created": "2015-01-29T17:02:00.000000" } ], "components": [], "created": "2014-09-03T14:30:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1f407e54" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hypol3:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Sep/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "null_*:*_1_*:*_0_*|*_10008_*:*_1_*:*_65183630_*|*_1_*:*_1_*:*_251526_*|*_10007_*:*_2_*:*_274646584_*|*_3_*:*_4_*:*_814859785_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_3_*:*_1006559444" } ], "description": "Since puppet strings began as a prototype, the way some of the code is written is not very clear and could be more explicit and readable. We should spend some time going through and tidying up the code.", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT115200S", "externalId": "32589", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32589", "issueType": "Improvement", "key": "PDOC-3", "labels": [], "originalEstimate": "PT115200S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2014-10-01T10:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Refactor prototype to make code more readable", "timeSpent": "PT0S", "updated": "2015-01-29T17:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeestimate": "86400", "aggregatetimeoriginalestimate": "86400", "assignee": "623a4c3b4a57610068e6782b", "attachments": [], "comments": [ { "author": "623a4c3b4a57610068e6782b", "body": "Merged into master in [ac3bbb|https://github.com/puppetlabs/puppetlabs-strings/commit/ac3bbbd4d2f3071ed6aec3782782f9fd7e453b64]", "created": "2014-09-15T12:03:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "Skipping ready for CI and functional review since this is just adding automated test coverage.", "created": "2014-09-15T12:04:00.000000" } ], "components": [], "created": "2014-09-03T14:24:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a06422a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hytxf3:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Sep/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_36557_*|*_10007_*:*_1_*:*_482665871_*|*_3_*:*_1_*:*_540343406_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5328397" } ], "description": "In order turn puppet strings into a sustainable project, continue to improve the spec tests coverage. Specifically, add some testing around the face component which tests a puppet yardoc run from beginning to end. This will involve setting up some sample modules and ensuring that the HTML output is what we expect.", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT86400S", "externalId": "32553", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32553", "issueType": "Improvement", "key": "PDOC-2", "labels": [], "originalEstimate": "PT86400S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2014-09-15T12:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add high level spec tests", "timeSpent": "PT0S", "updated": "2015-01-29T16:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeoriginalestimate": "144000", "aggregatetimespent": "57600", "assignee": null, "attachments": [], "comments": [ { "author": "623a4c3b4a57610068e6782b", "body": "Merged into master in commit [39f4ca|https://github.com/puppetlabs/puppetlabs-strings/commit/39f4ca1d097bf379c08f1af63d85dddd1fe346c1].", "created": "2014-09-04T11:24:00.000000" }, { "author": "623a4c3b4a57610068e6782b", "body": "I'm skipping this through to resolved since there aren't any Jenkins jobs setup yet for this project (tickets are filed to create that). It also skips over function review since there isn't really any functionality, just an initial pass at getting automated test coverage.", "created": "2014-09-08T11:29:00.000000" }, { "author": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a", "body": "Covered in specs. :)", "created": "2015-01-29T16:50:00.000000" } ], "components": [], "created": "2014-08-19T11:55:00.000000", "creator": "623cffe88d8b9c0068b93ebf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@f5726bf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Epic Link", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-link", "value": "PDOC-4" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "QA Contact", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "value": "557058:5f73e620-a5f5-44a8-a863-f1e0061b987a" }, { "fieldName": "QA Status", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hypq4f:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Sep/14" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_345898404_*|*_1_*:*_1_*:*_102882_*|*_10007_*:*_1_*:*_76293763_*|*_3_*:*_1_*:*_1200343424_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_103756226" } ], "description": "Since the puppet strings feature was originally a prototype, it currently does not have any tests written. Some spec tests need to be added to ensure that the project is sustainable.\n\nhttps://github.com/puppetlabs/puppetlabs-strings", "epicLinkSummary": "Set up puppet strings as a sustainable long-term project", "estimate": "PT0S", "externalId": "32526", "fixedVersions": [ "PDOC 0.1.0" ], "id": "32526", "issueType": "Improvement", "key": "PDOC-5", "labels": [], "originalEstimate": "PT144000S", "parent": "32357", "parentSummary": "Set up puppet strings as a sustainable long-term project", "priority": "Normal", "projectDescription": null, "projectKey": "PDOC", "projectLead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "projectName": "Puppet Strings", "projectType": "software", "projectUrl": null, "reporter": "623cffe88d8b9c0068b93ebf", "resolution": "Fixed", "resolutionDate": "2014-09-08T11:29:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 9:43 AM", "summary": "Add spec tests for puppet strings", "updated": "2015-01-29T16:50:00.000000", "votes": "0", "watchers": [], "worklogs": [ { "author": "623cffe88d8b9c0068b93ebf", "startDate": "2014-08-21T10:45:00.000000", "timeSpent": "PT57600S" } ] } ], "key": "PDOC", "lead": "70121:199f31c7-67c7-42b0-b148-18ad3a391ab0", "name": "Puppet Strings", "template": "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic", "type": "software", "url": "", "versions": [ { "name": "PDOC 0.1.0", "releaseDate": "2014-10-07", "released": true }, { "name": "PDOC 0.2.0", "releaseDate": "2015-03-16", "released": true }, { "name": "PDOC 0.1.1", "releaseDate": "2014-10-21", "released": true }, { "name": "PDOC 1.0.0", "releaseDate": "", "released": false }, { "name": "PDOC 0.3.0", "releaseDate": "2015-09-21", "released": true }, { "name": "PDOC 0.3.1", "releaseDate": "2015-09-22", "released": true }, { "name": "PDOC 0.4.0", "releaseDate": "2016-03-29", "released": true }, { "name": "PDOC 0.5.0", "releaseDate": "", "released": false }, { "name": "PDOC 0.99.0", "releaseDate": "2016-10-10", "released": false }, { "name": "PDOC 0.99.1", "releaseDate": "", "released": false }, { "name": "PDOC 1.0.1", "releaseDate": "", "released": false }, { "name": "PDOC 1.1.0", "releaseDate": "", "released": false }, { "name": "PDOC 1.1.1", "releaseDate": "", "released": false }, { "name": "2.0.0", "releaseDate": "", "released": false }, { "name": "1.2.0", "releaseDate": "", "released": false }, { "name": "1.2.1", "releaseDate": "", "released": false }, { "name": "connectLA", "releaseDate": "", "released": false }, { "name": "Connect LA", "releaseDate": "2021-04-16", "released": true } ] }, { "components": [ { "description": "", "name": "bolt" }, { "description": "", "lead": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "name": "CloudProvisioner" }, { "description": "", "name": "Code Management" }, { "description": "Tasks and issues related to Code Management and associated upstreams.", "name": "Configuration Management" }, { "description": "Tasks and issues related to the Deployer (part of App Management)", "name": "Deployer" }, { "description": "", "name": "DOC" }, { "description": "Content related to \"enterprise readiness\" or scaling guides", "lead": "557058:d9fe472a-950d-429a-b103-3d6c896a6529", "name": "ER Documents" }, { "description": "", "name": "Event Inspector" }, { "description": "", "lead": "623c08e1562ab90069f8aed4", "name": "Facter" }, { "description": "", "lead": "623e74d0a2f6400069ecba48", "name": "Forge" }, { "description": "", "lead": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "name": "Geppetto" }, { "description": "", "lead": "623c08e1562ab90069f8aed4", "name": "Hiera" }, { "description": "", "name": "installer" }, { "description": "", "lead": "623c08e1562ab90069f8aed4", "name": "MCollective" }, { "description": "", "name": "Modules" }, { "description": "", "name": "Node Classifier Service" }, { "description": "", "name": "Node Classifier UI" }, { "description": "", "lead": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "name": "Openstack" }, { "description": "", "lead": "623c0f8d7910a200718b92c5", "name": "PE" }, { "description": "", "name": "Process" }, { "description": "", "name": "Puppet Client/Agent" }, { "description": "", "lead": "623c08e1562ab90069f8aed4", "name": "Puppet Language" }, { "description": "", "name": "Puppet Server" }, { "description": "", "lead": "623c08e1562ab90069f8aed4", "name": "PuppetDB" }, { "description": "", "lead": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "name": "Razor" }, { "description": "", "name": "RBAC Service" }, { "description": "", "name": "RBAC UI" }, { "description": "", "name": "Reports" }, { "description": "", "name": "requirements" }, { "description": "", "name": "Review" }, { "description": "", "name": "Style Guide & Usage" }, { "description": "", "name": "Toolchain" }, { "description": "", "name": "Upgrader" }, { "description": "", "name": "Website & IA" } ], "description": "", "externalName": "Documentation (Archived)", "issues": [ { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [], "components": [ "Puppet Server" ], "created": "2024-01-16T15:14:00.000000", "creator": "557058:489b82bf-c62a-4420-8098-ce4e437c5b74", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The documentation matches the values shipped with Puppet." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@83ce4a8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m5ox:" } ], "description": "This document [https://www.puppet.com/docs/puppet/8/server/puppet_conf_setting_diffs.html#overriding-puppet-settings-in-puppet-server|https://www.puppet.com/docs/puppet/8/server/puppet_conf_setting_diffs.html#overriding-puppet-settings-in-puppet-server|smart-link] references master-*-dir elements that are now server-*-dir elements in the puppetserver.conf for Puppet 8.", "environment": "Puppet Server 8 (open source)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63955", "fixedVersions": [], "id": "63955", "issueType": "Improvement", "key": "DOCUMENT-1434", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:489b82bf-c62a-4420-8098-ce4e437c5b74", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "16/Jan/24 3:14 PM", "summary": "Update master-code-dir et alia language to match Puppet 8 puppetserver/conf.d/puppetserver.conf", "timeSpent": "PT0S", "updated": "2024-01-16T15:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "PuppetDB" ], "created": "2024-01-16T13:33:00.000000", "creator": "5e31a586ad92310e881bc325", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@da3976f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m5op:" } ], "description": "[https://www.puppet.com/docs/puppetdb/8/configure_postgres|https://www.puppet.com/docs/puppetdb/8/configure_postgres|smart-link] \n\nThis webpage for v7/v8 (didn\u2019t look at older versions) provides some copyable shell commands that a user can past to create a PostGreSQL DB for puppetDB. In these instructions a command to modify the database precedes the command to create the database. \n\nTo fix, the line:\n\n{{createdb -E UTF8 -O postgres puppetdb}}\n\nshould appear immediately before\n\n{noformat}# For coordinating partition cleanup\npsql puppetdb -c 'grant puppetdb_read to puppetdb'{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63954", "fixedVersions": [], "id": "63954", "issueType": "Bug", "key": "DOCUMENT-1433", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5e31a586ad92310e881bc325", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "16/Jan/24 1:33 PM", "summary": "PostGreSQL config instructions ordering", "timeSpent": "PT0S", "updated": "2024-01-22T11:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [], "components": [], "created": "2023-11-14T11:07:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@289abccc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m5f5:" } ], "description": "Hi,\n\n[https://www.puppet.com/docs/puppet/8/server/install_from_packages|https://www.puppet.com/docs/puppet/8/server/install_from_packages|smart-link] lists how to install puppetserver via the various packages. Vox Pupuli adopted the puppetserver container image from Puppet/Perforce. It was formerly at [https://hub.docker.com/r/puppet/puppetserver/|https://hub.docker.com/r/puppet/puppetserver/|smart-link] and is now at [https://github.com/voxpupuli/container-puppetserver/pkgs/container/container-puppetserver|https://github.com/voxpupuli/container-puppetserver/pkgs/container/container-puppetserver|smart-link] . Can you mention the new page in the install docs?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63915", "fixedVersions": [], "id": "63915", "issueType": "Task", "key": "DOCUMENT-1432", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "14/Nov/23 11:07 AM", "summary": "Mention puppetserver containers on install page", "timeSpent": "PT0S", "updated": "2023-11-14T11:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [], "components": [], "created": "2023-10-11T08:19:00.000000", "creator": "61f00b47632452006b620370", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5d5fab3c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m5cp:" } ], "description": "Hi i have a problem with puppetserver 7 - opensource,\n\ni don\u00b4t know if this is the right project for this ticket, but there is no dedicated project for Puppetserver-Opensource.\n\nI opened up an Issue on the Community Puppetlabs Page in GitHub, but seems this portal is not really used - [https://github.com/puppetlabs/community/issues/39|https://github.com/puppetlabs/community/issues/39|smart-link] \n\nMy problem currently is that i have a puppetserver on premise with version 7 which works pretty well.\n\nI reinstalled in Azure a VM with the same puppetserver configuration, but it doesn\u00b4t that the node-definitions from \u201cmanifests/site\u201d.\n\nif i write the node-definition in \u201cmanifests/site/default.pp\u201d instead of using a dedicated file, it works, but thats not the way we used it onPremise before and our environments based on dedicated node-definitions.\n\nHas someone an idea what could cause this issue ?\n\nI tried to find it out, but currently i am out of idea \ud83d\ude1e \n\n\n\nthx in advance.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63903", "fixedVersions": [], "id": "63903", "issueType": "Bug", "key": "DOCUMENT-1431", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61f00b47632452006b620370", "status": "Open", "statusCategory": "To Do", "statuscategorychangedate": "11/Oct/23 8:19 AM", "summary": "Hi i have a problem with puppetserver-Opensource,", "timeSpent": "PT0S", "updated": "2023-10-11T08:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-08-29T14:05:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@341a2e29" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m549:" } ], "description": "Hi!\n\n[https://www.puppet.com/docs/puppet/8/ssl_regenerate_certificates#clear_regenerate_certs_on_primary_server|https://www.puppet.com/docs/puppet/8/ssl_regenerate_certificates#clear_regenerate_certs_on_primary_server|smart-link] \n\nhas some good documentation about regenerating TLS certificates. For regenerating the puppetserver certificate, the whole CA is deleted ({{sudo rm -r /etc/puppetlabs/puppet/ssl}}). Instead it would be nice to have documentation for just adding a new SAN entry to the certificate instead of killing the whole CA.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63864", "fixedVersions": [], "id": "63864", "issueType": "Task", "key": "DOCUMENT-1430", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "29/Aug/23 2:05 PM", "summary": "enhance puppet SSL cert renewal process", "timeSpent": "PT0S", "updated": "2023-08-29T15:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "We have a duplicate issue open in our Internal PUPDOC Jira project (PUPDOC-5429) and will track the change there. Closing this issue.", "created": "2023-08-08T11:29:00.000000" } ], "components": [ "DOC" ], "created": "2023-08-04T08:45:00.000000", "creator": "5caf5082c75c532928c11f7b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2816781" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m521:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Aug/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_355402054_*|*_6_*:*_1_*:*_0" } ], "description": "Please add the following paragraph to the [find_file()|https://puppet.com/docs/puppet/latest/function.html#find-file] documentation, per [puppet#9094|https://github.com/puppetlabs/puppet/pull/9094]:\n\n{quote}If this function is called from [puppet agent|https://www.puppet.com/docs/puppet/latest/man/agent.html], the check for file existence is performed on the Puppet Primary server. If called from [puppet apply,|https://www.puppet.com/docs/puppet/latest/man/apply.html] the check is performed on the local host. In both cases, the check is performed before any resources are changed, and a nil is returned if no file is found.{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63853", "fixedVersions": [], "id": "63853", "issueType": "Improvement", "key": "DOCUMENT-1429", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5caf5082c75c532928c11f7b", "resolution": "Duplicate", "resolutionDate": "2023-08-08T11:29:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "08/Aug/23 11:29 AM", "summary": "Describe limitations of the find_file() function", "timeSpent": "PT0S", "updated": "2023-08-08T11:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "Curtis reviewed the proposed text for the release notes today. Here is the agreed text:\n\n*Changed*\n\nA default setting was changed to help ensure that audit logs are encrypted before being offloaded to a remote system. This change affects users who implement the US Defense Information Systems Agency (DISA) Security Technical Implementation Guide (STIG) standard on Red Hat Enterprise Linux (RHEL) 8 operating systems. Because the default setting for STIG Control V-230478 is now true, the GNU Privacy Guard (GnuPG) utility is installed by default and the auditd service is enabled to help protect audit logs from unauthorized access.", "created": "2023-08-01T15:18:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "The text is now added to the release notes for the CEM for Linux v1.6.2 release, and the update can be viewed on the preview server:\n\n[https://docs-herrera-preview.netlify.app/docs/comply/2.x/ceml_relnotes.html#162|https://docs-herrera-preview.netlify.app/docs/comply/2.x/ceml_relnotes.html#162]\n\n\nClosing this task.", "created": "2023-08-04T13:27:00.000000" } ], "components": [], "created": "2023-07-27T10:20:00.000000", "creator": "623a434701f8660070b62e0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a8f7d09" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m509:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_702318992_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_129319" } ], "description": "Here are the notes from Curtis:\n\nJust a heads up for the new cem_linux release (whenever that is) We need to make sure that something like this is in the release notes.\n\n{noformat} 'V-230478':\n use_rsyslog_gnutls: true # Set to false to use a different encryption package. Default is set to true.{noformat}\n\n[2:48|https://perforce.slack.com/archives/D04F0TTHX2N/p1690408098985019]\n\nThis has the effect of installing the gnutls package and setting auditd to use encryption for anything transmitted to a remote system.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63845", "fixedVersions": [], "id": "63845", "issueType": "Task", "key": "DOCUMENT-1428", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a434701f8660070b62e0a", "resolution": "Fixed", "resolutionDate": "2023-08-04T13:27:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "04/Aug/23 1:27 PM", "summary": "Add note about use of 'V-230478' for RHEL8 STIG", "timeSpent": "PT0S", "updated": "2023-08-04T13:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [], "components": [], "created": "2023-07-10T13:26:00.000000", "creator": "6220db7149c90000701fd082", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@66c57e2b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4xl:" } ], "description": "In PE 2021.7.4 and 2023.2 we updated our LDAP library, \u201cUnboundID\u201d, from v5 to v6. With this the TLS requirements were increased:\n[https://docs.ldap.com/ldap-sdk/docs/release-notes.html|https://docs.ldap.com/ldap-sdk/docs/release-notes.html]\n\nWe need to add that compatibility change to our release notes. I would, in short, describe it as:\n\n{quote}Our LDAP cipher suite compatibility no longer accepts RSA and SHA-1 connections, as they are no longer considered secure.{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63830", "fixedVersions": [], "id": "63830", "issueType": "Improvement", "key": "DOCUMENT-1427", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "10/Jul/23 1:26 PM", "summary": "LDAP TLS compatibility changes missing in PE release notes", "timeSpent": "PT0S", "updated": "2023-07-18T07:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "Hi [~accountid:6422c2184b23217e558e1784] - Looks like a straightforward issue.", "created": "2023-06-30T06:35:00.000000" } ], "components": [], "created": "2023-06-29T05:18:00.000000", "creator": "61d6b1c549f19500695144fb", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@30ca9d57" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4w9:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Jun/23" } ], "description": "Hi,\n\nfrom [https://www.puppet.com/docs/pe/2021.7/rbac-api-v2-directory.html#rbac_api_v2_directory_get_ds|https://www.puppet.com/docs/pe/2021.7/rbac-api-v2-directory.html#rbac_api_v2_directory_get_ds|smart-link] : \n\n\n\n{noformat}curl 'https://$(puppet config print server):4433/rbac-api/v2/ds' -H \"X-Authentication:$(puppet-access show)\"{noformat}\n\n\n\n* the single quotes prevent the subshell from executing\n* the ca cert isn\u2019t provided\n\nThe correct example is:\n\n{noformat}curl --cacert \"$(puppet config print cacert)\" \"https://$(puppet config print server):4433/rbac-api/v2/ds\" -H \"X-Authentication:$(puppet-access show)\"{noformat}\n\n\n\nand if you want to view it nicely:\n\n{noformat}curl --cacert \"$(puppet config print cacert)\" \"https://$(puppet config print server):4433/rbac-api/v2/ds\" -H \"X-Authentication:$(puppet-access show)\" --silent | jq .{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63821", "fixedVersions": [], "id": "63821", "issueType": "Bug", "key": "DOCUMENT-1426", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61d6b1c549f19500695144fb", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "29/Jun/23 5:19 AM", "summary": "wrong curl example in PE RBAC docs", "timeSpent": "PT0S", "updated": "2023-06-30T06:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [], "components": [], "created": "2023-06-27T11:39:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@644e6eaa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4vt:" } ], "description": "[https://www.puppet.com/docs/pe/2023.2/system_configuration.html#timekeeping_and_name_resolution-web-url-requirements|https://www.puppet.com/docs/pe/2023.2/system_configuration.html#timekeeping_and_name_resolution-web-url-requirements|smart-link] \n\nCustomer has requested that cloudfront is added to the above table as if they try an download a PE tarball from the releases page using their proxy, they get the following message:\n\n{noformat}<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n<html><head>\n<title>302 Found\n\n

        Found

        \n

        The document has moved here.

        \n{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63819", "fixedVersions": [], "id": "63819", "issueType": "Improvement", "key": "DOCUMENT-1425", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "27/Jun/23 11:39 AM", "summary": "Add cloudfront to Web URLs used for deployment and management", "timeSpent": "PT0S", "updated": "2023-06-30T08:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [], "components": [], "created": "2023-06-22T09:00:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6ecc106a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o075z4:" } ], "description": "after posting in the Puppet PE slack channel someone was able to help me out with this one.\n([https://puppetcommunity.slack.com/archives/C19V5U41Z/p1687351313545619|https://puppetcommunity.slack.com/archives/C19V5U41Z/p1687351313545619|smart-link] )\n\n[https://www.puppet.com/docs/pe/2023.2/code_manager_api.html#code_mgr_post_deploys|https://www.puppet.com/docs/pe/2023.2/code_manager_api.html#code_mgr_post_deploys|smart-link] \n\nI wanted to use the API POST /v1/deploys to deploy only a repo or two instead of the entire environment.\n\nIn the docs it says:\u00a0\n\n{{modules}} - JSON object - A comma-separated or space-separated list of specific modules to deploy.\n\nwhen it should not be a JSON object but an \"Array of strings\" like other API endpoints.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63814", "fixedVersions": [], "id": "63814", "issueType": "Improvement", "key": "DOCUMENT-1424", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "22/Jun/23 9:00 AM", "summary": "Wrong data format in API description", "timeSpent": "PT0S", "updated": "2023-06-30T07:26:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "Hi [~accountid:60e4906e4134aa006931a5d6] - Looks like a simple correction.", "created": "2023-06-30T07:28:00.000000" }, { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in all versions", "created": "2023-07-11T11:08:00.000000" } ], "components": [], "created": "2023-06-15T05:32:00.000000", "creator": "61d6b1c549f19500695144fb", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@144310bb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4td:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Jun/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1302916794_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_963629801" } ], "description": "Hi,\n\n[https://www.puppet.com/docs/puppet/8/server/install_from_packages.html#java-support|https://www.puppet.com/docs/puppet/8/server/install_from_packages.html#java-support|smart-link] is the link to the puppetserver 8 documentation. It contains a table with supported Java version for Puppetserver 6 and 7, but puppetserver 8 is missing.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63805", "fixedVersions": [], "id": "63805", "issueType": "Bug", "key": "DOCUMENT-1423", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61d6b1c549f19500695144fb", "resolution": "Fixed", "resolutionDate": "2023-07-11T11:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Jul/23 11:08 AM", "summary": "puppetserver 8 is missing on puppet 8 documentation", "timeSpent": "PT0S", "updated": "2023-07-11T11:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "Hi [~accountid:60e4906e4134aa006931a5d6] - Looks pretty straightforward.", "created": "2023-06-30T07:29:00.000000" } ], "components": [ "Puppet Client/Agent" ], "created": "2023-06-09T18:56:00.000000", "creator": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7c3b02d6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4s9:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Jun/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1773131294_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_15823522" } ], "description": "The documentation of Puppet 8 settings does not show the right value for the strict parameter:\n\n[https://www.puppet.com/docs/puppet/8/configuration.html#strict|https://www.puppet.com/docs/puppet/8/configuration.html#strict]\n\n{{off - do not perform extra validation, do not report}}\n{{warning - perform extra validation, report as warning (default)}}\n{{error - perform extra validation, fail with error}}\n\nThe defaut value was changed from _warning_ to _error_ with Puppet 8, as documented in the release note:\n\n[https://www.puppet.com/docs/puppet/8/release_notes_puppet.html#enhancements_puppet_x-8-0-0-PUP-11725|https://www.puppet.com/docs/puppet/8/release_notes_puppet.html#enhancements_puppet_x-8-0-0-PUP-11725]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63801", "fixedVersions": [], "id": "63801", "issueType": "Bug", "key": "DOCUMENT-1422", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "resolution": "Fixed", "resolutionDate": "2023-06-30T11:52:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "30/Jun/23 11:52 AM", "summary": "Wrong default value for \"strict\" setting in Puppet 8 documentation", "timeSpent": "PT0S", "updated": "2023-06-30T11:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "created": "2023-05-25T04:15:00.000000", "name": "1.97.0 upgrade failure.txt", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14881" } ], "comments": [ { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "This came from [https://puppetlabs.zendesk.com/agent/tickets/51957|https://puppetlabs.zendesk.com/agent/tickets/51957] with Carnegie Mellon, engaged with Replicated at [https://github.com/replicated-collab/puppet-kots/issues/476|https://github.com/replicated-collab/puppet-kots/issues/476|smart-link] for the full context", "created": "2023-05-25T04:19:00.000000" }, { "author": "5b9a9f13497b882c77e94374", "body": "After speaking with Adam, I\u2019ve added the new step between Step 2 and Step 3. Please review here: [https://docs-herrera-preview.netlify.app/docs/pam/1.0/upgrade-pam.html#pam-offline-upgrade|https://docs-herrera-preview.netlify.app/docs/pam/1.0/upgrade-pam.html#pam-offline-upgrade]", "created": "2023-05-25T14:27:00.000000" }, { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "Looks good, happy with this Sean, thank you!", "created": "2023-05-29T11:53:00.000000" } ], "components": [], "created": "2023-05-25T04:11:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@13aad41" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4pd:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/May/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_35213256_*|*_3_*:*_1_*:*_1730546_*|*_10009_*:*_1_*:*_428244198_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_14237" } ], "description": "Recently when working on a support ticket, a customers upgrade was failing when upgrading the PAM from versions 1.91.3-> 1.97.0\n\nI\u2019ve attached their install log:\n\n[^1.97.0 upgrade failure.txt]\n\nWorking with Replicated, this was because the upgrade wasn\u2019t able to pull the kurl-utils image from DockerHub and or the embedded registry so the images had to beloaded manually from the airgapped bundle. To do so, we ran the following command:\n\n{noformat}cat tasks.sh | bash -s load-images{noformat}\n\nAfter running this, and then kicking off the upgrade again, it was able to compete successfully.\n\nCan this be added to the airgapped PAM upgrade docs at [https://www.puppet.com/docs/continuous-delivery/4.x/pam/upgrade-pam.html#pam-offline-upgrade|https://www.puppet.com/docs/continuous-delivery/4.x/pam/upgrade-pam.html#pam-offline-upgrade|smart-link] ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63785", "fixedVersions": [], "id": "63785", "issueType": "Improvement", "key": "DOCUMENT-1421", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2023-05-30T13:24:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "30/May/23 1:24 PM", "summary": "PAM airgapped image load command needs to be added to the upgrade docs", "timeSpent": "PT0S", "updated": "2023-05-30T13:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "Hi [~accountid:60e4906e4134aa006931a5d6] - Can you have a look at this issue and see what needs to be done to update the docs? Thanks!", "created": "2023-07-18T07:05:00.000000" } ], "components": [], "created": "2023-05-24T07:36:00.000000", "creator": "61d6b1c549f19500695144fb", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6db2e8e0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4p5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Jul/23" } ], "environment": "Hi!\n\nI checked [https://www.puppet.com/docs/puppet/8/configuration.html#crl-refresh-interval|https://www.puppet.com/docs/puppet/8/configuration.html#crl-refresh-interval|smart-link] and it says:\n\n{noformat}Default: ``{noformat}\n\n\n\nthe actual default is 1d. I had a slack convo with Josh about it: [https://puppetcommunity.slack.com/archives/C0W298S9G/p1684934248613509|https://puppetcommunity.slack.com/archives/C0W298S9G/p1684934248613509|smart-link] \n\n\n\ncan you please check the docs and regenerate it?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63784", "fixedVersions": [], "id": "63784", "issueType": "Bug", "key": "DOCUMENT-1420", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61d6b1c549f19500695144fb", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "24/May/23 7:36 AM", "summary": "Please regenerate Puppet 8 configuration reference", "timeSpent": "PT0S", "updated": "2023-07-18T07:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in all versions", "created": "2023-07-11T11:14:00.000000" } ], "components": [], "created": "2023-05-08T14:28:00.000000", "creator": "70121:6bf3c199-1ad6-4056-a66d-592686d71e61", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1e814c7f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4ll:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jul/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_789348886_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4728610630" } ], "description": "In the description of the \u201crequire\u201d metaparameter at [https://www.puppet.com/docs/puppet/8/metaparameter.html#require|https://www.puppet.com/docs/puppet/8/metaparameter.html#require|smart-link] it says:\n\n_Specifies one or more resources that depend on this resource_\n\nThis is exactly backwards, and appears to be a copy/paste from the \u201cbefore\u201d metaparameter. Instead, for \u201crequire\u201d it should be \u201c..one or more resources that this resource depends on.\u201d", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63766", "fixedVersions": [], "id": "63766", "issueType": "Bug", "key": "DOCUMENT-1419", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:6bf3c199-1ad6-4056-a66d-592686d71e61", "resolution": "Fixed", "resolutionDate": "2023-07-11T11:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Jul/23 11:14 AM", "summary": "\"require\" metaparameter documentation has wrong information", "timeSpent": "PT0S", "updated": "2023-07-11T11:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in all versions", "created": "2023-07-12T08:08:00.000000" } ], "components": [ "Hiera" ], "created": "2023-05-02T17:25:00.000000", "creator": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@39079d5e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4l5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jul/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1297235511_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4803732712" } ], "description": "This page [https://www.puppet.com/docs/puppet/8/hiera_merging.html#literal-function|https://www.puppet.com/docs/puppet/8/hiera_merging.html#literal-function|smart-link] says \u201cThe only legal argument for {{literal}} is a single {{%}} sign.\u201d but the given example works fine with the following FAR more readable option.\n\n{noformat}server_name_string: \"%{literal('%SERVER_NAME')}\"{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63764", "fixedVersions": [], "id": "63764", "issueType": "Bug", "key": "DOCUMENT-1418", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "resolution": "Fixed", "resolutionDate": "2023-07-12T08:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "12/Jul/23 8:08 AM", "summary": "Hiera literal function doesn't behave as described", "timeSpent": "PT0S", "updated": "2023-07-12T08:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "After working extensively with Nick Lewis on the text, we agreed on the following updated version:\n\n*Calculating load balancing*\n\nFor load balancing between the Puppet agent and the Puppet primary server, implement a load balancing algorithm that distributes traffic among compilers based on the number of open connections. Traffic is directed to the compiler with the smallest number of open connections. This strategy is known as a \u201cbalancing by least connections.\u201d\n\nFor load balancing between PCP brokers and PXP agents, a different method is used. PCP brokers run on compilers and connect to PXP agents over port 8142. PCP brokers are built on web sockets and require many persistent connections. PCP brokers depend on maintaining connectivity to the Puppet orchestrator, but if the brokers become disconnected from the orchestrator, the brokers can fail at the HTTP level while still accepting TCP connections. Follow these guidelines:\n\n* If you are using HTTP health checks, use a \"least connections\" algorithm to distribute load evenly.\n* If you are not using HTTP health checks, use a round robin or random load balancing algorithm to avoid directing all traffic to an unhealthy PCP broker. You can check connections for possible errors by using the /status/v1/simple endpoint.\n\nFor load balancing between PCP brokers and PXP agents, configure the load balancer to avoid closing long-lived connections that have little traffic. In the HAproxy module, you can set the timeout tunnel to 6m because PCP brokers disconnect inactive connections after 6 minutes. You can also configure the idle timeout in the PCP broker trapperkeeper service configuration part of your [Orchestration services settings|https://www.puppet.com/docs/pe/2021.7/configuring_puppet_orchestrator.html#pe-orchestration-settings].", "created": "2023-04-18T16:55:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "The updates are scheduled for implementation in the upcoming PE releases.", "created": "2023-04-18T17:34:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "Tim suggested a minor update in the text, which was approved by Nick Lewis. Here\u2019s the new text with one updated sentence in bold:\n\n\n\nh3. Calculating load balancing\n\nFor load balancing between the Puppet agent and the Puppet primary server, implement a load balancing algorithm that distributes traffic among compilers based on the number of open connections. Traffic is directed to the compiler with the smallest number of open connections. This strategy is known as \u201cbalancing by least connections.\u201d\n\nFor load balancing between PCP brokers and PXP agents, a different method is used. *PXP agents establish TCP connections to PCP brokers over port 8142.* PCP brokers are built on web sockets and require many persistent connections. PCP brokers depend on maintaining connectivity to the Puppet orchestrator, but if the brokers become disconnected from the orchestrator, the brokers can fail at the HTTP level while still accepting TCP connections. Follow these guidelines:\n\n* If you are using HTTP health checks, use a \"least connections\" algorithm to distribute load evenly.\n* If you are not using HTTP health checks, use a round robin or random load balancing algorithm to avoid directing all traffic to an unhealthy PCP broker. You can check connections for possible errors by using the {{/status/v1/simple}} endpoint.", "created": "2023-04-21T11:14:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] The updates were made in the 2023.0 and 2021.7.2 documentation and are scheduled for inclusion in upcoming releases, as well.", "created": "2023-04-21T11:16:00.000000" } ], "components": [], "created": "2023-04-18T16:50:00.000000", "creator": "623a434701f8660070b62e0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1c5c96a3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m4f5:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2655902_*|*_5_*:*_1_*:*_0" } ], "description": "This request was made by Tim Meusel. Here is the text:\n\nHi,\n[https://www.puppet.com/docs/pe/2021.7/installing_compilers.html#using-load-balancers-with-compilers-load_balancing_for_orchestration_scale|https://www.puppet.com/docs/pe/2021.7/installing_compilers.html#using-load-balancers-with-compilers-load_balancing_for_orchestration_scale|smart-link] is a bit unclear. Two quotes:\n\n{quote}If you're not using HTTP health checks, we recommend using a round robin or random load balancing algorithm for PXP agent{quote}\n\n{quote}Due to the diverse nature of the network communications between the agent and the primary server, we recommend that you implement a load balancing algorithm that distributes traffic between compilers based on the number of open connections. Load balancers often refer to this strategy as \"balancing by least connections.\"{quote}\n\nDoes that mean for pxp agents \"round robin\" is recommended\" and for puppet agents \"least connections\"?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "63735", "fixedVersions": [], "id": "63735", "issueType": "Improvement", "key": "DOCUMENT-1417", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a434701f8660070b62e0a", "resolution": "Fixed", "resolutionDate": "2023-04-18T17:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "18/Apr/23 5:34 PM", "summary": "loadbalancing documentation is unclear", "timeSpent": "PT0S", "updated": "2023-04-21T11:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [ "PuppetDB", "Puppet Server" ], "created": "2023-03-07T13:59:00.000000", "creator": "557058:a6463c9d-9864-433d-8fa5-2814921e3da0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@74a5b382" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0m1yx:" } ], "description": "*Problem:*\n\nThe puppetdb catalog storage removes sensitive parameters, this behavior is undocumented. \n\nSee: https://github.com/puppetlabs/puppetdb/blob/main/puppet/lib/puppet/indirector/catalog/puppetdb.rb#L71\n\n*Suggested improvement:*\n\nProbably a note on the Sensitive type page, and the page about protecting sensitive values. The current text implies that reports are protected, but not catalogs.\n\n[https://www.puppet.com/docs/puppet/7/lang_data_sensitive.html]\n\nhttps://www.puppet.com/docs/puppet/7/securing-sensitive-data.htm\n\n_Current text :_\n\n\n\n_Suggested improvement:_\n\nA note indicating that catalogs submitted to puppetdb have sensitive parameters removed, also indicating that this behavior is specific to puppetdb, and may not be present in other modes of catalog storage.\n\n*Summary:*\n\nDocumenting this behavior formalizes the expectation that these values will not appear in puppetdb, allowing that expectation to be used when planning to prevent leaks.\n\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54806", "fixedVersions": [], "id": "54806", "issueType": "Bug", "key": "DOCUMENT-1416", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a6463c9d-9864-433d-8fa5-2814921e3da0", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Puppetdb catalog redaction of sensitive values undocumented", "timeSpent": "PT0S", "updated": "2023-05-17T17:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [ "DOC", "Puppet Server" ], "created": "2023-02-28T12:21:00.000000", "creator": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@674ee81b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lzx5:" } ], "description": "In https://www.puppet.com/docs/puppet/7/server/status-api/v1/services.html the {{/status/v1/services}} API endpoint is missing important information which causes readers (or at least me) to not understand the point or utility of that API's response.\n\nThere are multiple services listed in the response of that API. For example, on a generic Puppetserver 7.9.5 install on Debian Bullseye there are 6 services:\n{noformat}\nvagrant@server7:~$ curl -s -S -k https://$(hostname -f):8140/status/v1/services | jq '. | keys'\n[\n \"ca\",\n \"jruby-metrics\",\n \"master\",\n \"puppet-profiler\",\n \"server\",\n \"status-service\"\n]\n{noformat}\n\nThe docs don't mention any of these services by name, nor do they go into detail about the point of each of these services.\n\nAs a Puppetserver administrator, I would want to know what each of these services are so that I can effectively monitor my Puppetserver fleet.\n\nWhich of these should I use to check the readiness of Puppetserver?\nWhich of these should I use to check memory usage?\nWhat do any of these actually mean?\nWhat's the difference between \"master\" and \"server\"?\n\nThere are a lot of questions left unanswered by that docs page.\n\n----\n\nAt the very least, I'd expect the docs page to contain or to link to:\n* What the service is and how it relates to the operation of Puppetserver (from the perspective of an SRE/engineer/admin).\n* What the response body of each service contains.\n\nAs a bonus, a page that shows examples of using these endpoints for common tasks an SRE/engineer/admin might need when maintaining a Puppetserver fleet.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54136", "fixedVersions": [], "id": "54136", "issueType": "Improvement", "key": "DOCUMENT-1415", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The Puppetserver /status/v1/services API docs don't explain what each service is", "timeSpent": "PT0S", "updated": "2023-05-17T17:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "I don\u2019t own the Bolt documentation, but I started to research this ticket anyway. Here\u2019s what I learned so far, mostly from a conversation with Cas Donoghue, who is a Bolt expert:\n\n* Anyone at Puppet can update the Bolt documentation by going to GitHub and updating the Markdown files.\n\n* So I shared Tim\u2019s comment with Cas:\n_Hi, functions like run_plan(), run_task(), run_command() and apply() take an array for targets. The docs at_\u00a0[https://www.puppet.com/docs/bolt/latest/plan_functions.html|https://www.puppet.com/docs/bolt/latest/plan_functions.html|smart-link] \u00a0_don't really mention if the code blocks are executed in parallel on each target or sequential. Can you maybe update that?_\n\n* Cas replied: _I'm not quite sure I understand the question.... Are they asking about concurrency for targets or for plan functions?_\n\n* Tim replied: _I think concurrency is the right term here_\n_all those functions take two things, something should be done/executed, and a list of targets where it should be done_\n_and in the docs it is not really clear how the list of targets is handled. run_command() for example. is the provided command executed on all provided targets in parallel, or is it first executed on the first target, when it finished it will be executed on the second target, and so on_\n\n* Cas replied: _Ah, I would think we cover\u00a0concurrency\u00a0in bolt somewhere. Maybe we should find that and just link to it. I hope that exists as its kind of a fundamental idea for how bolt works. He added: At a high level, whenver anything happens on a target we batch those actions according to\u00a0concurrrency_\n\n* Ingrida asked whether we can add the following statement to the top of the \u201cPlan functions\u201d topic:\n_For all plan functions, actions on the target are batched in accordance with the specified\u00a0concurrency\u00a0option. For more information about the concurrency option, see *_[_nix shell commands_|https://www.puppet.com/docs/bolt/latest/bolt_command_reference.html]_._\n\n* Cas did not approve the text and implied that it\u2019s the wrong link. He said: \n_I would imagine there is a paragraph somewhere that describes action execution on targets._\n\n* Ingrida was not able to find that paragraph but did find a descriptions of compile-concurrency and concurrency:\n[https://www.puppet.com/docs/bolt/latest/bolt_project_reference.html#compile-concurrency|https://www.puppet.com/docs/bolt/latest/bolt_project_reference.html#compile-concurrency|smart-link] \n\n* She responded to Tim and provided the bits of information that Cas provided. Tim said thanks and did not ask any further questions.\n\n* Probably, the best way to resolve this ticket is to schedule a meeting with Cas or another Bolt specialist and clarify the text to be added to the documentation.", "created": "2023-05-11T17:02:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "Question for Lisa: Because our technical writing team does not own this documentation, should we be making the update, or should we go on the #puppet-bolt Slack channel to try to find the right owner?", "created": "2023-05-17T17:51:00.000000" } ], "components": [], "created": "2023-02-24T16:05:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@761b7a2a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lz55:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/May/23" } ], "description": "Hi,\nfunctions like run_plan(), run_task(), run_command() and apply() take an array for targets. The docs at https://www.puppet.com/docs/bolt/latest/plan_functions.html don't really mention if the code blocks are executed in parallel on each target or sequential. Can you maybe update that?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54705", "fixedVersions": [], "id": "54705", "issueType": "Task", "key": "DOCUMENT-1414", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "bolt plan_run: clarify concurrency", "timeSpent": "PT0S", "updated": "2023-05-18T07:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [], "components": [], "created": "2023-02-22T11:39:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@257c3fc0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lyld:" } ], "description": "Hi,\nI was playing around with the orchestrator API to start PE plans. I noticed that https://github.com/puppetlabs/orchestrator_client-ruby/blob/master/lib/orchestrator_client/command.rb#L14 uses the plan_start endpoint. That's missing in the docs: https://www.puppet.com/docs/pe/2019.8/orchestrator_api_commands_endpoint.html\n\nI tested this and plan_start and plan_run both exist in PE 2019 (and probably in 2021/2023). Can you please add documentation for /plan_start?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54372", "fixedVersions": [], "id": "54372", "issueType": "Task", "key": "DOCUMENT-1413", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Orchestrator API: Document /command/plan_start endpoint", "timeSpent": "PT0S", "updated": "2023-05-17T17:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "I don\u2019t own the open source Puppet documentation, but I was looking at it. Based on the customer comment, maybe the Configuring Hiera topic should be updated:\n[https://www.puppet.com/docs/puppet/8/hiera_config_yaml_5.html#hiera_config_yaml_5|https://www.puppet.com/docs/puppet/8/hiera_config_yaml_5.html#hiera_config_yaml_5|smart-link] ", "created": "2023-05-09T15:47:00.000000" } ], "components": [], "created": "2023-02-16T13:17:00.000000", "creator": "70121:13e9ba64-d0e3-4303-948b-08ee1e68f2de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@40974687" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lxv5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/May/23" } ], "description": "Since hirea supports using a hash with mapped_paths, having an example of that usage would be very helpful for folks trying to understand how to use it.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54702", "fixedVersions": [], "id": "54702", "issueType": "Improvement", "key": "DOCUMENT-1412", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:13e9ba64-d0e3-4303-948b-08ee1e68f2de", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "hiera mapped_paths example using hash", "timeSpent": "PT0S", "updated": "2023-05-17T17:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "looks like this was fixed.", "created": "2023-02-27T04:53:00.000000" } ], "components": [], "created": "2023-02-10T12:24:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@643878c6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lwah:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1441714778_*|*_5_*:*_1_*:*_0" } ], "description": "Hi!\nPrevious Puppet statements were basically:\n> Puppet 6 is EoL when the related Puppet Enterprise platform is EoL\n\nPE 2019 contains Puppet 6 and is EoL end of February. This is documented at:\nhttps://www.puppet.com/products/puppet-enterprise/support-lifecycle\n\nHowever, https://www.puppet.com/docs/puppet/6/platform_lifecycle.html says July 2023. Can you please clarify what's correct?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54293", "fixedVersions": [], "id": "54293", "issueType": "Task", "key": "DOCUMENT-1411", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Done", "resolutionDate": "2023-02-27T04:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet 6 EoL Date is inconsistent", "timeSpent": "PT0S", "updated": "2023-02-27T04:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "As agreed with Charlie Sharpsteen and Nick Burgan-Illig, I updated the \u201cUpgrade paths\u201d topic to replace 2019.8.12 with 2019.8.z.\n\nIn the 2021.7.2 documentation, the second row of the table was updated:\u2028\u2028https://www.puppet.com/docs/pe/2021.7/upgrading_pe.html#supported_upgrade_paths\n\nIn the 2023.0 documentation, the third row of the table was updated:\u2028\u2028https://www.puppet.com/docs/pe/2023.0/upgrading_pe.html#supported_upgrade_paths\n\nIn further discussion on Slack we agreed _not_ to add a note that the requirements for an unmanaged PostgreSQL installation are different. Charlie writes:\n\n_\u2028\u2028I've changed my mind on notes. We have it called out in the \"Upgrade an unmanaged PostgreSQL installation\" section and after thinking about it a bit, adding a top-level note that refers to an extremely niche configuration is likely to cause more confusion among the 98% of users that don't have it._", "created": "2023-02-06T10:35:00.000000" } ], "components": [], "created": "2023-02-06T09:00:00.000000", "creator": "62ccea442c801edc3284e763", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@251e0b0f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lsz5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Feb/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5623762_*|*_3_*:*_1_*:*_44204_*|*_5_*:*_1_*:*_0" } ], "description": "Upgrade to 2021.7.2 should be fine unless customers have unmanaged postgress, Please see discussion - https://perforce.slack.com/archives/C04AAT9B188/p1675683361291839 \n\nAs Charlie suggested - \nThe second line in the table might just need to change from:\n2019.8.12 or any 2021.y\nTo:\n2019.8.z or any 2021.y\nWith an addition to the Notes column that the \"Upgrade an unmanaged PostgreSQL installation\" installation section has different requirements.\n\nhttps://www.puppet.com/docs/pe/2021.7/upgrading_pe.html#supported_upgrade_paths\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55018", "fixedVersions": [], "id": "55018", "issueType": "Task", "key": "DOCUMENT-1410", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "62ccea442c801edc3284e763", "resolution": "Fixed", "resolutionDate": "2023-02-06T10:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Upgrade paths for 2021.7.2 LTS ", "timeSpent": "PT0S", "updated": "2023-02-06T10:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in all versions", "created": "2023-07-12T08:20:00.000000" } ], "components": [], "created": "2023-02-02T07:27:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7a909277" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lsq1:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jul/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9019536984_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4803991349" } ], "description": "*Problem:*\n\nCurrently we are using the scope array in our example for sensitive template values, also the use of sensitive as a class name is confusing to users who think there is a special way of calling all sensitive variables via sensitive\n\n*Suggested improvement:*\n\n[https://www.puppet.com/docs/puppet/6/securing-sensitive-data.html#securing_sensitive_data-epp-templates]\nand\n[https://www.puppet.com/docs/puppet/7/lang_template_epp.html#epp_variables-epp-sensitive-data]\n_Current text :_\n\n{{host=<%= scope['db_host'] %>\npassword=<%= scope['sensitive::db_password'] %>}}\n\nThe rendered output is automatically sensitive and used as the file content:\n\n{{{}file \\{ '/etc/service.conf':\n ensure => file,\n content => epp('/service.conf.erb')\n}{}}}{_}{{}}{_}\n\n\u00a0\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\n\n\n{{host=<%=\u00a0 *$db_host* %>}}\n{{password=<%= *$db_password* %>}}\n\nThe rendered output is automatically sensitive and used as the file content:\n\n*db_password= Sensitive('secure_test')*\n*host = examplehost*\n\n{{file \\{ '/etc/service.conf':\n ensure => file,\n content => epp('/service.conf.erb')\n}}}\n\n\u00a0\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*Summary:*\n\nMy suggesting would be to remove scope from both pages as its not relevant, don't use sensitive within the variable name as people think there is some sort of variable keyword otherwise and maybe just set the variable values clearly so people understand its just how the varialbe gets its value is different not how it gets used in the template", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55082", "fixedVersions": [], "id": "55082", "issueType": "Bug", "key": "DOCUMENT-1409", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2023-07-12T08:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "12/Jul/23 8:20 AM", "summary": "[docs issue] For example of using sensitive data in templates we are using old scope array, there is no need", "timeSpent": "PT0S", "updated": "2023-07-12T08:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "[~accountid:609a8eb65998a60068d12a0a] Thank you for letting us know about this issue, David. As I started to explore the suggested update, I realized that this sentence is in the open source Puppet documentation, which is owned by Parker. For now, I will reassign the Jira ticket to Parker.\n\n[~accountid:60e4906e4134aa006931a5d6] Parker, if you prefer that I handle this update, let me know.", "created": "2023-02-02T16:28:00.000000" } ], "components": [], "created": "2023-02-02T07:02:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b211030" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lspt:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Feb/23" } ], "description": "*Problem:*\n\nCurrently the documentation for the service type lists on a refresh event by default it will stop and start. This is incorrect, if the underlying provider gives a restart command it will use that then fail back to stop and start.\n\n*Suggested improvement:*\n\nhttps://www.puppet.com/docs/puppet/7/types/service.html#service-attribute-restart\n\n_Current text :_\n\nSpecify a restart command manually. If left unspecified, the service will be stopped and then started.\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\nSpecify a restart command manually. If left unspecified, the service will be *restarted if the provider has a restart command otherwise it will be* stopped and then started.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55017", "fixedVersions": [], "id": "55017", "issueType": "Bug", "key": "DOCUMENT-1408", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Service type lists wrong default refresh behaviour", "timeSpent": "PT0S", "updated": "2023-05-17T17:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b9a9f13497b882c77e94374", "attachments": [], "comments": [ { "author": "5b9a9f13497b882c77e94374", "body": "Added this to the known issues section here: https://www.puppet.com/docs/continuous-delivery/4.x/known_issues_cdpe.html#DOCUMENT-1407", "created": "2023-05-10T10:48:00.000000" } ], "components": [], "created": "2023-01-31T09:11:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3119fbb2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ls4p:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "50845" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/May/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8555767977_*|*_5_*:*_1_*:*_0" } ], "description": "Can we get a known issue added for the issue that specifically arises from the kb:\nhttps://support.puppet.com/hc/en-us/articles/8194570929431-After-upgrading-Continuous-Delivery-for-Puppet-Enterprise-and-Puppet-Application-Manager-you-lose-connectivity-to-your-cluster?source=search ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54291", "fixedVersions": [], "id": "54291", "issueType": "Improvement", "key": "DOCUMENT-1407", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2023-05-10T10:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "10/May/23 10:48 AM", "summary": "Known issue on airgapped upgrades of PAM/CD4PE", "timeSpent": "PT0S", "updated": "2023-05-10T10:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b9a9f13497b882c77e94374", "attachments": [], "comments": [], "components": [], "created": "2023-01-31T02:04:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@40898f92" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ls2x:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "50845" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/May/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9211801089_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1107086445" } ], "description": "Due to the following issue: https://support.puppet.com/hc/en-us/articles/8194570929431-After-upgrading-Continuous-Delivery-for-Puppet-Enterprise-and-Puppet-Application-Manager-you-lose-connectivity-to-your-cluster?source=search upgrades can fail if contained reaches ~85% capacity\n\nTo mitigate this we think a manual step before upgrade to prune this directory of any unneeded images would be a useful step:\n\nFirst, check that all pods are healthy `kubectl get pods -A`\n\nThen, garbage collection of images can be triggered manually by running `crictl rmi --prune`. Running this command on a PAM node prior to `cat tasks.sh | sudo bash -s load-images` will release unused space so that automatic ImageGC won't happen during the upgrade.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54371", "fixedVersions": [], "id": "54371", "issueType": "Improvement", "key": "DOCUMENT-1406", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Won't Fix", "resolutionDate": "2023-05-30T13:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "30/May/23 1:25 PM", "summary": "Add a prune step to airgapped CD4PE upgrade docs", "timeSpent": "PT0S", "updated": "2023-05-30T13:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b9a9f13497b882c77e94374", "attachments": [], "comments": [ { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "Another instance of this space issue was hit by Carnegie Mellon in [https://puppetlabs.zendesk.com/agent/tickets/51957|https://puppetlabs.zendesk.com/agent/tickets/51957]", "created": "2023-05-25T03:54:00.000000" }, { "author": "5b9a9f13497b882c77e94374", "body": "I have updated the containerd disk space requirements from 40 to 80. This also changed the total requirements needed for /var/lib. I added up the breakdowns and rounded up to the nearest 10 GB. I also updated the image that showed these values as well. Please review the storage requirements on this page: [https://docs-herrera-preview.netlify.app/docs/pam/1.0/pam-sysreqs.html#puppet_supported_standalone_hardware_requirements|https://docs-herrera-preview.netlify.app/docs/pam/1.0/pam-sysreqs.html#puppet_supported_standalone_hardware_requirements] and let me know if anything needs to change. Also, please review the image toward the bottom of the page and let me know if the values there are all correct. Thanks.", "created": "2023-05-25T13:44:00.000000" } ], "components": [], "created": "2023-01-31T01:58:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@f6b2f87" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ls2p:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "50845" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/May/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9212144189_*|*_10009_*:*_1_*:*_431082439_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_675995393" } ], "description": "In the past 12 months, we've seen the size of containerd cause issues when upgrading airgapped customers. Its currently recommended to be 40GB but as in the following kb this will cause issues when it reaches 85% full: https://support.puppet.com/hc/en-us/articles/8194570929431-After-upgrading-Continuous-Delivery-for-Puppet-Enterprise-and-Puppet-Application-Manager-you-lose-connectivity-to-your-cluster?source=search\n\nReplicated have recommended we 3x the size of containerd directory after an initial install and after testing this yesterday this comes out to 13.1GB so I think the recommended size of containerd should be increased by 40gb to 80gb", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54289", "fixedVersions": [], "id": "54289", "issueType": "Improvement", "key": "DOCUMENT-1405", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2023-05-30T13:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "30/May/23 1:25 PM", "summary": "Containerd size recommendations in cd4pe docs", "timeSpent": "PT0S", "updated": "2023-05-30T13:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "On Slack, Charlie Sharpsteen provided instructions for updating the relevant topics. Here's what I learned today:\n\nWe need to add two new sentences in the \u201cInstall compilers\u201d topic:\u2028\u2028https://www.puppet.com/docs/pe/2021.7/installing_compilers.html#install-compilers \n\nThe updates should go into the 2021.7.2, 2021.7.3, 2023.0, and 2023.1 releases. Once the new branches are created, the updates would go into the following branches:\u2028\u2028\nlatest-preview\nlatest\n2021.7.z\n2021.7\n\nAccording to Charlie Sharpsteen, we should update the \u201cBefore you begin\u201d section with the following new prerequisite:\n\n\u2028\u2028\u201cEnsure that you have a valid admin RBAC token. For instructions, see \u2018Generate a token using puppet-access.\u2019\u201d\n\nHere\u2019s the linked topic:\n\nhttps://www.puppet.com/docs/pe/2021.7/rbac_token_auth_intro.html#generate_a_token_using_puppet_access", "created": "2023-01-30T15:44:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "The updates were implemented on the production server in the 2023.0 and 2021.7.2 releases. For example, see the updated \u201cBefore you begin\u201d section in the 2023.0 \u201cInstall compilers\u201d topic:\u2028\u2028\n\nhttps://www.puppet.com/docs/pe/2023.0/installing_compilers.html#install-compilers\u2028\n\nThe updates were also implemented on the preview server for the upcoming 2023.1 and 2021.7.3 releases.", "created": "2023-02-03T11:27:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "The update was included in all relevant topics.", "created": "2023-02-03T11:28:00.000000" } ], "components": [], "created": "2023-01-26T09:34:00.000000", "creator": "623a434701f8660070b62e0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71ee651e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lmq1:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_367847813_*|*_3_*:*_1_*:*_330187884_*|*_5_*:*_1_*:*_0" } ], "description": "Here is the text of the customer comment:\n\nComment:\nRegarding the Compiler installation steps, please include a pre-requisite to ensure the Primary Server has a working RBAC token which has orchestrator:view* permissions (or just admin permissions). In my case, my Primary Server had a token with only Code Manager permissions, because I had followed the steps for configuring Code Manager.\nDue to this, I received the error log highlighted in https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Ftickets.puppetlabs.com%2Fbrowse%2FDOCUMENT-1169&data=05%7C01%7Cingrida.cazers%40perforce.com%7C0d329ee2528042e0157608daf9b82d14%7C95b666d19a7549ab95a38969fbcdc08c%7C0%7C0%7C638096866683191267%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=Fj3GmWtje31h69YiBoR3xqKqCy8Dk0L3N%2FiKVyxFkfg%3D&reserved=0\nI spent countless hours digging through the internet/primary server logs, for an issue which can be fixed with a simple cautionary pre-req sentence in the docs.\nI'm sure this will be of extreme value for the next person attempting to configure Puppet Enterprise Compilers.\n\nEmail:\nMickey.Gerasimou@asic.gov.au\n\nSubject:\nDocs Site Feedback\n\nUrl:\nhttps://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.puppet.com%2Fdocs%2Fpe%2F2021.7%2Finstalling_compilers.html%23compiler_installation&data=05%7C01%7Cingrida.cazers%40perforce.com%7C0d329ee2528042e0157608daf9b82d14%7C95b666d19a7549ab95a38969fbcdc08c%7C0%7C0%7C638096866683191267%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=9yGp%2FvI8jUHH7E6amh4orecEArhxEwguizCGdMEAvZI%3D&reserved=0\n\n------------\n\nSee also the attached document, which describes the potential resolution to this issue. The document was shared with Nick Burgan-Illig on 1/19/2023, but he's on vacation and has not replied. Maybe I can get another member of the PE team to look at this suggested update.\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54639", "fixedVersions": [], "id": "54639", "issueType": "Task", "key": "DOCUMENT-1404", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a434701f8660070b62e0a", "resolution": "Fixed", "resolutionDate": "2023-02-03T11:28:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE: Fix instructions for installing compiler", "timeSpent": "PT0S", "updated": "2023-02-03T11:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "I reached out to Steve Axthelm this week to ask who would be a good subject matter expert for this ticket, but he hasn\u2019t yet replied.", "created": "2023-05-11T17:10:00.000000" }, { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "I believe that should all be happening over port 8140. Out of curiosity, have you perhaps changed the default on {{puppet_enterprise::puppet_master_port}}?", "created": "2023-05-22T10:37:00.000000" }, { "author": "61bbace0755091006a2b896a", "body": "have to check this again, i was at a customer and we had some troubles with the serving of the repository.", "created": "2023-06-05T01:47:00.000000" } ], "components": [], "created": "2023-01-25T02:59:00.000000", "creator": "61bbace0755091006a2b896a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3e4b0460" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lm4h:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/May/23" } ], "description": "[https://www.puppet.com/docs/pe/2021.7/firewall_large.png]\n\ni would recommend adding port 443 between compilers and primary/replica. this is the port the pe_repo is served from the primary/replica. in a firewalled environment, this connection has to be at least mentioned. otherwise you will not get packages installed on the compiler/s.\n\nwhat do you think, or am i wrong here?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54805", "fixedVersions": [], "id": "54805", "issueType": "Improvement", "key": "DOCUMENT-1403", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61bbace0755091006a2b896a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add port to compiler docu", "timeSpent": "PT0S", "updated": "2023-06-05T01:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Duplicate of DOCUMENT-1409", "created": "2023-07-12T08:20:00.000000" } ], "components": [ "DOC" ], "created": "2023-01-23T10:35:00.000000", "creator": "5f64b201bdb078007028d7cf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "{quote}Enumeration of requirements to consider the defect addressed.\n{quote}" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3df8789b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lldd:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jul/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9872370748_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4803902243" } ], "description": "The documentation for securing [Sensitive data|https://www.puppet.com/docs/puppet/7/lang_template_epp.html#epp-sensitive-data]\u00a0in an EPP template incorrectly references ERB syntax (scope['sensitive::mysecret']) instead of the correct $sensitive::mysecret", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54134", "fixedVersions": [], "id": "54134", "issueType": "Bug", "key": "DOCUMENT-1402", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5f64b201bdb078007028d7cf", "resolution": "Duplicate", "resolutionDate": "2023-07-12T08:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "12/Jul/23 8:20 AM", "summary": "EPP documentation references ERB syntax", "timeSpent": "PT0S", "updated": "2023-07-12T08:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-19T16:41:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@43418d81" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ll01:" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://www.puppet.com/docs/puppet/7/function.html#with\n\nI don't have a great way to explain an example but reviewing Henriks blog and discusison here\u00a0 may help [On the Bleeding Edge of Puppet: Digging out data in style with puppet 4.5.0 (puppet-on-the-edge.blogspot.com)|http://puppet-on-the-edge.blogspot.com/2016/05/digging-and-processing-complex-data-in.html?m=1]\u00a0 [https://puppetcommunity.slack.com/archives/C0W298S9G/p1673947236899789?thread_ts=1673912568.389829&cid=C0W298S9G]\u00a0\n\n*Summary:*\n\nOur example for with is not really the intended use case", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54935", "fixedVersions": [], "id": "54935", "issueType": "Bug", "key": "DOCUMENT-1401", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The with function example is not really what the purpose of it is ", "timeSpent": "PT0S", "updated": "2023-05-17T17:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "[~accountid:6086bf63f558240070e4f8dc] \n\nHi, Edwin. Thanks for opening this ticket. I have two questions:\n\n1. A few months have passed since you opened the ticket. Are your suggested documentation updates still valid?\n2. Should I add this text to the current PE documentation (2023.0 and 2021.7.2)? Should I also add it to the PE documentation for the upcoming releases (2023.1 and 2021.7.3)?", "created": "2023-04-14T17:57:00.000000" } ], "components": [], "created": "2023-01-18T05:07:00.000000", "creator": "6086bf63f558240070e4f8dc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4ec03546" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lkj5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Apr/23" } ], "description": "*Problem:*\n\nBased on customer feedback, we realized that the consequences for integrations (CD4PE, Comply) of changing the PE certificates are not very clear from the current document:\n\n[https://www.puppet.com/docs/pe/2021.7/regenerate_certificates.html#delete_and_recreate_ca]\u00a0\n\nThe Certificate's lifecycles (regenerate, delete) can affect integrations such as CD4PE\n\n*Suggested improvement:*\n\n[https://www.puppet.com/docs/pe/2021.7/regenerate_certificates.html#delete_and_recreate_ca]\u00a0\n\n_Current text :_\n\nCAUTION:\u00a0Replacing your certificate authority invalidates all existing certificates in your environment. Complete this task only if and when you're prepared to regenerate certificates for both your infrastructure nodes (including external\u00a0PE-PostgreSQL\u00a0in extra-large installations) and your entire agent fleet.\n\n_Suggested improvement:_\n\nCAUTION:\u00a0Replacing your certificate authority invalidates all existing certificates in your environment. Complete this task only if and when you're prepared to regenerate certificates for both your infrastructure nodes (including external\u00a0PE-PostgreSQL in extra-large installations) and your entire agent fleet. {*}Be aware that this will affect current integrations with CD4PE or Comply. For CD4PE: Refer to steps 4 and 5 in [the configuration document here|https://www.puppet.com/docs/continuous-delivery/4.x/cd_troubleshooting.html#configure-pe-manually]{*}{*}. For Comply please refer to [Step No. 6.C and 7 on the document here.|https://www.puppet.com/docs/comply/2.x/com-tls-cfg.html]{*}\n\n*Summary:*\n\nWe want to alert customers of the consequences that often are unknown to them. A customer had this issue recently and we found that there is nothing in the docs that can explain the process to fix it.\n\nWe know our suggestion might not be 100% clear, but we are happy to answer questions or just jump on a call to explain more, please contact: [~accountid:6220db93db58c1006879dacf] or [~accountid:609a8eb65998a60068d12a0a]\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54370", "fixedVersions": [], "id": "54370", "issueType": "Improvement", "key": "DOCUMENT-1400", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6086bf63f558240070e4f8dc", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The consequences for integrations of changing the PE certs are not clear", "timeSpent": "PT0S", "updated": "2023-05-17T17:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-17T17:38:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@54c5ca64" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lkex:" } ], "description": "*Problem:*\n\nThe with function has an odd definition which I dont think matches with [On the Bleeding Edge of Puppet: Digging out data in style with puppet 4.5.0 (puppet-on-the-edge.blogspot.com)|http://puppet-on-the-edge.blogspot.com/2016/05/digging-and-processing-complex-data-in.html?m=1] how Henrik describes its purpose\n\n*Suggested improvement:*\n\n[Built-in function reference (puppet.com)|https://www.puppet.com/docs/puppet/7/function.html#with]\n\n_Current text :_\n\nCalls a\u00a0[lambda|https://puppet.com/docs/puppet/latest/lang_lambdas.html]\u00a0with the given arguments and returns the result.\n\nSince a lambda's scope is\u00a0[local|https://puppet.com/docs/puppet/latest/lang_lambdas.html#lambda-scope]\u00a0to the lambda, you can use the\u00a0{{with}}\u00a0function to create private blocks of code within a class using variables whose values cannot be accessed outside of the lambda.\n\n{{# Concatenate three strings into a single string formatted as a list.\n$fruit = with(\"apples\", \"oranges\", \"bananas\") |$x, $y, $z| \\{\n \"${x}, ${y}, and ${z}\"\n}\n$check_var = $x\n# $fruit contains \"apples, oranges, and bananas\"\n# $check_var is undefined, as the value of $x is local to the lambda.}}\n\n{{with(Any *$arg, Callable &$block)}}\n\n_Suggested improvement:_\n\n_This maybe needs a thought out example like Henriks blog but with is really for taking the result from a previous lambda and being able to chain a lambda return into another lambda with no condition on it being undef._\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*Summary:*\n\nThe current with example focuses on the variables being in a scope just in the lambda I don't think this is relevant and its more about chaining lambdas together", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54759", "fixedVersions": [], "id": "54759", "issueType": "Bug", "key": "DOCUMENT-1399", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] description of with function seems wrong", "timeSpent": "PT0S", "updated": "2023-05-17T17:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-17T16:39:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@35a287ab" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lkep:" } ], "description": "*Problem:*\n\nThe return definition is currently the same as the next definition in functions. This could be resolved by taking [PUP-7904] return() documentation incorrect regarding lambdas - Puppet Tickets (puppetlabs.com) into the current docs\n\n*Suggested improvement:*\n\nhttps://www.puppet.com/docs/puppet/7/function.html#return\n\n_Current text :_\n\nInclude the text that should be corrected or improved here.\n\nMakes iteration continue with the next value, optionally with a given value for this iteration. If a value is not given it defaults to\u00a0{{undef}}\n\n{{return(Optional[Any] $value)}}\n\n_Suggested improvement:_\n\n\n*If called from within a lambda return will return from the function containing the lambda. Note this can not be used at top scope in a class.*\n\n***Example:** Using `return` in a lambda*\n\u00a0*# Concatenate three strings into a single string formatted as a list.*\n*function getFruit() {*\n\u00a0 *with(\"apples\", \"oranges\", \"bananas\") |$x, $y, $z| {*\n\u00a0 \u00a0 *return(\"${x}, ${y}, and ${z}\")*\n\u00a0 *}*\n\u00a0 *notice \"not reached\"*\n*}*\n*$fruit = getFruit()*\n*notice $fruit*\n*# The output contains \"apples, oranges, and bananas\".*\n*# \"not reached\" is not output because the function returns its value within the calling function's scope, which stops processing the calling function before the `notice \"not reached\"` statement.*\n*# Using `return()` outside of a calling function results in an error*\n\n*{{return(Optional[Any] $value)}}*\n\n*Summary:*\n\nThe return function was mistakenly overwritten with the defintion of next. See [PUP-7904] return() documentation incorrect regarding lambdas - Puppet Tickets (puppetlabs.com) for where example and information is coming from", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54638", "fixedVersions": [], "id": "54638", "issueType": "Bug", "key": "DOCUMENT-1398", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]", "timeSpent": "PT0S", "updated": "2023-05-17T17:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-17T03:39:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@27980553" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lk5d:" } ], "description": "*Problem:*\n\nThe current iterator doc would imply these are the only iterative functions\n\n*Suggested improvement:*\n\n[Iteration and loops (puppet.com)|https://www.puppet.com/docs/puppet/7/lang_iteration.html#lang_iteration-iteration-functions]\n\n_Current text :_\n\nIterative functions accept a block of code and run it in a specific way:\n * {{each}}\u00a0- Repeats a block of code a number of times, using a collection of values to provide different parameters each time.\n\n * {{slice}}\u00a0- Repeats a block of code a number of times, using groups of values from a collection as parameters.\n\n * {{filter}}\u00a0- Uses a block of code to transform a data structure by removing non-matching elements.\n\n * {{map}}\u00a0- Uses a block of code to transform every value in a data structure.\n\n * {{reduce}}\u00a0- Uses a block of code to create a new value, or data structure, by combining values from a provided data structure.\n\n * {{with}}\u00a0- Evaluates a block of code one time, isolating it in its own local scope. It doesn\u2019t iterate, but has a family resemblance to the iteration functions.\n\n_Suggested improvement:_\n\n_Iterative functions accept a block of code and run it in a specific way:_\n * {{each}}\u00a0- Repeats a block of code a number of times, using a collection of values to provide different parameters each time.\n\n * {{slice}}\u00a0- Repeats a block of code a number of times, using groups of values from a collection as parameters.\n\n * {{filter}}\u00a0- Uses a block of code to transform a data structure by removing non-matching elements.\n\n * {{map}}\u00a0- Uses a block of code to transform every value in a data structure.\n\n * {{reduce}}\u00a0- Uses a block of code to create a new value, or data structure, by combining values from a provided data structure.\n\n * {{with}}\u00a0- Evaluates a block of code one time, isolating it in its own local scope. It doesn\u2019t iterate, but has a family resemblance to the iteration functions.\n\n{*}This is a selction of iterative functions a complete list can be found in https://www.puppet.com/docs/puppet/7/function.htm{*}l\n\nOr alternatively we maintain a complete list...\n\n*Summary:*\n\nThe current iterator doc would imply these are the only iterative functions", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55016", "fixedVersions": [], "id": "55016", "issueType": "Bug", "key": "DOCUMENT-1397", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The current iterator doc would imply these are the only iterative functions", "timeSpent": "PT0S", "updated": "2023-05-17T17:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-17T03:36:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7eba5e1f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lk55:" } ], "description": "*Problem:*\n\nI think explicitly saying anonymous functions are unnamed functions which can't be called would be better here.\u00a0\n\n*Suggested improvement:*\n\n[Lambdas (puppet.com)|https://www.puppet.com/docs/puppet/7/lang_lambdas.html]\n\n_Current text :_\n\nthink of lambdas as anonymous functions that are passed to other functions.\n\n_Suggested improvement:_\n\nthink of lambdas as anonymous functions that are passed to other functions. So they are unnamed and can not be called in any other context.\n\n*Summary:*\n\nI think explicitly saying anonymous functions are unnamed functions which can't be called would be better here.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54934", "fixedVersions": [], "id": "54934", "issueType": "Bug", "key": "DOCUMENT-1396", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]", "timeSpent": "PT0S", "updated": "2023-05-17T17:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-13T08:34:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6d764240" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ljk1:" } ], "description": "*Problem:*\n\nThe EPP documentation does not highlight the availability of open tag trimming as described in the spec\n\n*Suggested improvement:*\n\n[Creating templates using Embedded Puppet|https://www.puppet.com/docs/puppet/7/lang_template_epp.html#epp_tags-epp-comment-tags]\n\n_Current text :_\n|Opening tag|{{<%#}}|\n|Closing tag|{{%>}}|\n|Closing tag with space trimming|{{-%>}}|\n\n_Suggested improvement:_\n|Opening tag|{{<%#}}|\n|Closing tag|{{%>}}|\n|*Opening tag with space trimming*|*{{<%#-}}*|\n|Closing tag with space trimming|{{-%>}}|\n\n*Summary:*\n\nAs per [puppet-specifications/templates.md at master \u00b7 puppetlabs/puppet-specifications (github.com)|https://github.com/puppetlabs/puppet-specifications/blob/master/language/templates.md#epp-tags-and-their-meaning]\u00a0*{{}}*\u00a0\n * Before Puppet 6.0.0 an EPP comment\u00a0{{<%#}}\u00a0always trimmed all preceding whitespace on the same line. From Puppet 6.0.0 it does not and\u00a0{{<%#-}}\u00a0should instead be used if this is wanted.\n * Left trimming EPP comment\u00a0{{<%#-}}\u00a0is available from Puppet 6.0.0.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54834", "fixedVersions": [], "id": "54834", "issueType": "Bug", "key": "DOCUMENT-1395", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] EPP comment tag not showing opening trimming available", "timeSpent": "PT0S", "updated": "2023-05-17T17:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:6220db7149c90000701fd082] Hi, this fix will go out with the next PAM release.", "created": "2023-01-09T12:07:00.000000" } ], "components": [], "created": "2023-01-04T12:01:00.000000", "creator": "6220db7149c90000701fd082", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@68a8ace2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lcx5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Jan/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_432297962_*|*_3_*:*_1_*:*_136930_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nUnder \"Reset the PAM password\", the first command for the reset command is incorrect and will not work. You can't specify the namespace before the plugin subcommand.\n\n*Suggested improvement:*\n\nhttps://www.puppet.com/docs/continuous-delivery/4.x/pam/pam-troubleshooting.html#platform_admin_console_password\n\n_Current text :_\n\nkubectl -n default kots reset-password\n\n_Suggested improvement:_\n\nkubectl kots reset-password default\n\n*Summary:*\n\n\u00a0Change from incorrect command syntax", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54637", "fixedVersions": [], "id": "54637", "issueType": "Task", "key": "DOCUMENT-1394", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "resolution": "Fixed", "resolutionDate": "2023-01-09T12:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PAM password reset command incorrect", "timeSpent": "PT0S", "updated": "2023-01-09T12:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2023-01-04T02:41:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@46cb644d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kp0n:" } ], "description": "*Problem:*\n\nPuppet takes a different approach for iteration and loops not using traditional loop keywords and it may not be obvious to users why.\n\n*Suggested improvement:*\n\n[Iteration and loops (puppet.com)|https://www.puppet.com/docs/puppet/7/lang_iteration.html]\n\n_Current text :_\n\nInstead of using loop keywords, the Puppet language uses iterative\u00a0[functions|https://www.puppet.com/docs/puppet/7/lang_functions.html#lang_functions]\u00a0that accept blocks of code called\u00a0[lambdas|https://www.puppet.com/docs/puppet/7/lang_lambdas.html].\n\n_Suggested improvement:_\n\nInstead of using loop keywords, the Puppet language uses iterative\u00a0[functions|https://www.puppet.com/docs/puppet/7/lang_functions.html#lang_functions]\u00a0that accept blocks of code called\u00a0[lambdas|https://www.puppet.com/docs/puppet/7/lang_lambdas.html]. *The main reason for this is that a {{loop}}\u00a0or\u00a0{{do}} keword can't do everything in a language with no mutable variables. For example, you can't loop over some data and construct an Array or Hash, it would only be possible to create the first element.*\n\n*Summary:*\n\nAs per conversation in [https://perforce.slack.com/archives/C049M3S72SF/p1672782432331459] it would be good to directly clarify why Puppet takes its approach with loops and iteration", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54636", "fixedVersions": [], "id": "54636", "issueType": "Bug", "key": "DOCUMENT-1393", "labels": [ "osp", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Add explanation of why Puppet doesn't use loop keywords like for or fo", "timeSpent": "PT0S", "updated": "2023-05-17T17:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Update will get published at the next CDPE release.", "created": "2023-01-09T12:22:00.000000" } ], "components": [], "created": "2022-12-29T15:19:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@575b6cf1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0lc75:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Jan/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_939780611_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nVersion ID in know issues for CD4PE has incorrect . 4.1.2.0 instead of 4.12.0\n\n*Suggested improvement:*\n\n[Continuous Delivery for PE known issues (puppet.com)|https://www.puppet.com/docs/continuous-delivery/4.x/known_issues_cdpe.html#:~:text=These%20are%20the%20known%20issues%20for%20the%20Continuous,PE%20version%204.1.2.0%20can%20delete%20the%20cd4pe%20Ingress.]\u00a0\n\n_Current text :_\n\nIn busier\u00a0Kubernetes\u00a0clusters, upgrading to\u00a0Continuous Delivery for PE\u00a0version 4.1.2.0 can delete the\u00a0{{cd4pe}}\u00a0Ingress\n\n_Suggested improvement:_\n\nIn busier\u00a0Kubernetes\u00a0clusters, upgrading to\u00a0Continuous Delivery for PE version 4.{*}12{*}.0 can delete the\u00a0{{cd4pe}}\u00a0Ingress\n\n*Summary:*\n\nThe version in the text should match the title just an extra . got in there.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54369", "fixedVersions": [], "id": "54369", "issueType": "Bug", "key": "DOCUMENT-1392", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2023-01-09T12:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Version ID in know issues for CD4PE has incorrect . 4.1.2.0 instead of 4.12.0", "timeSpent": "PT0S", "updated": "2023-01-09T12:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "6220dbd415521d00726b0564", "body": "[~accountid:616989d3048360006aeb55e8] Hi April! A support ticket came in today requesting clarification on whether the plan supports a comma-separated list of compilers. I realized that it appears this clarification was only added to the 2019.8.Z docs [https://www.puppet.com/docs/pe/2019.8/installing_compilers.html#install-compilers] and not the 2021.Y docs. Was this expected? Can the 2021.Y docs be updated as well? Thank you!", "created": "2023-01-11T11:06:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:6220dbd415521d00726b0564] I made the change in the docs that are going to be published with the upcoming release.", "created": "2023-01-11T11:15:00.000000" } ], "components": [], "created": "2022-12-22T06:01:00.000000", "creator": "5b859c0af1fb77577188895d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@ccd07b6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0land:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "50391,50691" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jan/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_5234695_*|*_5_*:*_2_*:*_1741612516" } ], "description": "Currently, [https://www.puppet.com/docs/pe/2019.8/installing_compilers.html#install-compilers] uses the command `puppet infrastructure provision compiler ` to provision a compiler. While this is all clear, we don't specify that this provision compiler plan does not accommodate multiple compilers. While this may sound trivial, we do accommodate multiple compilers for upgrade as per upgrade compiler plan (e.g. `puppet infrastructure upgrade compiler ,`). As such, this may lead us towards incorrect assumptions as per ZD ticket. Therefore, I feel that a note below the command `puppet infrastructure provision compiler ` may have us covered better an avoid incorrect assumptions.\n\n~* Please see Zendesk Support tab for further comments and attachments.~", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54270", "fixedVersions": [], "id": "54270", "issueType": "Improvement", "key": "DOCUMENT-1391", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db9494f7e20069fe964a", "resolution": "Fixed", "resolutionDate": "2023-01-11T11:15:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Clarify that `puppet infrastructure provision compiler` is just for a single compiler", "timeSpent": "PT0S", "updated": "2023-01-11T12:01:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-12-12T08:48:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@931899e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kp0o:" } ], "description": "*Problem:*\n\nCurrently the Hiera deep merge documentation describe it as \"contains an array of class names and can be used as a lightweight External Node Classifier (ENC).\" While this could be an example use case, a deep merge does not inherently contain a class array.\n\n*Suggested improvement:*\n\n[Creating and editing data (puppet.com)|https://puppet.com/docs/puppet/7/hiera_merging.html#hiera_merging]\n\nIt contains an array of class names and can be used as a lightweight External Node Classifier (ENC).\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\nAn example use case of this could be combining a classes array for use as an External Node classifier (ENC)\u00a0\n\nThis might also make a good example for the knockout prefix.\n\n*Summary:*\n\nThe current definition for a deep merge implies it contains a class array while that is dependent on the data.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54635", "fixedVersions": [], "id": "54635", "issueType": "Bug", "key": "DOCUMENT-1389", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Hiera deep merge talks about example as if its a feature", "timeSpent": "PT0S", "updated": "2023-05-17T17:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-12-02T09:57:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@58d933e5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0l0x5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_418237504_*|*_3_*:*_1_*:*_251082_*|*_5_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_187131542" } ], "description": "*Problem:*\n\n[https://puppet.com/docs/pe/2021.7/dr_configure.html#dr-provision-replica] in the current document why {{--skip-agent-config}} is being run and the affect it has is not clear to customers. They do not understand how the compilers will know about the replicas\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.7/dr_configure.html#dr-provision-replica]\n\n_Current text :_\n\nOn the primary server, as the root user, run\u00a0{{puppet infrastructure provision replica --enable}}\nNote:\u00a0In installations with compilers, use the\u00a0{{--skip-agent-config}}\u00a0flag with the\u00a0{{--enable}}\u00a0option if you want to:\n_Suggested improvement:_\n\nIf in this section we could add the point that running the replica enable will update the PE Agent node group adding replica to the server list (causing all Puppet.confs to configure it in) or alternatively using {{--skip-agent-config}} will skip down to the child node group PE Infrastructure Agent and add replica to the server list there causing it to be configured in puppet.conf on all infrastructure nodes only (including compilers)\n\n*Summary:*\n\nCustomers are not clear how a replica is added in or what --skip-agent-config does exactly. A little note on the node group configuration would help that", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55078", "fixedVersions": [], "id": "55078", "issueType": "Improvement", "key": "DOCUMENT-1388", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-12-09T10:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Not clear to customers how replica is added to compiler puppet.conf", "timeSpent": "PT0S", "updated": "2022-12-09T10:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:6086bf63f558240070e4f8dc], I took a look at the doc and the diagram but I am not quite clear how you envision the Load Balancer Health Checks section being organized. Am I adding things to the table or more substantial information? I am also not sure how much of the doc you want me to incorporate", "created": "2022-11-30T12:00:00.000000" } ], "components": [], "created": "2022-11-28T03:35:00.000000", "creator": "6086bf63f558240070e4f8dc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@38d8c5c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kzjt:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Nov/22" } ], "description": "*Problem:*\n\nThe majority of our customers don't have an internal Kubernetes team or practice in place, and we have had questions in the past about the nitty gritty details of implementing the load balancer health checks.\n\nChris Allen worked on a document that explains in detail how to connect and configure the Kubernetes cluster's primaries with the load balancers. We might want to make this example as general as possible.\n\n*Suggested improvement:*\n\nDiagram:\n\n[https://puppet.com/docs/continuous-delivery/4.x/pam/maintenance-and-tuning.html#load_balancer_health_checks]\u00a0\n\n_Current text :_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\n\n* Add a diagram with the ports [https://perforce.slack.com/files/U042CS9HNQK/F04C8ESRGR0/cd4pe-arch.drawio.pdf]\u00a0\n\n* Document created by Chris\n[https://perforce.slack.com/archives/C047N5BMV7V/p1669216845965449]\u00a0\n\n\u00a0\n\n*Summary:*\n\nIn this Doc's ticket, my goal is to create awareness, but we have to collaborate to make the suggestions and diagram customer agnostic (right now it says HSBC everywhere).\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54133", "fixedVersions": [], "id": "54133", "issueType": "Improvement", "key": "DOCUMENT-1387", "labels": [ "PAM" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6086bf63f558240070e4f8dc", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add more details about the PAM's load balancer implementation", "timeSpent": "PT0S", "updated": "2023-05-18T07:44:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-11-28T03:33:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1ef9796c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kzjl:" } ], "description": "*Problem:*\n\nCurrently in docs we have [Life cycle of a Puppet run|https://puppet.com/docs/puppet/7/details_about_puppets_internals.html] , [Configuration Reference (puppet.com), |https://puppet.com/docs/puppet/7/configuration.html]\n\nNothing which gives a step by step what happens in a Puppet run like this page which was brought to us by a customer as a good example of what they would like to see [The lifecycle of a Puppet run | Troubleshooting Puppet (packtpub.com)|https://subscription.packtpub.com/book/networking-and-servers/9781784398651/1/ch01lvl1sec08/the-lifecycle-of-a-puppet-run]\u00a0\n\n\n\n\n*Suggested improvement:*\n\n[Life cycle of a Puppet run|https://puppet.com/docs/puppet/7/details_about_puppets_internals.html] should be updated to contain a summary before linking to the more detailed documents\n\n*Summary:*\n\nThe docs seem to be lacking a simple step by step overview of the Puppet agent run process.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55076", "fixedVersions": [], "id": "55076", "issueType": "Improvement", "key": "DOCUMENT-1386", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] A summaried puppet cycle version would be useful", "timeSpent": "PT0S", "updated": "2023-05-18T07:44:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "609a8eb65998a60068d12a0a", "body": "Closing this ticket for present following consultation with team-dumpling and [~accountid:605bbb3d2f7d9000709ed091] from a product perspective to review position of PEADM", "created": "2022-11-11T09:06:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Closing for now", "created": "2022-11-11T09:06:00.000000" } ], "components": [], "created": "2022-11-11T04:06:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a7ba481" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kscx:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18013386_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nCurrent Install, upgrade and supported architectures do not mention PEADM. This is our recommended way of installing and updating PE.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.7/installing_pe.html#install_pe]\n[https://puppet.com/docs/pe/2021.7/upgrading_pe.html#upgrade_pe]\n\n_Both texts should highlight at the start the preferred\u00a0method of install and upgrade is to use the supported PEADM module [puppetlabs/puppetlabs-peadm: A Puppet module defining Bolt plans used to automate Puppet Enterprise deployments (github.com)|https://github.com/puppetlabs/puppetlabs-peadm] for install highlighting XL is only supported with PEADM and that a support case should be raised to help Puppet support during the process. I raised an additional ticket to change the upgrade XL.\n\nThe manual upgrade instructions can stay in place for standard and large for now as fall back._\n\n*Summary:*\n\nPEADM is now a supported module and should be the primary method of install and upgrade for PE infrastructure and XL architecture is only supported with PEADM", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54755", "fixedVersions": [], "id": "54755", "issueType": "Improvement", "key": "DOCUMENT-1385", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Won't Do", "resolutionDate": "2022-11-11T09:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Install, upgrade and supported architecture pages should recommed PEADM", "timeSpent": "PT0S", "updated": "2022-11-11T09:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Upgrade an extra-large installation\nTo upgrade an extra-large installation, run the PE installer first on your PE-PostgreSQL node, then on your primary server, and then upgrade any additional components.\n\n\nBefore you begin\nBack up your PE installation.\nEnsure you have a valid admin RBAC token in order to upgrade compilers.\nRemove from the console (in the PE Master node group), Hiera, or pe.conf any agent_version parameters that you've set in the pe_repo class that matches your infrastructure nodes. Doing so ensures that upgrade isn't blocked by attempting to download a non-default agent version for your infrastructure OS and architecture.\nWhen you upgrade PE, previous versions remain at /opt/puppet/packages/public. To save space, you can remove files that are no longer needed from this directory.\n\n\n1. Optional: Speed upgrade by cleaning up PuppetDB reports. On your primary server, run '/opt/puppetlabs/ bin/puppetdb delete-reports'\nIf the command fails to execute, you're likely using a version of PuppetDB that doesn't yet include the command. See Upgrade cautions on page 202 for manual steps.\n\n\n2. Download the tarball appropriate to your operating system and architecture.\n\n\n3. Unpack the installation tarball: tar -xf \n\nYou need about 1 GB of space to untar the installer.\n\n\n4. Upgrade your PostgreSQL node.\n\n\na) Ensure that the pe.conf file on your PostgreSQL node is up to date by running puppet infrastructure recover_configuration on your primary server, and then copying '/etc/ puppetlabs/enterprise/conf.d' to the PostgreSQL node.\n\n\nb) Copy the installation tarball to the PostgreSQL node, and from the installer directory, run the installer:\n'sudo ./puppet-enterprise-installer'\n\n5. From the installer directory on your primary server, run the installer: 'sudo ./puppet-enterprise- installer'\n\n\n\u2022 If you want to specify a different pe.conf file other than the existing file, use the '-c' flag: 'sudo ./ puppet-enterprise-installer -c '\n\n\nWith this flag, your previous pe.conf is backed up to '/etc/puppetlabs/enterprise/conf.d/ .conf' and a new pe.conf is created at '/etc/puppetlabs/enterprise/conf.d/ pe.conf'.\n\n\n6. To upgrade compilers, on your primary server logged in as root, run: 'puppet infrastructure upgrade compiler ,'\n\n\n\u2022 To upgrade all compilers simultaneously: 'puppet infrastructure upgrade compiler --all'\n\n\n\u2022 To specify the location of an authentication token other than the default: 'puppet infrastructure upgrade compiler --token-file '\n\n\n7. Upgrade these additional PE infrastructure components.\n\u2022 Agents\n\u2022 PE client tools \u2014 On unmanaged nodes only, re-install the version of client tools that matches the PE version\nyou upgraded to. Client tools are automatically updated on infrastructure nodes and managed nodes when you upgrade PE.\nOptionally convert legacy compilers to the new style compiler running the PuppetDB service.\n\nRelated information\nBack up your infrastructure on page 715\nGenerate a token using puppet-access on page 272", "created": "2022-11-11T07:37:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "\u00a0https://github.com/puppetlabs/puppetlabs-peadm/blob/main/documentation/upgrade.md", "created": "2022-11-11T07:42:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "[~accountid:5bb243ee607be0205f96d28d]\u00a0 highlighted the original instructions were deliberately removed as per [DOC-4836] Clarify XL architectures - Puppet Tickets (puppetlabs.com)", "created": "2022-11-11T08:40:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] Yep, sorry, I was just pasting it here for context for myself.", "created": "2022-11-11T08:47:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Ah sorry just making sure the context was in here (y)", "created": "2022-11-11T09:05:00.000000" } ], "components": [], "created": "2022-11-11T03:04:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2e6feacf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ksbl:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_23128555_*|*_3_*:*_1_*:*_504236_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_255276702" } ], "description": "*Problem:*\n\nCurrently the upgrade documentation at [https://puppet.com/docs/pe/2021.7/upgrading_pe.html#upgrade_xl]\u00a0\nstates to speak to a TAM and doesn't indicate how this should be done.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.7/upgrading_pe.html#upgrade_xl]\u00a0\n\n_Current text :_\n\nFor help upgrading an extra-large installation, reach out to your technical account manager.\n\n_Suggested improvement:_\n\nUpgrading extra-large installations is only supported by using PEADM upgrade plan [puppetlabs/peadm \u00b7 Bolt plans used to deploy an at-scale Puppet Enterprise architecture \u00b7 Puppet Forge|https://forge.puppet.com/modules/puppetlabs/peadm]\n\n*Summary:*\n\nWe should make it clear that extra large is only supported by using PEADM and to perform an upgrade the upgrade plan should be used. I will raise a separate ticket to put PEADM in as the suggested method of installation and upgrade in general", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55074", "fixedVersions": [], "id": "55074", "issueType": "Improvement", "key": "DOCUMENT-1384", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-11-14T08:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The XL upgrade process is currently undocumented", "timeSpent": "PT0S", "updated": "2022-11-14T08:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:61bbace0755091006a2b896a], the docs will be updated at the next CD4PE release. In the meantime, for you reference, the four policy names are:\u00a0\n * {{cd4pe_deployments::direct}}\n * {{cd4pe_deployments::eventual_consistency}}\n * {{cd4pe_deployments::feature_branch}}\n * {{cd4pe_deployments::rolling}}", "created": "2022-11-03T12:56:00.000000" } ], "components": [], "created": "2022-11-02T02:47:00.000000", "creator": "61bbace0755091006a2b896a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4d5d92d2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kod5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_122745080_*|*_3_*:*_1_*:*_209295_*|*_5_*:*_1_*:*_0" } ], "description": "can we please update the cd4pe.yaml\u00a0[documentation|https://puppet.com/docs/continuous-delivery/4.x/structuring_cd4pe_yaml.html]?\n\nthe policy \"Direct merge to Production\" policy key name:\n * {*}_not_{*}:\u00a0{{cd4pe_deployments::direct_merge}}\n * {*}_not_{*}:\u00a0{{direct_merge}}\n * but: {{cd4pe_deployments::direct}}\n\nI only found the right name by managing the pipeline via WebUI and then converting it to code.\n\nThe Documentation of the\u00a0[build-in deployment policies|https://puppet.com/docs/continuous-delivery/4.x/deployment_policies.html]\u00a0is missing the names of the policy keys. The human readable names are in there but not the key which would trigger the policy.\n\u00a0\n{code}\n - type: deployment\n policy: cd4pe_deployments::direct\n name: \"Direct merge to Production\"\n{code}\n\nFor each policy listed on the docu site, how should one know the policy key? Name ist listed, options are liste, but not how to address it.\n\nReferring to the [GitHub Module|https://github.com/puppetlabs/puppetlabs-cd4pe_deployments/blob/main/REFERENCE.md]\u00a0handling these could also be a thing.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55072", "fixedVersions": [], "id": "55072", "issueType": "Bug", "key": "DOCUMENT-1383", "labels": [ "cd4pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61bbace0755091006a2b896a", "resolution": "Fixed", "resolutionDate": "2022-11-03T12:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE documentation on deployment policies", "timeSpent": "PT0S", "updated": "2022-11-03T12:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-11-01T07:26:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@12a33864" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ko3t:" } ], "description": "*Problem:*\n\nIn the [Beginner's guide to writing modules (puppet.com)|https://puppet.com/docs/puppet/7/bgtm.html]\u00a0 It states \"Ensure that your main classes explicitly contain any subordinate classes they declare.\" this has been taken to far by some customers, to use 'contain' instead of 'include' in all modules. While as advised in [https://puppet.com/docs/puppet/7/lang_containment.html#lang_containment] \"Although it may be tempting to use '{{{}contain'{}}} everywhere, it's better to use '{{{}include'{}}} unless there's an explicit reason why it won't work.\"\n\n*Suggested improvement:*\n\n[Beginner's guide to writing modules (puppet.com)|https://puppet.com/docs/puppet/7/bgtm.html]\n\n_Current text :_\nFor more information about containment, see the\u00a0[containment documentation|https://puppet.com/docs/puppet/7/lang_containment.html#lang_containment].\n_Suggested improvement:_\n*This module pattern works using 'contain' since no class is going to be called beyond the main manifest and the ordering matters, but in other application based patterns 'include' should be used.* For\u00a0more information about containment, see the [containment documentation|https://puppet.com/docs/puppet/7/lang_containment.html#lang_containment].\n\n\n*Summary:*\n\nCurrently some customers have read the beginners guide to modules and assumed 'contain' should be used instead of 'include', expanding a bit to highlight what we mean by subordinate class would avoid this confusion\n\nDIscussions had been had with [~accountid:60e30461471e61006a2ea157]\u00a0 and [~accountid:70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04] on this", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54804", "fixedVersions": [], "id": "54804", "issueType": "Improvement", "key": "DOCUMENT-1382", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] BGTWM makes a statement on containment that should be explained more", "timeSpent": "PT0S", "updated": "2023-05-17T18:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68], pe-environment, in this context, is explained more here: [https://puppet.com/docs/pe/2021.7/backing_up_and_restoring_pe.html#back_up_pe_infrastructure]\n\nI will ask about whether the devs could add more detail to the --help command line output.", "created": "2022-11-01T10:43:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] I'm going to create an engineering ticket and close this ticket so they can add the additional sentence: To ensure the configuration is recovered correctly, this must be the environment where your primary server is located.\u00a0", "created": "2022-11-01T10:50:00.000000" }, { "author": "5b64ddd7d1e8dc2d916c6289", "body": "Some people have decided to move all of the infra nodes out of the default {{production}} environment and into something else. Sometimes a dev environment for a dev setup. So it simply means the name of the environment your infrastructure nodes live in.\n\nSplitting the infrastructure between environments is not recommended. It's not something we test and I'm unsure how this and other infra commands might behave.", "created": "2022-11-01T14:03:00.000000" } ], "components": [], "created": "2022-10-31T07:01:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1129f189" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0knop:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_100690398_*|*_6_*:*_1_*:*_0" } ], "description": "Hi,\nI'm on PE 2021.7.1:\n{code}\nroot@puppet ~ # puppet-backup create --help\nUsage: puppet-backup create [options]\n --dir=BACKUP_DIR Directory to save backup file. Defaults to /var/puppetlabs/backups/\n --name=BACKUP_NAME Name to give to backup file. Defaults to pe_backup-.tgz\n --gpgkey=GPG_KEY_ID GPG key ID to be used for encryption. Make sure to import the public key before using this option\n --force Bypass validation checks and ignore warnings.\n --tempdir=PATH The directory for restore activities, defaults to $TMPDIR if set or /tmp if not\n --pe-environment=ENVIRONMENT The environment of the PE Infrastructure. Defaults to production\n --scope=SCOPE Scope of backup to create or restore. ex: --scope=config,certs\n Select 'all', or any combination of the other scope options in a comma-separated list.\n all: (default).\n code: Puppet code deployed to your codedir at backup time.\n config: PE Configuration including license, classification & RBAC settings. Does NOT include puppet_gems or puppetserver_gems.\n puppetdb: PuppetDB data, including facts, catalogs and historical reports.\n certs: PE CA Certificates and full ssl directory.\nroot@puppet ~ #\n{code}\n\nCan you clarify the purpose of the pe-environment variable? Why is that needed? I currently have a PE customer where the primary and a few compilers are in one environment and one compiler in a different environment and I'm wondering how/if this effects the backups.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54803", "fixedVersions": [], "id": "54803", "issueType": "Improvement", "key": "DOCUMENT-1381", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Duplicate", "resolutionDate": "2022-11-01T10:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet-backup: clarify pe-environment option", "timeSpent": "PT0S", "updated": "2022-11-01T14:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Should have been a PUP ticket", "created": "2022-11-08T10:33:00.000000" } ], "components": [], "created": "2022-10-31T05:58:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7681da6b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0knoh:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_711323229_*|*_6_*:*_1_*:*_0" } ], "description": "Hi,\nI think the help for \"puppet node purge\" is a bit misleading:\n\n{code}\n# puppet node --help\n\n\nUSAGE: puppet node [--terminus _TERMINUS]\n\nThis subcommand interacts with node objects, which are used by Puppet to\nbuild a catalog. A node object consists of the node's facts, environment,\nnode parameters (exposed in the parser as top-scope variables), and classes.\n\nOPTIONS:\n --render-as FORMAT - The rendering format to use.\n --verbose - Whether to log verbosely.\n --debug - Whether to log debug information.\n --terminus _TERMINUS - The indirector terminus to use.\n\nACTIONS:\n clean Clean up signed certs, cached facts, node objects, and reports\n for a node stored by the puppetmaster\n deactivate Deactivate a set of nodes in PuppetDB\n decrypt Decrypt a value using the agent's own certificate\n encrypt Encrypt a value using a specified agent's certificate\n exports Return the exports of nodes from puppetdb\n find Retrieve a node object.\n info Print the default terminus class for this face.\n purge Deactivate nodes, delete from inventory, delete PuppetDB data,\n and clean node info from the primary\n status Fetch the current status for a set of nodes in PuppetDB\n\nTERMINI: classifier, exec, json, memory, msgpack, plain, puppetdb, rest, store_configs, yaml\n\nSee 'puppet help node' or 'man puppet-node' for full help.\n#\n{code}\n\n\"Clean\" mentions \"Clean up signed certs\". This isn't mentioned for \"purge\", but it also revokes the certificate:\n\n{code}\n# puppet node purge catalog-diff\nNotice: Certificate for catalog-diff has been revoked\nNotice: Cleaned files related to catalog-diff\nNode \"catalog-diff\" was purged.\n\nTo ensure a node can not check into any compilers, run 'puppet agent -t' on all compilers.\n\nTo re-add a node to your Puppet Enterprise infrastructure:\nOn the node:\n 1. Run 'puppet ssl clean' to purge that node's local certificates.\n 2. Run 'puppet agent -t' to generate a new certificate request.\n# puppet --version\n7.20.0\n#\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54752", "fixedVersions": [], "id": "54752", "issueType": "Improvement", "key": "DOCUMENT-1380", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Duplicate", "resolutionDate": "2022-11-08T10:33:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet node purge documentation is misleading", "timeSpent": "PT0S", "updated": "2022-11-21T01:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "5b64ddd7d1e8dc2d916c6289", "body": "That's correct. What it's trying to say is \"Prior to running the backup, ensure pg_repack will not run while the backup is in progress.\" Also makes good sense to tell users to stop those pe_databases timers just like you write here.", "created": "2022-11-01T14:01:00.000000" } ], "components": [], "created": "2022-10-28T14:25:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@295f9318" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0knmh:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_326274776_*|*_3_*:*_1_*:*_747119_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_171521996" } ], "description": "Hi,\nI was reading through https://puppet.com/docs/pe/2021.7/backing_up_and_restoring_pe.html\nIt says:\n> Important: Make sure pg_repack doesn't run prior to or during the backup process.\n\nWhy prior? This might be my bad English, but I think \"prior\" is wrong here. We just need to ensure that pg_repack isn't running during the backup. The default method for pg_repack is using the pe_databases module: https://puppet.com/docs/pe/2021.7/pe_database_maintenance.html\n\nThat will create three timers:\n* pe_databases-facts.timer\n* pe_databases-catalogs.timer\n* pe_databases-other.timer\n\nSo maybe we should suggest to stop those timer prior to running the backup:\n{code}\nsystemctl stop pe_databases-*.timer\n{code}\n\nAnd enabling them afterwards (for stopping globbing is supported, not for starting):\n{code}\nsystemctl start pe_databases-catalogs.timer pe_databases-facts.timer pe_databases-other.timer\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54747", "fixedVersions": [], "id": "54747", "issueType": "Improvement", "key": "DOCUMENT-1378", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-11-03T08:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet-backup: Clarify pg_repack constraints", "timeSpent": "PT0S", "updated": "2022-11-03T08:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "5b64ddd7d1e8dc2d916c6289", "body": "Seems like a good thing to add.\u00a0 I believe that link actually gives you the curl/wget commands to download things, so maybe don't need to include that here.\n\nAt the link given (and similarly for the other upgrade sections), something like:\n # the tarball for your operating system and architecture.\u00a0 Optionally, download the GPG signature .asc file for the tarball as well.\n # [Optional] Verify the tarball using the .asc file with GPG.\n ## If you have not yet imported the GPG key, download it from the appropriate Puppet Yum or Apt repository ([https://yum.puppet.com/RPM-GPG-KEY-puppet-20250406] or [https://apt.puppet.com/DEB-GPG-KEY-puppet-20250406)] \u00a0 Note we're about to rotate these, so it will have to change soon.\n ## {{gpg \\-\\-import }}\n ## {{gpg \\-\\-verify puppet-enterprise\\-\\*.asc puppet-enterprise\\-\\*.tar.gz}}\n ## Should see something like\u00a0\n{code:java}\ngpg: Signature made Mon 24 Oct 2022 11:20:06 PM UTC using RSA key ID 9E61EF26\ngpg: Good signature from \"Puppet, Inc. Release Key (Puppet, Inc. Release Key) \" {code}\nYou may also see {code} gpg: WARNING: This key is not certified with a trusted signature!\ngpg: There is no indication that the signature belongs to the owner.{code}\nThis just means you haven't signed Puppet's key with our own private key to list it as \"trusted\", which you can do if you want to avoid this message in the future.", "created": "2022-11-01T13:58:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:5b64ddd7d1e8dc2d916c6289] What is the difference between GPG-KEY-puppet-20250406 and the GPG Signature link on the downloads page (ex: [https://d2getqyrpmrvl0.cloudfront.net/released/2021.7.1/puppet-enterprise-2021.7.1-el-8-x86_64.tar.gz.asc] )?", "created": "2022-11-03T09:07:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:5b64ddd7d1e8dc2d916c6289] , [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] : I found that the \"Installing PE\" page already has instructions for verifying the tarball with GPG: [https://puppet.com/docs/pe/2021.7/installing_pe.html#verify_the_installation_package]\u00a0\n\nTo save some rework, I'd like to reuse these existing steps, assuming they are correct. They are slightly different than what Nick posted and might contain extra steps? [~accountid:5b64ddd7d1e8dc2d916c6289] could you verify that they're ok?\n\nOptions:\n * On the Upgrading page, change each \"Download the tarball\" step to \"Download the tarball. Optionally, verify the installation package \"\n * Duplicate \"verify the installation package\" instructions as a section at the beginning of the \"Upgrade PE\" part of the page. I think between \"Configure non-production environments for infrastructure nodes\" and \"Upgrade a standard installation\". I would then add a link to that section in each set of upgrade instructions, similar to the first bullet.\u00a0", "created": "2022-11-03T09:29:00.000000" }, { "author": "5b64ddd7d1e8dc2d916c6289", "body": "[~accountid:616989d3048360006aeb55e8] The .asc file is the file signature for that particular .tar.gz file. The GPG-KEY-puppet is the public key used to verify that signature.\n\nYes, those instructions are just fine, I think. We can simply link to it.", "created": "2022-11-03T09:32:00.000000" } ], "components": [], "created": "2022-10-27T06:46:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a7d9736" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0klzl:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_440123981_*|*_3_*:*_1_*:*_3277742_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_172386471_*|*_10016_*:*_1_*:*_4290" } ], "description": "Hi,\nI was reading through https://puppet.com/docs/pe/2021.7/upgrading_pe.html#upgrade_standard . It basically mentions to download the archive, untar it and run the installer. The download portal supports also gpg signatures. I usually do the verification in this way:\n{code}\ncurl --location --silent --remote-header-name --remote-name \"https://pm.puppet.com/cgi-bin/download.cgi?dist=el&rel=8&arch=x86_64&ver=$version\"\ncurl --location --silent --remote-header-name --remote-name \"https://pm.puppet.com/cgi-bin/download.cgi?dist=el&rel=8&arch=x86_64&ver=$version&type=sig\"\ncurl --location --silent --remote-header-name --remote-name https://yum.puppet.com/RPM-GPG-KEY-puppet-20250406\ngpg --import RPM-GPG-KEY-puppet-20250406\ngpg --verify puppet-enterprise-*.asc puppet-enterprise-*.tar.gz\nif [ $? -ne 0 ]; then\n echo 'GPG verify failed!'\n exit 1\nfi\ntar xfvz puppet-enterprise-*.tar.gz\nrm -rf puppet-enterprise-*tar.gz* RPM-GPG-KEY-puppet-20250406\n{code}\n\nI think it's worth improving the documentation with the GPG steps, because that will increase the security for the users.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54802", "fixedVersions": [], "id": "54802", "issueType": "Improvement", "key": "DOCUMENT-1377", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-11-03T09:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Mention GPG signature verification for PE installations", "timeSpent": "PT0S", "updated": "2022-11-03T09:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] I am honestly surprised no one caught this before. Thank you for your diligence, as always. I'll get it fixed right away. :)\u00a0", "created": "2022-11-01T08:59:00.000000" } ], "components": [], "created": "2022-10-26T13:35:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4cde3790" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kls1:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_501775194_*|*_3_*:*_1_*:*_280330_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_90826017" } ], "description": "There's a typo at:\nhttps://puppet.com/docs/pe/2021.7/configuring_puppet_orchestrator.html#pe-orchestration-settings-jxm-metrics-trapperkeeper\n\nIt's JMX, not JXM\n\n* https://en.wikipedia.org/wiki/Java_Management_Extensions", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55015", "fixedVersions": [], "id": "55015", "issueType": "Bug", "key": "DOCUMENT-1376", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-11-02T10:16:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in configuring_puppet_orchestrator.html", "timeSpent": "PT0S", "updated": "2022-11-02T10:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-10-26T13:30:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5d0c32a3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0klrt:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_502024618_*|*_3_*:*_1_*:*_5958340_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_83885146" } ], "description": "Hi,\nI had a bit of a conversation with Marty Ewings on slack, about the prune threshold for the classifier vs orchestrator. At https://puppet.com/docs/pe/2021.7/config_console.html we have puppet_enterprise::profile::console::classifier_prune_threshold\n and at https://puppet.com/docs/pe/2021.7/config_orchestration.html we have puppet_enterprise::profile::orchestrator::job_prune_threshold. My understanding:\n* job_prune_threshold configures pruning of task/plan/job logs\n* classifier_prune_threshold only purges the history of node checkins (and that's disabled by default because puppet_enterprise::profile::console::classifier_node_check_in_storage is false)\n\nmaybe it makes sense to clarify the documentation (and verify if my assumptions are correct). And Maybe add a link between the two sections? I got the feedback from PE users that it's not very clear how orchestrator vs classifier differentiate and what the pruning effects.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54828", "fixedVersions": [], "id": "54828", "issueType": "Improvement", "key": "DOCUMENT-1375", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-11-02T09:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Enhance classifier_prune_threshold documentation", "timeSpent": "PT0S", "updated": "2022-11-02T09:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi Bram,\n\nIt appears that email address is affiliated with Atlassian itself.\u00a0\n\nI am not sure what you mean by three Puppet accounts. Could you let me know what projects or teams they are associated with so I can look for them? Also, I am assuming you mean these are Jira accounts?\n\nAs for unsubscribing from the emails, do the emails contain Puppet-specific content? If so, please let me know. If not, I would recommend reaching out to Atlassian directly.\n\n[https://www.atlassian.com/company/contact]\u00a0", "created": "2022-10-24T07:05:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi Bram,\n\nAs a follow on to my earlier comment, I need your name and email address for each Jira account you would like us to delete and we will delete them for you.", "created": "2022-10-24T07:12:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:999854:8212f386-396b-4210-b75f-128490489795], I'm just reaching out again to see if you saw my earlier comments. I'll need the name and email address for each Jira account you need us to delete.", "created": "2022-11-01T08:56:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:999854:8212f386-396b-4210-b75f-128490489795]. I am not sure what the other two entries are but for the Jira entry, we are migrating to Jira cloud. An email was sent last week containing instructions for deleting unwanted accounts. Please try the steps here to delete: [https://support.atlassian.com/atlassian-account/docs/delete-your-atlassian-account/]\u00a0", "created": "2022-12-19T06:49:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:999854:8212f386-396b-4210-b75f-128490489795] - The second one (projects.puppetlabs.com) is an old Jira URL.", "created": "2022-12-19T07:14:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "I've submitted a ticket to our IT system to delete your account. I'm going to close this since I can't take any further action on it here.", "created": "2023-01-10T12:09:00.000000" }, { "author": "6201b4f3e5caff0070e1ee79", "body": "For documentations purposes I'm commenting here to add the following had to be done to complete the user's account deletion request:\n * all user comments had to be deleted\n * this ticket had to be reassigned(I chose myself because I processed the account deletion)\n\nThe account has been successfully deleted.", "created": "2023-01-12T11:20:00.000000" } ], "components": [], "created": "2022-10-22T08:11:00.000000", "creator": "999854:8212f386-396b-4210-b75f-128490489795", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@d8f2507" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kkrt:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_2666248967_*|*_4_*:*_1_*:*_716375642_*|*_5_*:*_1_*:*_280069_*|*_6_*:*_2_*:*_3546989753" } ], "description": "Hi,\n\nI've recently started receiving some emails from Atlassian Support (no-reply) (Jira) .\n\nTo unsubscribe I tried to access the 3 different puppet accounts I had from 2014.\n\nAfter resetting my password on this site I was able to log on but I can't find a way to unsubscribe from all emails.\n\nI'm also unable to find a way to delete this account completely.\n\nThe help link goes to a generic Atlassian site and the account delete request of that site is not linked to the account on this site.\n\nHow can I completely unsubscribe from these emails and remove this account to limit exposure of my data?\n\nThanks in advance", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55070", "fixedVersions": [], "id": "55070", "issueType": "Bug", "key": "DOCUMENT-1374", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6201b4f3e5caff0070e1ee79", "resolution": "Incomplete", "resolutionDate": "2023-01-10T12:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "How to unsubscribe and delete account", "timeSpent": "PT0S", "updated": "2023-01-12T11:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "There is also a PE support ticket, ID 49986.", "created": "2022-10-21T06:51:00.000000" } ], "components": [], "created": "2022-10-21T05:45:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3ed1b815" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kiex:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_17026974_*|*_3_*:*_1_*:*_5354893836_*|*_5_*:*_1_*:*_0" } ], "description": "Hi,\nplease have a look at:\n* https://puppet.com/docs/pe/2019.8/code_mgr_customizing.html#code-mgr-customize-module-deploy-scope\n* https://puppet.com/docs/pe/2021.7/code_mgr_customizing.html#code-mgr-customize-module-deploy-scope\n\nI checked PE 2021.7 and 2019.8.12, both don't have the full_deploy parameter in /opt/puppetlabs/puppet/modules/puppet_enterprise/manifests/master/code_manager.pp", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54744", "fixedVersions": [], "id": "54744", "issueType": "Bug", "key": "DOCUMENT-1373", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-12-22T08:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Code Manager docs - Can't manage full_deploy parameter", "timeSpent": "PT0S", "updated": "2022-12-22T08:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-10-21T01:22:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@15e359e4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kib5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_24248726_*|*_3_*:*_1_*:*_267580_*|*_5_*:*_1_*:*_0" } ], "description": "Hi!\nI was checking through https://puppet.com/docs/pe/2021.7/config_console.html\nIt mentions many parameters and their default value. However, puppet_enterprise::profile::console::classifier_prune_threshold, is missing the default value. Can you please add it?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54801", "fixedVersions": [], "id": "54801", "issueType": "Improvement", "key": "DOCUMENT-1372", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-10-21T08:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "classifier_prune_threshold has no default value", "timeSpent": "PT0S", "updated": "2022-10-26T13:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-10-19T06:59:00.000000", "creator": "607d67fd7495ff006ad4ade5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@31f329d5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kp0m:" } ], "description": "I've found typo on very bottom of page [https://puppet.com/docs/puppet/7/experiments_msgpack.html#experiments_msgpack]\n\n{quote}\nIn the [agent] or [main] section of puppet.conf on any number of agent nodes, set the preferred_serialization_format setting to msgpack. Read about the preferred_serialization_forat setting in the Configuration Reference.\n{quote}\n\n\"preferred_serialization_*forat*\"", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54464", "fixedVersions": [], "id": "54464", "issueType": "Bug", "key": "DOCUMENT-1371", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "607d67fd7495ff006ad4ade5", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet 7(latest): typo on \"Experimental features -> Msgpack support\" page", "timeSpent": "PT0S", "updated": "2023-05-17T18:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] Thank you for confirming with Cas. I will fix this today. You'll see it in production when 2021.7.1 comes out.", "created": "2022-10-17T08:17:00.000000" } ], "components": [], "created": "2022-10-14T10:43:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c50f556" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k8x5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_250334630_*|*_3_*:*_1_*:*_1002792_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_105930" } ], "description": "*Problem:*\n\nThe list of unimplemented functions is incorrect including a functions that is implemented and further down we mention a function that is not implemented\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.7/plans_limitations.html\n\n_Current text :_\n\n\"\n_The following\u00a0Bolt\u00a0plan functions don't work in\u00a0PE\u00a0because they haven\u2019t been implemented yet or cause issues during plan runs:_\n * {{add_to_group}}\n * {{background}}\n * {{dir::children}}\n * {{download_file}}\n * {{file::exists}}\n * {{file::read}}\n * {{file::readable}}\n\n\"\n\nand\n\"\nWhen using\u00a0{{{}run_script{}}},\u00a0{{{}download_file{}}}, or\u00a0{{file::read}}\u00a0the source location for the files\u00a0*must*\u00a0be from a\n\"\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\n\"\nThe following Bolt\u00a0plan functions don't work in\u00a0PE\u00a0because they haven\u2019t been implemented yet or cause issues during plan runs:\n * {{add_to_group}}\n * {{background}}\n * {{dir::children}}\n * {{download_file}}\n * {{file::exists}}\n * {{*-file::read-*}}\n * {{file::readable}}\n\n{{}}\n\"\nWhen using {{{}run_script{}}},\u00a0{{{}-*download_file*-{}}}, or\u00a0{{file::read}}\u00a0the source location for the files\u00a0*must*\u00a0be from a\n\"\n\n*Summary:*\n\nThere is a issue with the listed unimplemented functions which includes one that is implemented and further in the text we mention one of the unimplemented task\n\n\u00a0See [~accountid:5ade3a9f91bc312e6a4a30f3] [https://puppet.slack.com/archives/CF466J51Q/p1665759367616919] confirmation", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54740", "fixedVersions": [], "id": "54740", "issueType": "Improvement", "key": "DOCUMENT-1370", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-10-17T08:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The list of unimplemented functions is incorrect", "timeSpent": "PT0S", "updated": "2022-10-17T08:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:1134d60c-31df-407a-b573-e0cfaef8865e] Permissions depend on the specific source control provider, so they are described on this page: [https://puppet.com/docs/continuous-delivery/4.x/integrations.html]\u00a0", "created": "2022-10-14T08:32:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:1134d60c-31df-407a-b573-e0cfaef8865e] I'm going to look at those pages and see if maybe I can add a link somewhere to the integrations page, and then I'll close this. The change will get published at the next CDPE release.", "created": "2022-10-17T09:08:00.000000" }, { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "Perfect, thanks [~accountid:616989d3048360006aeb55e8]!", "created": "2022-10-17T09:11:00.000000" } ], "components": [], "created": "2022-10-14T06:56:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a9538ca" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k8vd:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "49820" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_267047318_*|*_3_*:*_1_*:*_846964_*|*_5_*:*_1_*:*_0" } ], "description": "The following docs describe how control repo branches should be set when working with cd4pe:\nhttps://puppet.com/docs/continuous-delivery/4.x/git_branches.html\nhttps://puppet.com/docs/continuous-delivery/4.x/working_with_cd4pe.html#working_with_cd4pe\n\nCustomer has requested \"I think noting what permissions should be set in the git repos would be a valuable addition to the docs because it will help customers avoid messing up their repos and, therefore, workflows, especially customers new to git.\"", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54463", "fixedVersions": [], "id": "54463", "issueType": "Improvement", "key": "DOCUMENT-1369", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2022-10-17T09:21:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Permission details for git repos and branches in cd4pe", "timeSpent": "PT0S", "updated": "2022-10-17T09:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeestimate": "28800", "aggregatetimeoriginalestimate": "28800", "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "We merged feature-cem-preview into 2.x-preview.\u00a0\n\nWe are keeping feature-cem-preview as a sandbox for Heston's automation.\n\nAny further, permanent changes should be made on 2.x-preview.", "created": "2022-10-13T14:33:00.000000" } ], "components": [], "created": "2022-10-12T12:52:00.000000", "creator": "623a434701f8660070b62e0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The new CEM documentation should look good on the preview server, and links between the new CEM topics and Comply topics should work." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5dd1ec44" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [ "616989d3048360006aeb55e8", "623a434701f8660070b62e0a" ] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k821:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_92485088_*|*_5_*:*_1_*:*_0" } ], "description": "We should do this task together with April so that we can resolve any merge conflicts and ensure that everything looks good.", "duedate": "2022-10-18T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT28800S", "externalId": "55014", "fixedVersions": [], "id": "55014", "issueType": "Task", "key": "DOCUMENT-1368", "labels": [], "originalEstimate": "PT28800S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a434701f8660070b62e0a", "resolution": "Fixed", "resolutionDate": "2022-10-13T14:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Merge CEM documentation so that it appears on the Comply preview server", "timeSpent": "PT0S", "updated": "2022-10-13T14:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "There are some places where {{--data\\}} is used for query params, like in the [activity docs|https://puppet.com/docs/pe/2021.7/activity_api_events.html#activity-api-v2-get-events]. These should be {{--data-urlencode}} as they will be inserted into the url for the GET request.\n\nExample:\n\n{code}\ncurl -k -X GET -H \"X-Authentication: $TOKEN\" \\\n -G \"https://$(hostname -f):4433/activity-api/v2/events\" --data-urlencode 'order=desc' --data-urlencode 'limit=10' --data-urlencode 'query=[{\"subject_id\":\"42bf351c-f9ec-40af-84ad-e976fec7f4bd\",\"subject_type\":\"users\"}]'\n{code}", "created": "2022-10-12T12:23:00.000000" } ], "components": [], "created": "2022-10-12T12:02:00.000000", "creator": "616989d3048360006aeb55e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4b15a076" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k80x:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_85089643_*|*_3_*:*_1_*:*_73704602_*|*_5_*:*_1_*:*_0" } ], "description": "Any non-GET calls need to be curl -X PUT, curl -X POST, etc. instead of 'curl PUT' etc.\n\n\u00a0\n\nfor Get, you either leave it off or\u00a0 have to specify -X GET\n\n\u00a0\n\nData:\n\nactivity-api-v2-get-events-csv.dita\n\nactivity-api-v2-get-events.dita\n\n-G", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54368", "fixedVersions": [], "id": "54368", "issueType": "Bug", "key": "DOCUMENT-1367", "labels": [ "large", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "616989d3048360006aeb55e8", "resolution": "Fixed", "resolutionDate": "2022-10-14T08:09:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE curl commands", "timeSpent": "PT0S", "updated": "2022-10-14T08:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [ "Website & IA" ], "created": "2022-10-10T21:31:00.000000", "creator": "623c0f891c7f6a007049e734", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@520bf70a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k5xd:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38284272_*|*_3_*:*_1_*:*_457064_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_4033895" } ], "description": "*Problem:*\n\nThe installation documentation for PE agents uses harmful terminology that is likely outdated to boot.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.7/installing_windows_agents.html#installing_windows_agents\n\n_Current text :_\n\nYour command likely includes additional arguments, such as {{{}/l*v{}}}, {{{}PUPPET_AGENT_CERTNAME{}}}, or any other valid [MSI properties|https://puppet.com/docs/pe/2021.7/installing_windows_agents.html#msi_properties]. For example, this {{msiexec}} command installs the agent with a primary server located at {{{}puppet.acme.com{}}}:\n\u00a0\n{{msiexec /qn /norestart /i .msi PUPPET_MASTER_SERVER=puppet.acme.com}}\n\n_Suggested improvement:_\n\nYour command likely includes additional arguments, such as {{{}/l*v{}}}, {{{}PUPPET_AGENT_CERTNAME{}}}, or any other valid [MSI properties|https://puppet.com/docs/pe/2021.7/installing_windows_agents.html#msi_properties]. For example, this {{msiexec}} command installs the agent with a primary server located at {{{}puppet.acme.com{}}}:\n\u00a0\n{{msiexec /qn /norestart /i .msi {*}PUPPET_SERVER{*}=puppet.acme.com}}\n\n*Summary:*\n\nNote that this is just one example that I found in passing. I would recommend a large scale grep of the website source to find all instances of the term.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54799", "fixedVersions": [], "id": "54799", "issueType": "Improvement", "key": "DOCUMENT-1366", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0f891c7f6a007049e734", "resolution": "Fixed", "resolutionDate": "2022-10-11T09:24:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PE harmful terminology in msiexec command", "timeSpent": "PT0S", "updated": "2022-10-11T09:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-10-06T15:24:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e98c3d2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k535:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_405974604_*|*_3_*:*_1_*:*_2511088_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4413937" } ], "description": "*Problem:*\n\nCurrently, the real difference between Bolt and Ace servers is not clear and they sound very similar\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.7/pe_architecture_overview.html#orchestration_services-ace]\n\nThis page only mentions ACE server and not Bolt Server\n\n[https://puppet.com/docs/pe/2021.7/what_gets_installed_and_where.html#services_installed]\n\nProvides no definition of what they do\n\n[https://puppet.com/docs/pe/2021.7/running_jobs_with_puppet_orchestrator_overview.html]\n\n\n\nDoesn't mention Bolt Server\n\n[https://puppet.com/docs/pe/2021.7/configuring_puppet_orchestrator.html]\n\nGives a definition of Bolt and Ace server which are hard to distinguish.\n\n{*}changes{*}.\n\nTo change above I would suggest:\n\nNoting that Bolt-Server works with agentless nodes that can use WinRM or SSH and ACE works with devices like network switches and firewall devices over other transports such as panos, F5 and any custom transport defined with the resource API\u00a0\n\nAlso taking the definitions functions we got from [~accountid:5ade3a9f91bc312e6a4a30f3] [https://puppet.slack.com/archives/CGJ0GTF4Y/p1665068351988239?thread_ts=1665061552.929949&cid=CGJ0GTF4Y]\u00a0\n\n\nAce-serve works has two main functions: # Apply catalogs on \"remote\" targets (for example a network switch that cannot run an agent package)\n # Run tasks over a remote transport (a transport you define with the resource API)\n\n\nBolt-server has three functions: # Compute metadata for module content\n # Run actions (tasks, commands etc) over SSH\n # Run actions (tasks, commands, etc) over WinRM\n\n*Summary:*\n\nUpdate ACE and Bolt server definitions to be clear.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54267", "fixedVersions": [], "id": "54267", "issueType": "Improvement", "key": "DOCUMENT-1365", "labels": [ "medium", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-10-11T10:06:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Bolt and ace are poorly defined in docs", "timeSpent": "PT0S", "updated": "2022-10-11T10:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5ade3a9f91bc312e6a4a30f3", "body": "[~accountid:609a8eb65998a60068d12a0a] Bolt docs are managed in the bolt repo. For small changes like this it would be awesome (and much faster) if you could just raise PRs with the small edits to the project. We have automation that we can run to transcribe the markdown in the repo to the website format. Here is an example for this ticket https://github.com/puppetlabs/bolt/pull/3157", "created": "2022-10-11T09:28:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "[~accountid:5ade3a9f91bc312e6a4a30f3] cool no worries I can do that", "created": "2022-10-11T09:58:00.000000" } ], "components": [], "created": "2022-10-06T15:11:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3fa50ec2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k52p:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_667347947_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nThe bolt porjects page only shows the Unix version of the bolt command and not the powershell cmdlet which is out of step with the other docs\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/bolt/latest/projects.html\n\n_Current text :_\n\nRun\u00a0{{bolt project init}}\n\n_Suggested improvement:_\n\nRun\u00a0{{bolt project init}} *for *NIX shell command or {{New-BoltProject for PowerShell cmdlet}}*\n\n*Summary:*\n\nAdd the PowerShell cmdlet version to bolt project doc", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55068", "fixedVersions": [], "id": "55068", "issueType": "Improvement", "key": "DOCUMENT-1364", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-10-14T08:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]Bolt missing PowerShell example in bolt projects page", "timeSpent": "PT0S", "updated": "2022-10-14T08:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:557058:8b915655-a6c3-4c09-9070-53484ff60ff3], this endpoint was changed in response to CVE-2020-7943. Unfortunately, we missed updating that page.\n\nFrom PE 2019.8. and later, you'll need to use 'https://' to access 'metrics/v2' for any service, and you must present authorization in the form of a Puppet certificate.\n\nI hope this helps, and thank you for submitting this ticket. We'll get that page updated.", "created": "2022-10-17T09:50:00.000000" } ], "components": [], "created": "2022-10-06T12:24:00.000000", "creator": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@186d953d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k51t:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_941466451_*|*_10007_*:*_1_*:*_1211591258_*|*_3_*:*_1_*:*_2480668_*|*_5_*:*_1_*:*_0" } ], "description": "The [PuppetDB documentation about Metrics API v2|https://puppet.com/docs/puppetdb/7/api/metrics/v2/jolokia.html] says:\n{quote}The Jolokia API is enabled by default with access restricted to localhost.\n{quote}\nHowever, trying with the default config an unauthenticated query from the local node does not work:\n\n{{% curl http://localhost:8080/metrics/v2/list}}\n{{Forbidden request: /metrics/v2/list (method :get). Please see the server logs for details.}}\n\nThe log says:\n\n{{2022-10-06T14:07:41.316-04:00 ERROR [p.t.a.rules] Forbidden request: 127.0.0.1 access to /metrics/v2/list (method :get) (authenticated: false) denied by rule 'puppetlabs puppetdb metrics'.}}\n\nIt looks like the [default configuration|https://github.com/puppetlabs/puppetdb/blob/b3d6d10555561657150fa70b6d1e609fba9c0eda/resources/ext/config/conf.d/auth.conf#L25-L37] actually only works on the https endpoint, with any trusted client certificate, and from any location.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54738", "fixedVersions": [], "id": "54738", "issueType": "Bug", "key": "DOCUMENT-1363", "labels": [ "pe", "PuppetDB" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "resolution": "Fixed", "resolutionDate": "2022-10-31T11:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Wrong information about PuppetDB metrics v2 endpoint", "timeSpent": "PT0S", "updated": "2022-10-31T11:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-10-06T11:23:00.000000", "creator": "6086bf63f558240070e4f8dc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@768df157" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k51d:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_420959230_*|*_3_*:*_1_*:*_710065_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1878842_*|*_10016_*:*_1_*:*_504351" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n # [PAM HA offline installation steps: https://puppet.com/docs/continuous-delivery/4.x/pam/pam-ha-offline-install.html|https://puppet.com/docs/continuous-delivery/4.x/pam/pam-ha-offline-install.html]\u00a0\n # PAM HA online installation steps: [https://puppet.com/docs/continuous-delivery/4.x/pam/pam-ha-online-install.html]\u00a0\n\nInclude the text that should be corrected or improved here.\n\nSpecifically the PAM HA offline guide, in step No.5, it should stress the fact that customers need to follow this step 3 times, to end up with the minimum requirement of 3 master nodes. The PAM HA online guide does include that.\n\n_5. Follow instructions outlined after the following line in the install script:_\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*5. Add two additional primary nodes to the installation by following the instructions in the install script*\n\n*----*\n\n*Also extra change*\n * Is it possible to refer to the HA architecture overview? In both online/offline cases? [https://puppet.com/docs/continuous-delivery/4.x/pam/pam-node-arch.html#pam-sys-reqs-ha-arch]\u00a0\n\n*Summary:*\n\nMaking sure the customer understands the HA requirements, and that they end up with a valid and recommended Kubernetes cluster. If the customer misses this step, they will have to re-install the cluster. We want to avoid that.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54462", "fixedVersions": [], "id": "54462", "issueType": "Improvement", "key": "DOCUMENT-1362", "labels": [ "PAM" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6086bf63f558240070e4f8dc", "resolution": "Fixed", "resolutionDate": "2022-10-11T09:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PAM HA installation steps need a note", "timeSpent": "PT0S", "updated": "2022-10-11T09:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-09-30T07:42:00.000000", "creator": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3357364d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k281:" } ], "description": "*Problem:*\n\nThe [https://puppet.com/docs/puppet/7/man/agent.html] puppet agent manpage includes several references to the puppet master in the textual part of the page.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/man/agent.html\n\nAll references to puppet master (except --masterport) should be converted to puppet server or primary server.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54736", "fixedVersions": [], "id": "54736", "issueType": "Bug", "key": "DOCUMENT-1361", "labels": [ "generated-docs", "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Harmful terminology in OSP docs/man page", "timeSpent": "PT0S", "updated": "2023-01-10T12:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in upcoming versions", "created": "2022-10-26T09:38:00.000000" } ], "components": [], "created": "2022-09-30T07:30:00.000000", "creator": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7a13c79c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k27l:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Oct/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1480115733_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_773975004" } ], "description": "*Problem:*\n\nThe roles and profiles section of documentation ([https://puppet.com/docs/puppet/7/roles_and_profiles_example.html,] to start) contains continued and inconsistent use of harmful terminology.\u00a0 Specifically, the graphics have been updated to to refer to jenkins:: primary, but the text still references jenkins::master.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/roles_and_profiles_example.html] and others in this section\n\n_Current text :_\n\nMultiple instances of using jenkins:: master instead of jenkins:: primary.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54461", "fixedVersions": [], "id": "54461", "issueType": "Improvement", "key": "DOCUMENT-1360", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "resolution": "Fixed", "resolutionDate": "2022-10-26T09:38:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Roles and Profiles docs reference harmful terminology", "timeSpent": "PT0S", "updated": "2022-10-26T09:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5ade3a9f91bc312e6a4a30f3", "body": "There is no direct link in the bolt docs (the thing I can change by committing code to the bolt repo). The dead link is in [~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b] s blog. [~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b] can you edit the blog to just take away that reference?\u00a0", "created": "2022-09-29T16:31:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "[~accountid:5faaeec70b4e3a006b01eb00]\u00a0can you\u00a0update the end of the blog in question with wording like such:\n{code}And then when you've got more time and are ready to learn more, come back and [check out the more advanced features.](https://puppet.com/docs/bolt/latest/bolt.html).\n{code}\nand change the first \"learn more\" link to\n - Try the [Getting started with Bolt!]([https://puppet.com/docs/bolt/latest/getting_started_with_bolt.html]) guide.", "created": "2022-10-11T09:44:00.000000" }, { "author": "5faaeec70b4e3a006b01eb00", "body": "Updated!", "created": "2022-10-11T10:09:00.000000" } ], "components": [ "bolt" ], "created": "2022-09-28T15:56:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@10ca5234" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0k0qp:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Sep/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1202606153_*|*_5_*:*_1_*:*_0" } ], "description": "A customer has notified us in Support that a link on this page: [https://puppet.com/docs/bolt/latest/bolt.html]\n\n...takes you to this blog: [https://puppet.com/blog/automating-from-zero-to-something/]\n\n...which then links you to this dead page: [https://puppetlabs.github.io/bolt/]\n\nI understand the hands-on lab was deprecated and archived at: [https://github.com/puppetlabs/tasks-hands-on-lab]\n\nThe old link should either be updated or removed as deprecated.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54825", "fixedVersions": [], "id": "54825", "issueType": "Task", "key": "DOCUMENT-1359", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2022-10-12T13:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Bolt Hands-On Lab goes to 404, still linked via Bolt Docs", "timeSpent": "PT0S", "updated": "2022-10-12T13:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-09-26T19:28:00.000000", "creator": "615e4481c669a600697e6e4c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7bc3b86c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0jyuh:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_53277608_*|*_3_*:*_1_*:*_1091197_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_169199628_*|*_10005_*:*_1_*:*_31521" } ], "description": "Currently in orchestration configuration page, either [2021.7|https://puppet.com/docs/pe/2021.7/config_orchestration.html] or [2019.8|[https://puppet.com/docs/pe/2019.8/config_orchestration.html],] task concurrency has the below definition\n{quote}{{puppet_enterprise::profile::orchestrator::task_concurrency}}\n\nAn integer representing the number of simultaneous task or plan actions that can run at the same time. All task and plan actions are limited by this concurrency limit regardless of transport type (WinRM, SSH, PCP).Default:\u00a0{{250}}\u00a0actions\n{quote}\nSome customers interpret this concurrency as the \"number of tasks initiated regardless how many nodes are involved\" - this is apparently wrong. We need to update the document to clearly indicate that the each node that is actively running the tasks (any task type) will take 1 slot, if there is a task involving more than 250 nodes, only 250 nodes can execute immediately and the rest will need to queue and wait.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54618", "fixedVersions": [], "id": "54618", "issueType": "Improvement", "key": "DOCUMENT-1358", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "615e4481c669a600697e6e4c", "resolution": "Fixed", "resolutionDate": "2022-09-29T09:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Make \"task concurrency\" definition more clear", "timeSpent": "PT0S", "updated": "2022-09-29T09:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in upcoming versions", "created": "2022-09-28T09:05:00.000000" } ], "components": [], "created": "2022-09-15T11:05:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ca3d722" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0jrfl:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Sep/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_428211973_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_687754223" } ], "description": "*Problem:*\n\nGlobal resource defaults are considered bad practice now since they reduce visibility and can cause unexpected results, so we should remove the example even if the capability is still there.\n\n*Suggested improvement:*\n\n[Classifying nodes (puppet.com)|https://puppet.com/docs/puppet/7/nodes_external.html#comparing_encs_and_node_definitions]\n\n_Current text :_\n\nEven if you aren\u2019t using node definitions, you can still use\u00a0{{site.pp}}\u00a0to do things like set global resource defaults.\n\n_Suggested improvement:_\n\n_*DELETE*_\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*Summary:*\n\nGlobal resource defaults are considered bad practice now since they reduce visibility and can cause unexpected results, so we should remove the example even if the capability is still there.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55067", "fixedVersions": [], "id": "55067", "issueType": "Bug", "key": "DOCUMENT-1357", "labels": [ "osp", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-09-28T09:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Remove example of global resource default from classify node docuemntation", "timeSpent": "PT0S", "updated": "2022-09-28T09:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in upcoming versions", "created": "2022-09-28T09:02:00.000000" } ], "components": [], "created": "2022-09-15T10:54:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@33e8e2be" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0jrfd:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Sep/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_428987171_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_687450595" } ], "description": "*Problem:*\n\nThe codedir documentation refers to it containing the hiera data and configuration which has moved some time ago to the confdir while there is backward compatibility as stated at ([https://puppet.com/docs/puppet/7/configuration.html#hiera-config]) this is no longer the intended setup\n\n*Suggested improvement:*\n\n_[Code and data directory (codedir) (puppet.com)|https://puppet.com/docs/puppet/7/dirs_codedir.html]_\n\n_Current text :_\n\na global modules directory for all environments, and your\u00a0Hiera\u00a0data and configuration.\n\nThe codedir contains environments, including manifests and modules, a global modules directory for all environments, and\u00a0Hiera\u00a0data.\n\n_Suggested improvement:_\n\n_a global modules directory for all environments{*}-, and your\u00a0Hiera\u00a0data and configuration.-{*}_\n\nThe codedir contains environments, including manifests{*},{*} *-and-* modules, and a global modules directory for all environments{*}-, and Hiera\u00a0data-{*}.\n\n \\{*}changes{*}.\n\n*Summary:*\n\nRemove mentions of Hiera data in codedir documentation", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55013", "fixedVersions": [], "id": "55013", "issueType": "Bug", "key": "DOCUMENT-1356", "labels": [ "osp", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-09-28T09:02:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Remove mentions of Hiera data in codedir documentation", "timeSpent": "PT0S", "updated": "2022-09-28T09:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] Hi, it looks like we weren't notified to include this as a known issue. I'm asking around whether it should be in the OSP known issues or the PE known issues.\n\nUsually PUP tickets would go in OSP known issues: [https://puppet.com/docs/puppet/7/known_issues_puppet.html]\u00a0\n\nWhich are replicated into PE docs here: [https://puppet.com/docs/pe/2021.7/osp/known_issues_puppet.html]\u00a0\n\nUnfortunately someone has to tell us to include them lol :)\u00a0\n\nEdit/Update: It will go into the OSP known issues and then get replicated over to PE docs through there.\u00a0", "created": "2022-09-02T09:32:00.000000" }, { "author": "60e4906e4134aa006931a5d6", "body": "[~accountid:616989d3048360006aeb55e8] this one's done as well, not sure if you need to do anything else or if I can just close", "created": "2022-09-09T09:40:00.000000" } ], "components": [], "created": "2022-08-31T00:34:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@40327a3a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0jdax:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Sep/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_204797190_*|*_10007_*:*_1_*:*_25546129_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_2186245_*|*_10006_*:*_1_*:*_862076420" } ], "description": "Hi,\nI'm not sure what qualifies for the known issues section in https://puppet.com/docs/pe/2019.8/known_issues_pe.html#known_issues_pe / https://puppet.com/docs/pe/2021.7/known_issues_pe.html#known_issues_pe\n\n* There was a regression in 2019.8.10\n* 2019.8.11 fixed parts of it\n* https://puppet.atlassian.net/browse/PUP-11595 documents the remaining regression\n* The same bug is present in 2021.7 and 2021.8\n\nSo it might be good to add PUP-11595 to the known issues?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54367", "fixedVersions": [], "id": "54367", "issueType": "Improvement", "key": "DOCUMENT-1355", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-09-12T16:37:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE 2019/2021 known issues: PUP-11595 is missing", "timeSpent": "PT0S", "updated": "2022-09-12T16:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:6220dbd449c90000701fd0c5],\u00a0/data/packages/public is the correct directory. For script/online installs, the package is downloaded to /staging/ and then copied to /packages/.\n\nFor the offline install, you can place the tarball directly in the appropriate /packages/ location.", "created": "2022-08-30T08:37:00.000000" }, { "author": "6220dbd449c90000701fd0c5", "body": "[~accountid:616989d3048360006aeb55e8]\u00a0\nHmm, in [https://puppetlabs.zendesk.com/agent/tickets/49274] we had to do as above, unless we missed something. Jarret is the one who keyed me on to the directory difference", "created": "2022-08-30T09:03:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:6220dbd449c90000701fd0c5] -Was this specifically the \"upgrade without internet\" process? I think that's the only one where the user directly interacts with the directories. [https://puppet.com/docs/pe/2021.6/upgrading_agents.html#upgrade_agents_without_internet_access]-\n\n\u00a0\n\nEdit: I see it now where he said it was offline.", "created": "2022-08-30T09:12:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:6220dbd449c90000701fd0c5] PE release is today, so I can't edit docs right now. I will work this ticket after the release.", "created": "2022-08-30T09:20:00.000000" } ], "components": [], "created": "2022-08-25T08:59:00.000000", "creator": "6220dbd449c90000701fd0c5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17e5c8b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0j1u9:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Aug/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_429842191_*|*_3_*:*_1_*:*_1389919_*|*_4_*:*_1_*:*_4426_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3368425_*|*_10006_*:*_1_*:*_610052715" } ], "description": "*Problem:*\n\nDocs specifies wrong directory\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.6/upgrading_agents.html\n\n_Current text :_\n\n`{{{}/opt/puppetlabs/server/data/packages/public///{}}}.`\n\n_Suggested improvement:_\n\n{{{}`/opt/puppetlabs/server/data/staging/{}}}{{{}//{}}}{{{}.`{}}}\n\n*Summary:*\n\nUpgrading agent info specifies wrong path. Will need verified and fixed.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54863", "fixedVersions": [], "id": "54863", "issueType": "Bug", "key": "DOCUMENT-1353", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbd449c90000701fd0c5", "resolution": "Fixed", "resolutionDate": "2022-09-06T11:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Upgrading agents specifies wrong file path", "timeSpent": "PT0S", "updated": "2022-09-06T11:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] Hi, thanks for bringing this up. I'm going to revise the documentation to clarify this, but the job_prune_threshold Puppet parameter sets the job-prune-days-threshold parameter in orchestrator.conf. The minimum represented in the docs is actually the minimum of job-prune-days-threshold.\n\nThe parameter also has a minimum of 2 (can't be nil). So it has to have an integer of some value.\n\nThe engineers would like to know more about what you're seeing retained in your history, since this could be an indication of a bug. Could you let me know more about what isn't being pruned (such as tasks, plans, puppet deploys, etc.) and what version you're seeing this on?", "created": "2022-08-23T15:24:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] The engineers did some more testing and found that there is a bug here that seems to have been introduced in 2019.8.10. There is a bug in calculating the age of the stored reports. They said the temporary fix is to restart pe-orchestration-services. That should prune your reports. You might need to periodically restart the service until the bug is fixed if too much is being retained.", "created": "2022-08-23T15:37:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] I've updated the parameter's description explaining how it gets its default value, and I added a known issue for the purging calculation bug.\n\nThe development work to fix the bug is being tracked on another issue for a future release. I'm going to close this ticket since the documentation work is complete.", "created": "2022-08-24T10:00:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "Hi,\nthanks for the explanation. I can confirm this. I had a history back to May this year. That's when I upgraded from 2019.8.9 to 2019.8.11. after restarting the pe-orchestration-service I see this:\n{code}\n# zgrep -i deleted /var/log/puppetlabs/orchestration-services/orchestration-services-2022-08-23.0.log.gz\n2022-08-23T06:43:02.313+02:00 INFO [84b5de01-c9c0-4462-b4fe-3c39b11cb9cb_Worker-10] [p.o.scheduled-job-manager] Deleted 0 scheduled job runs older than 30 days\n2022-08-23T06:43:02.536+02:00 INFO [84b5de01-c9c0-4462-b4fe-3c39b11cb9cb_Worker-10] [p.o.job] Deleted 0 jobs older than 30 days\n2022-08-23T06:43:02.540+02:00 INFO [84b5de01-c9c0-4462-b4fe-3c39b11cb9cb_Worker-10] [p.o.plan-job] Deleted 0 plan-jobs older than 30 days\n2022-08-23T11:29:45.618+02:00 WARN [clojure-agent-send-off-pool-241744] [o.e.j.i.s.f.ObjectDirectory] Pack file /opt/puppetlabs/server/data/orchestration-services/data-dir/client/puppet-code.git/objects/pack/pack-1f8bd90dfb42ab749a7dbfc28a1b69d6de350cec.pack was deleted, removing it from pack list\n2022-08-23T11:54:51.434+02:00 INFO [4d7eb5f9-39af-4b53-b0d7-6abb6262a558_Worker-4] [p.o.connection_tests] Deleted 0 connection_tests older than 2 days\n2022-08-23T11:54:51.444+02:00 INFO [4d7eb5f9-39af-4b53-b0d7-6abb6262a558_Worker-3] [p.o.scheduled-job-manager] Deleted 0 scheduled job runs older than 30 days\n2022-08-23T11:54:55.022+02:00 INFO [4d7eb5f9-39af-4b53-b0d7-6abb6262a558_Worker-3] [p.o.job] Deleted 25,535 jobs older than 30 days\n2022-08-23T11:54:59.173+02:00 INFO [4d7eb5f9-39af-4b53-b0d7-6abb6262a558_Worker-3] [p.o.plan-job] Deleted 218 plan-jobs older than 30 days\n2022-08-23T15:30:13.221+02:00 INFO [de3dbaf2-b2ba-46cf-a3fd-bd91cd3f9d4a_Worker-4] [p.o.connection_tests] Deleted 0 connection_tests older than 2 days\n2022-08-23T15:30:13.230+02:00 INFO [de3dbaf2-b2ba-46cf-a3fd-bd91cd3f9d4a_Worker-3] [p.o.scheduled-job-manager] Deleted 0 scheduled job runs older than 30 days\n2022-08-23T15:30:13.245+02:00 INFO [de3dbaf2-b2ba-46cf-a3fd-bd91cd3f9d4a_Worker-3] [p.o.job] Deleted 0 jobs older than 30 days\n2022-08-23T15:30:13.246+02:00 INFO [de3dbaf2-b2ba-46cf-a3fd-bd91cd3f9d4a_Worker-3] [p.o.plan-job] Deleted 0 plan-jobs older than 30 days\n{code}\n\nI guess the 25,535 jobs were the jobs that should have been deleted in the meantime. \n\nCan you please link the bug ticket, or isn't that pubic?", "created": "2022-08-25T01:45:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi Tim. The other ticket isn't public right now. I will ask if they can make it public. Thanks for sharing the logs. Let me check with the devs if what you saw was correct.", "created": "2022-08-25T08:01:00.000000" } ], "components": [], "created": "2022-08-23T02:45:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6993575e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0j0ft:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Aug/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_44752721_*|*_3_*:*_1_*:*_2692879_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_65075437" } ], "description": "Hi,\nhttps://puppet.com/docs/pe/2019.8/config_orchestration.html#config_orchestration mentions:\n{quote}puppet_enterprise::profile::orchestrator::job_prune_threshold\nInteger that represents the number of days before job reports are removed.\nDefault: \"30\" (days){quote}\n\nI did some digging in the code and the parameter defaults to undef. jobs won't be pruned after 30 days. I've 4 months of history in my PE setup. There might be a hardcoded default, but it's not 30.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55012", "fixedVersions": [], "id": "55012", "issueType": "Bug", "key": "DOCUMENT-1352", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-08-24T10:00:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet_enterprise::profile::orchestrator::job_prune_threshold documentation is wrong?", "timeSpent": "PT0S", "updated": "2022-10-26T13:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-08-19T08:05:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7fc88050" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ixnt:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "49156" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Sep/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_371197527_*|*_3_*:*_1_*:*_708610_*|*_6_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_1188110443" } ], "description": "Customer was able to set pcp broker pcp broker log level like so:\n\n{code:java}\ngit diff --no-index /etc/puppetlabs/puppetserver/logback.backup-meusti-2022-08-17.xml /etc/puppetlabs/puppetserver/logback.xml\ndiff --git a/etc/puppetlabs/puppetserver/logback.backup-meusti-2022-08-17.xml b/etc/puppetlabs/puppetserver/logback.xml\nindex 43749d7..1ee299b 100644\n--- a/etc/puppetlabs/puppetserver/logback.backup-meusti-2022-08-17.xml\n+++ b/etc/puppetlabs/puppetserver/logback.xml\n@@ -73,11 +73,11 @@\n \n\n \n- \n+ \n \n \n\n- \n+ \n \n \n{code}\n\nThe customer thinks it would be helpful if this would be documented at https://puppet.com/docs/pe/2021.6/installing_compilers.html. \n\n\"Could you maybe update the documentation there or add a link to the logging.md maybe?\"", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54129", "fixedVersions": [], "id": "54129", "issueType": "Improvement", "key": "DOCUMENT-1351", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2022-09-06T09:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "pcp broker log level change documentation", "timeSpent": "PT0S", "updated": "2022-09-06T09:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-08-19T07:41:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7efac6c3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ixn5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "49156" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_372745937_*|*_3_*:*_1_*:*_1649015_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1188742016" } ], "description": "PCP brokers have an idle timeout of 15 minutes. This is documented here:\n* https://puppet.com/docs/pe/2019.8/installing_compilers.html#using-load-balancers-with-compilers-load_balancing_for_orchestration_scale\n* https://puppet.com/docs/pe/2021.6/installing_compilers.html#using-load-balancers-with-compilers-load_balancing_for_orchestration_scale\n\nHowever that changed in 2020: https://github.com/puppetlabs/pcp-broker/pull/227\n\nAnd It is documented here: https://github.com/puppetlabs/pcp-broker/blob/2019.8.x/doc/configuration.md\n\nThe timeout defaults now to 6 minutes and is configurable. Could you please update the PE documentation to match this?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54823", "fixedVersions": [], "id": "54823", "issueType": "Improvement", "key": "DOCUMENT-1350", "labels": [ "jira_escalated" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2022-09-06T09:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "pcp-broker has an idle timeout of 6 minutes and is now configurable, PE docs have this as 15 minutes", "timeSpent": "PT0S", "updated": "2022-09-06T09:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "616989d3048360006aeb55e8", "created": "2022-08-15T09:26:00.000000", "name": "image-2022-08-15-08-26-15-460.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14253" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:609a8eb65998a60068d12a0a] I believe this is covered by the command the user is told to copy in step 2? Could you confirm?\n\n!image-2022-08-15-08-26-15-460.png|width=710,height=124!\n\n\u00a0\n\nThe other options are now all under \"Customize the install script\" so users can differentiate the standard script from customization options.", "created": "2022-08-15T09:26:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "AAAAHHHH DOH [~accountid:616989d3048360006aeb55e8] sorry for misunderstanding that is a better way to show it thanks for checking. (I was too used to copying the command from this page)", "created": "2022-08-15T09:31:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "No problem. There was a large ticket I worked on a couple of months ago that required a lot of revisions to the \"installing agents\" pages. The instructions had been added piecemeal over time and needed to be edited holistically. Let me know if you're having trouble locating anything.\n\nI'll go ahead and close this ticket now. Feel free to reopen or make a new one if I need to change something.", "created": "2022-08-15T10:17:00.000000" } ], "components": [], "created": "2022-08-11T07:24:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@c6fdb1c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0i949:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Aug/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_355990521_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nLatest version of install agent with install script missing install script location\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.6/installing_nix_and_windows_agents_using_an_install_script.html#use-the-install-script\n\nDoes not have any mention of the install.bash or install.ps1 script and how to call it\n\n_In [https://puppet.com/docs/pe/2021.5/installing_agents.html#using_install_script-csr-attribute-settings]_\n\n_It had examples such as_\u00a0\n\n_{{uri='https://primary.example.com:8140/packages/current/install.bash'\n\ncurl --insecure \"$uri\" | sudo bash -s agent:certname= custom_attributes:challengePassword= extension_requests:pp_role=}}_\n\n_and_\n\n_{{[Net.ServicePointManager]::ServerCertificateValidationCallback = \\{$true}; $webClient = New-Object System.Net.WebClient; $webClient.DownloadFile('https://:8140/packages/current/install.ps1', 'install.ps1'); .\\install.ps1 agent:certname= custom_attributes:challengePassword= extension_requests:pp_role=}}_\n\n_Similar examples should be added so users know where and how to call the scripts_\n\n\u00a0\n\n*Summary:*\n\nThe latest documentation has accidentally removed all examples of how to use the install scripts", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55066", "fixedVersions": [], "id": "55066", "issueType": "Bug", "key": "DOCUMENT-1349", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Done", "resolutionDate": "2022-08-15T10:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Latest version of install agent with install script missing install script location", "timeSpent": "PT0S", "updated": "2022-08-15T10:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2022-08-10T10:30:00.000000", "creator": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6d2e3fd6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0i5o1:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Oct/22" } ], "description": "there appears to be a error in the puppet changlog documentation\nhttps://puppet.com/docs/puppet/7/release_notes_puppet.html#new_features_puppet_7-0-0-pup-10627\nsuggests\n\n{noformat}\nTo relax permissions on the last run summary, set the group permission on the file in puppet.conf to the following: lastrunsummary = $publicdir/last_run_summary.yaml { owner = root, group = monitoring, mode = 0640 }\n{noformat}\n\nexcept lastrunsummary is not a valid config entry\nhttps://puppet.com/docs/puppet/7/configuration.html\nit should be lastrunfile\nand if set to lastrunfile, monitoring is not a valid group\n\n{noformat}\nError: Could not get application-specific default settings: The :group parameter for the setting 'lastrunfile' must be either 'root' or 'service', not 'monitoring'\n{noformat}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55010", "fixedVersions": [], "id": "55010", "issueType": "Bug", "key": "DOCUMENT-1348", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation for puppet7 changelog has errors", "timeSpent": "PT0S", "updated": "2023-05-18T07:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-29T06:38:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2788c512" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hvz5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_268853947_*|*_3_*:*_1_*:*_4750248_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_233416" } ], "description": "*Problem:*\n\nLog locations has redundant masterhttp.log\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.6/log-locations-reference.html]\n\n_Current text :_\n\nMaster HTTP logLocation:\u00a0{{/var/log/puppetlabs/puppetserver/masterhttp.log}}\n\n_Suggested improvement:_\n\nRemove it\n\n*Summary:*\n\nThe masterhttp log doesn't appear to be part of current logging", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54733", "fixedVersions": [], "id": "54733", "issueType": "Improvement", "key": "DOCUMENT-1347", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-08-01T10:42:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Log locations has redundant masterhttp.log", "timeSpent": "PT0S", "updated": "2022-08-01T10:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-28T14:41:00.000000", "creator": "557058:ad3ba12f-a09f-4f5e-9fff-8660ad829629", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@19a19929" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hvxt:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1651218_*|*_3_*:*_1_*:*_1653364_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_240787" } ], "description": "This is in regards to: [https://puppet.com/docs/pe/2019.8/cloud_installing.html#installing-cloud]\n\nFor reference: https://puppet.atlassian.net/browse/DOCUMENT-1126\n\nThe instructions on the 'installing-cloud' site will not work. Steps 3 and 4 will fail with no indication of the problem.\n\nThe solution is to instruct the user to run in a root shell rather than to use 'sudo'\n\nSee: [https://github.com/puppetlabs/puppet-enterprise-marketplace-image/pull/207] with a possible example of remedy.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55008", "fixedVersions": [], "id": "55008", "issueType": "Bug", "key": "DOCUMENT-1346", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ad3ba12f-a09f-4f5e-9fff-8660ad829629", "resolution": "Fixed", "resolutionDate": "2022-07-28T15:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Problems with AWS Cloud Install instructions", "timeSpent": "PT0S", "updated": "2022-07-28T15:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] Hi, is there any relationship here to puppet_metrics_collector? [https://puppet.com/docs/pe/2021.6/metrics_collection.html#metrics_collection]\n\n\u00a0\n\nYou are referring to the Puppet Operational Dashboard module, right? Which is the replacement for the puppet_metrics_dashboard module.\n\n[https://forge.puppet.com/modules/puppetlabs/puppet_operational_dashboards]\n\n[https://forge.puppet.com/modules/puppetlabs/puppet_metrics_dashboard|https://forge.puppet.com/modules/puppetlabs/puppet_metrics_dashboard?_ga=2.225648090.1133412163.1658932561-1961412914.1634051123]\n\n\u00a0\n\nDo you have a link for the Splunk plugin?", "created": "2022-07-28T14:37:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Hey [~accountid:616989d3048360006aeb55e8] so I'd say all three are related as they are all accessing the same apis and putting the metrics somewhere, a grafana stack, splunk or json files locally.\n\nFor Splunk there have been a few blog articles with details too\n[https://puppet.com/blog/pe-metrics-in-splunk-puppet-report-viewer-3-1/]\n[https://puppet.com/blog/introducing-puppet-and-splunk-integrations-improve-reporting-speed-and-scale/]\n\nThe core parts are\n * [puppetlabs-splunk_hec|https://forge.puppet.com/modules/puppetlabs/splunk_hec]\u00a0module via Puppet Forge\n * [Puppet Report Viewer|https://splunkbase.splunk.com/app/4413/]\u00a0add-on via Splunkbase\n * [https://forge.puppet.com/modules/puppetlabs/pe_event_forwarding]", "created": "2022-07-28T15:06:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "changes will ship in next PE release (end of August).", "created": "2022-08-01T14:27:00.000000" } ], "components": [], "created": "2022-07-28T03:04:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d389bdf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hv0x:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "8.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_41605792_*|*_3_*:*_1_*:*_12459165_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_254806846_*|*_10016_*:*_1_*:*_77741804" } ], "description": "*Problem:*\n\nGrafanadash has not been updated since 2017 and was only tested on centos 6.\n\nPuppet Operational dashboard and the splunk plugin provide a more complete and automated way to gather and display Puppet metrics [https://puppet.com/docs/pe/2021.6/puppet_server_metrics.html]\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.6/puppet_server_metrics.html]\n\nI can't provide a simple change of text here but I think these pages should be removed as they are and made similar to [https://puppet.com/docs/puppet/7/server/puppet_server_metrics.html] but with reference to Puppet Operational dashboard (raised update in doc-1344)\n\nand also to our Splunk plugin.\n\n[~accountid:557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca] and [~accountid:6220db724160640069c71347] would be best reference points\n\n*Summary:*\n\nThe PE metrics page refers to grafanadash but we would now recommend using the puppet operational dashboard and the Splunk plugin to show metric data.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54128", "fixedVersions": [], "id": "54128", "issueType": "Improvement", "key": "DOCUMENT-1345", "labels": [ "large", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-08-01T14:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PE Puppet Server Metrics docs - Demote Grafanadash module, promote Metrics API and metrics collector/operational dashboard modules", "timeSpent": "PT0S", "updated": "2022-08-01T14:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [ { "attacher": "616989d3048360006aeb55e8", "created": "2022-07-29T11:52:00.000000", "name": "image-2022-07-29-10-52-32-311.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14207" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Module is also referenced in PE docs.", "created": "2022-07-28T14:35:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] Hi, is this other information relevant to the new module (\"this does not go through...\"), or can I discard it? !image-2022-07-29-10-52-32-311.png|width=503,height=77!", "created": "2022-07-29T11:52:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "I would say it can be discarded", "created": "2022-08-01T02:55:00.000000" } ], "components": [], "created": "2022-07-28T02:55:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2c7e225a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hv0p:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_42073699_*|*_3_*:*_1_*:*_1753045_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_254371008_*|*_10006_*:*_1_*:*_75495044_*|*_10005_*:*_1_*:*_501908" } ], "description": "*Problem:*\n\nThe Puppet metrics has been deprecated for the operational dashboard\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/server/puppet_server_metrics.html]\n\n\u00a0\n\n_Current text :_\n\nUse the\u00a0[puppet-metrics-dashboard|https://forge.puppet.com/puppetlabs/puppet_metrics_dashboard]\u00a0\n\n_Suggested improvement:_\n\nUse the [*puppet-operational-dashboard*|https://forge.puppet.com/modules/puppetlabs/puppet_operational_dashboards]\n\n*Summary:*\nThe tooling team has depreciated the metrics dashboard for the operational dashboard.\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55125", "fixedVersions": [], "id": "55125", "issueType": "Improvement", "key": "DOCUMENT-1344", "labels": [ "osp", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-08-01T10:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Puppet metrics dashboard deprecated for operational dashboard", "timeSpent": "PT0S", "updated": "2022-08-01T10:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-22T15:51:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@596e3194" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hsd5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_240318882_*|*_3_*:*_1_*:*_245351_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nThe postgresql log location is showing an old version.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2019.8/log-locations-reference.html#log_locations_reference-pe_database_logs\n\n_Current text :_\nh2. Database logs\n * {{/var/log/puppetlabs/postgresql/9.6/pgstartup.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Mon.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Tue.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Wed.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Thu.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Fri.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Sat.log}}\n * {{/var/log/puppetlabs/postgresql/9.6/postgresql-Sun.log}}\n\n_Suggested improvement:_\nh2. Database logs\n * {{/var/log/puppetlabs/postgresql/{*}11.15{*}/pgstartup.log}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Mon.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Tue.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Wed.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Thu.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Fri.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Sat.log{}}}\n * {{{}/var/log/puppetlabs/postgresql/{}}}{{{}*11.15*{}}}{{{}/postgresql-Sun.log{}}}\n\n*Summary:*\n\nPostgresql log version should be updated in 2019 log location docs", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54127", "fixedVersions": [], "id": "54127", "issueType": "Improvement", "key": "DOCUMENT-1343", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-25T10:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PE LTS log filepaths - wrong postgres version", "timeSpent": "PT0S", "updated": "2022-07-25T10:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "62d016b82c801edc32858b7d", "body": "Another question about SLES support: It specifically says 'SLES 12 SP1' in the support matrix but latest SLES 12 is SLES 12 SP5. Does 'SLES 12 SP1' actually mean 'SLES 12 SP1 or greater'?", "created": "2022-07-25T13:19:00.000000" } ], "components": [ "Puppet Server" ], "created": "2022-07-19T09:44:00.000000", "creator": "62d016b82c801edc32858b7d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d487f91" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hvxo:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1267824_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2593485111" } ], "description": "*Problem: SLES 15 missing from puppet server supported OSs*\u00a0\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/server/install_from_packages.html#supported-operating-systems\n\n_Current text :_\u00a0\n|SLES|12 SP1 (x86_64)|\n\n_Suggested improvement:_\n|SLES|12 SP1, 15 (x86_64)|\n\n*Summary:*\n\nIt appears that SLES 15 is supported since Puppet Server 7.7.0 [http://yum.puppet.com/puppet/sles/15/x86_64/index.html] but docs have not been updated.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54861", "fixedVersions": [], "id": "54861", "issueType": "Bug", "key": "DOCUMENT-1342", "labels": [ "puppet", "puppet-server", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "62d016b82c801edc32858b7d", "resolution": "Fixed", "resolutionDate": "2022-08-18T10:30:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "SLES 15 missing from puppet server supported OSs ", "timeSpent": "PT0S", "updated": "2022-08-18T10:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [ { "attacher": "609a8eb65998a60068d12a0a", "created": "2022-07-19T04:18:00.000000", "name": "image-2022-07-19-11-18-17-379.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14194" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] thanks for sharing this. These two diagrams have come through docs already, and I've added most of this information in one way or another to the file sync and code manager topics. We try to avoid containing a lot of detail in diagrams because of accessibility concerns. Text description must be added along with any visual elements, which can make long pages longer and discourage readers. While the current diagram on the \"How code manager works\" page doesn't contain all the details, it is a good summary of the process and complements the surrounding text (where more details are expounded). From the diagrams you shared, I added a few snippets about HTTPS/SSH and JGit to some existing topics.", "created": "2022-07-19T10:57:00.000000" } ], "components": [], "created": "2022-07-19T04:21:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@79ef23e4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hmyh:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_20686056_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2345_*|*_10016_*:*_1_*:*_3042049" } ], "description": "*Problem:*\n\nCurrently the code deploy diagram does show the relationship between components but has functionally less detail than a recent diagram given in a perforce presentation\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.6/code_mgr_how_it_works.html#how_code_manager_works\n\n_Current text :_\n\nThe current diagram does highlight communication but....\n\n_Suggested improvement:_\n\nThis diagram which was created for the perforce presentations has some great extra detail\n\n!image-2022-07-19-11-18-17-379.png!\n\n*Summary:*\n\nThere's detail in function which would be great to update the diagram with", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54822", "fixedVersions": [], "id": "54822", "issueType": "Improvement", "key": "DOCUMENT-1341", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-19T10:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The diagram for code deploy could be more detailed", "timeSpent": "PT0S", "updated": "2022-07-19T10:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-18T09:23:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@203330c9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hmhd:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8721972_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nIn the documentation [https://puppet.com/docs/pe/2021.6/lockless-code-deploys.html] it says \"When compiling code\" but it should say deploying code.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.6/lockless-code-deploys.html]\n\n_Current text :_\n\nWhen compiling code\n\n_Suggested improvement:_\n\nWhen *deploying* code\n\n*Summary:*\n\nThe statement at the start is about how when deploying code traditionally puppet compilation is blocked but accidentally says when compiling code, code compilation is blocked.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54459", "fixedVersions": [], "id": "54459", "issueType": "Improvement", "key": "DOCUMENT-1340", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-18T11:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Typo in lockless code deploy", "timeSpent": "PT0S", "updated": "2022-07-18T11:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "The definition was updated on the documentation preview server and can be viewed here:\n\nhttps://docs-herrera-preview.netlify.app/docs/puppet/7/environments_about.html#environments_about\n\nThe updated documentation will become publicly available at the next product release. \n\nClosing this ticket.", "created": "2022-07-28T13:34:00.000000" } ], "components": [], "created": "2022-07-18T04:17:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@d7c780a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hm5d:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_107250170_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_790161836" } ], "description": "*Problem:*\n\nThe definition for environment given at [https://puppet.com/docs/puppet/7/environments_about.html]\n\n\n\n\"An environment is a branch that gets turned into a directory on your primary server.\"\n\nLacks any context of what branch we are talking about and we would probably only talk about it like this if we were taking about control repos. It would seem better to use the glossary definition https://puppet.com/docs/puppet/7/glossary.html#environment\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/environments_about.html]\n\n_Current text :_\n\n\"An environment is a branch that gets turned into a directory on your primary server.\"\n\n_Suggested improvement:_\n\n*\"An environment is an isolated group of agent nodes that a primary server can serve with its own main manifest and set of modules. For example, you can use environments to set up scratch nodes for testing before rolling out changes to production, or to divide a site by types of hardware.\"*\n\n\n\n*Summary:*\n\nUpdate the environment definition to be more consistent.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54458", "fixedVersions": [], "id": "54458", "issueType": "Improvement", "key": "DOCUMENT-1339", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-28T13:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The definition for environment is inconsistent", "timeSpent": "PT0S", "updated": "2022-07-28T13:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-14T14:27:00.000000", "creator": "616989d3048360006aeb55e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@41337a76" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hktl:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_413036715_*|*_3_*:*_1_*:*_3822608_*|*_5_*:*_1_*:*_0" } ], "description": "[https://puppet.slack.com/archives/CF57S454P/p1657824359524089]\n\n\u00a0\n\nAdd topic \"Upgrading your OS\" or add note on Supported OS page that major OS upgrades require backup+migration.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54731", "fixedVersions": [], "id": "54731", "issueType": "Improvement", "key": "DOCUMENT-1338", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "616989d3048360006aeb55e8", "resolution": "Fixed", "resolutionDate": "2022-07-19T10:14:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE Major OS upgrades", "timeSpent": "PT0S", "updated": "2022-07-19T10:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:609a8eb65998a60068d12a0a] Hi, thanks for filing this ticket, but this issue has already been reported and assigned to the appropriate team to resolve.", "created": "2022-07-12T09:55:00.000000" } ], "components": [], "created": "2022-07-12T07:35:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@626af58a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hisx:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8509863_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nThe steps are wrongly numbered in https://puppet.com/docs/puppetdb/7/pdb_client_tools.html\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppetdb/7/pdb_client_tools.html\n\n_Current text :_\n\nStep 3: Install and configure the PuppetDB CLI\n\nStep 4: Enjoy!\n\n_Suggested improvement:_\nStep {*}2{*}: Install and configure the PuppetDB CLI\n\nStep {*}3{*}: Enjoy!\n\n\u00a0\n\n*Summary:*\n\nUpdate step numbers", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54614", "fixedVersions": [], "id": "54614", "issueType": "Improvement", "key": "DOCUMENT-1337", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Duplicate", "resolutionDate": "2022-07-12T09:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Steps wrongly numbered in pdb tools ", "timeSpent": "PT0S", "updated": "2022-07-12T09:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "609a8eb65998a60068d12a0a", "body": "Note discussion has moved to [https://perforce.slack.com/archives/C049M3S72SF/p1657212476554139] in new slack", "created": "2022-11-28T03:31:00.000000" } ], "components": [], "created": "2022-07-12T07:28:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2df85035" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hisp:" } ], "description": "*Problem:*\n\nThe ssl server side docs are out of date and do not reflect Puppets split of root and signing certificate\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/dirs_ssldir.html]\n\n_Consult with [~accountid:557058:c241032a-c552-4408-9a96-dcd5a643ff69] and [~accountid:557058:104b5720-714d-4539-b455-df472251ec89] to confirm all missing content. At a minimum it doesn't refer to the root private key see conversation [https://puppet.slack.com/archives/CF3HV61UZ/p1657213238985729?thread_ts=1657212476.554139&cid=CF3HV61UZ_]\n\nAlso stealing and updating the Puppet 3 documentation [https://docs.huihoo.com/puppet/puppet/3/reference/subsystem_agent_master_comm.html] to show the workflow would make things a lot clearer.\n\n\u00a0\n\n*Summary:*\nPuppet ssl documentation is out of date and incomplete in terms of workflow and file locations and doesn't reflect the changes to split of the root and intermediate signing ca\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54457", "fixedVersions": [], "id": "54457", "issueType": "Improvement", "key": "DOCUMENT-1336", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] ssl docs do not reflect split of root and intermediate CA and lack workflow", "timeSpent": "PT0S", "updated": "2023-05-17T18:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:609a8eb65998a60068d12a0a], I used the diagram to add information about the workflow to the Generate Impact Analysis reports page where there was already a small description of \"how\" the report is made.\n\n[https://puppet.com/docs/continuous-delivery/4.x/impact_analysis_reports.html#ia-workflow-detail]\u00a0", "created": "2022-07-12T13:37:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "[~accountid:616989d3048360006aeb55e8] thats great thank you", "created": "2022-07-13T02:55:00.000000" } ], "components": [], "created": "2022-07-12T07:16:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@54cb4bec" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hish:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9896565_*|*_5_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_12927331" } ], "description": "*Problem:*\n\nCurrently we do not actually tell users the workflow of impact analysis in cd4pe.\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/continuous-delivery/4.x/impact_analysis.html]\n\nHas no workflow page:\n\n_Suggested improvement:_\n\nSteal this and add it to the documentation https://github.com/puppetlabs/PipelinesInfra/blob/main/dev/docs/diagrams/ia_process_diagram.jpg\n\n*Summary:*\n\nAdd a workflow diagram to impact analysis workflow so customers can understand what it does", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54365", "fixedVersions": [], "id": "54365", "issueType": "Improvement", "key": "DOCUMENT-1335", "labels": [ "cd4pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-12T13:37:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Impact analysis process should be documented and explained", "timeSpent": "PT0S", "updated": "2022-07-13T02:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-07-12T06:59:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4e1b7ed5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0his9:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10798009_*|*_3_*:*_1_*:*_1563831_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_86820786_*|*_10005_*:*_1_*:*_3560" } ], "description": "*Problem:*\n\nAgent install docs wrongly put certname in agent section\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.6/installing_nix_and_windows_agents_using_an_install_script.html#customize-install-script\n\n_Current text :_\n_As another example, the following code specifies the\u00a0{{{}splay{}}},\u00a0{{{}certname{}}}, and\u00a0{{environment}}\u00a0settings in the\u00a0{{agent}}\u00a0section of the\u00a0{{puppet.conf}}\u00a0file:_\u00a0\n\n_{{}}_\n{code:java}\n\n{code}\n_{{agent:splay=true \\ agent:certname=node1.company.com \\ agent:environment=development}}_\n\n\n_The\u00a0{{puppet.conf}}\u00a0file resulting from this code contains:_\n\n\u00a0\n\n_{{}}_\n{code:java}\n\n{code}\n_{{[agent] certname = node1.corp.net splay = true environment = development}}_\n\n\u00a0\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\n_As another example, the following code specifies the\u00a0{{{}splay{}}},\u00a0{{{}certname{}}}, and\u00a0{{environment}}\u00a0settings in the\u00a0{{agent}}\u00a0section of the\u00a0{{puppet.conf}}\u00a0file:_\u00a0\n\n_{{}}_\n\n_{{}}_\n{code:java}\nagent:splay=true \\ main:certname=node1.company.com \\ agent:environment=development{code}\n_{{}}_\n\n\n_The\u00a0{{puppet.conf}}\u00a0file resulting from this code contains:_\n\n_{{}}_\n\n_{{}}_\n{code:java}\n[main] certname = node1.corp.net [agent] splay = true environment = development{code}\n_{{}}_\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}. In code section *_{{main:certname=node1.company.com}}_* _{{and}}_ *_{{[main] certname = node1.corp.net}}_*\n\n*Summary:*\n*As per discussion [https://puppet.slack.com/archives/CF466M5HQ/p1657549257513949?]thread_ts=1657543674.807519&cid=CF466M5HQ*\n\nand docs\n[https://puppet.com/docs/puppet/6/configuration.html#certname]\nNote: You must set the certname in the main section of the puppet.conf file. Setting it in a different section causes errors.\nWe should ensure no entries in doc place cert name in [agent]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54263", "fixedVersions": [], "id": "54263", "issueType": "Bug", "key": "DOCUMENT-1334", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-13T10:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Agent install docs wrongly put certname in agent section", "timeSpent": "PT0S", "updated": "2022-07-13T10:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-07-07T10:44:00.000000", "creator": "616989d3048360006aeb55e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d53c527" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hg95:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" } ], "description": "Per Tim's comment on DOCUMENT-1327, there might be users on older versions that need to follow a specific upgrade path to get to the new version (I am not sure how true this is or if this reflects users intentionally choosing an older version).\n\n\u00a0\n\nDue to archiving, steps to migrate to a specific version might be missing, and they don't know where to find it, or are overwhelmed by the Git archive repo.\n\n\u00a0\n\nI'm not sure whether this currently exists in the OSP docs, or if this is even reasonable, but it might be worth adding some kind of upgrade paths (like the one in CDPE: [https://puppet.com/docs/continuous-delivery/4.x/upgrading.html#upgrade_paths] ) that shows the recommended path for upgrading from older versions.\n\n\u00a0\n\nIf it makes any sense, perhaps we could link to the archived PDF (in the docs archive repo) for upgrades from older versions, and point out the page number where they can find the instructions. Note: I think there _might_ be a way to format links to \"anchor\" a page number in a PDF, but I'm not sure.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54262", "fixedVersions": [], "id": "54262", "issueType": "Improvement", "key": "DOCUMENT-1333", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "616989d3048360006aeb55e8", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "OSP upgrade paths", "timeSpent": "PT0S", "updated": "2023-06-05T15:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-07-07T03:16:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@29373181" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0kp0o:w" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Jul/22" } ], "description": "Hi,\nOn https://puppet.com/docs/puppet/7/config_file_oid_map.html is the following phrase:\n\n> Run puppetserver ca print to see changes made in custom_trusted_oid_mapping.yaml \n\nI'm on the latest PE release, 2016.6.0. the `print` subcommand doesn't exist. I'm also not aware of any other subcommand that would print the custom oid mapping / I'm not even sure what kind of output I should expect from that command. Maybe I'm missing something, but I think the whole sentence could/should be removed?\n\n{code}\nroot@pe-test ~ # puppetserver --version\npuppetserver version: 2021.6.0.25\nroot@pe-test ~ #\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54456", "fixedVersions": [], "id": "54456", "issueType": "Bug", "key": "DOCUMENT-1332", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "wrong command to check custom oid mappings", "timeSpent": "PT0S", "updated": "2023-05-17T18:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "This issue is resolved. The updated topic can be viewed on the preview server:\n\nhttps://docs-herrera-preview.netlify.app/docs/puppet/7/fact_overview.html#how-to-format-facts\n\nThe update will become publicly available when the documentation is published for the next release. Closing this ticket.", "created": "2022-07-26T13:59:00.000000" } ], "components": [], "created": "2022-07-07T01:58:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76fd4a2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hg5l:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_31737440_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1653127922" } ], "description": "Hi,\nfrom https://puppet.com/docs/puppet/7/fact_overview.html#writing_facts_simple_resolutions-how-to-format-facts:\n\nI think there is a newline missing after the header and Facter is once stelled as Factor.\n\n> The format of a fact is important because of the way that Factor", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54364", "fixedVersions": [], "id": "54364", "issueType": "Bug", "key": "DOCUMENT-1331", "labels": [ "facter", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-07-26T13:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in facter documentation", "timeSpent": "PT0S", "updated": "2022-07-26T13:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:609a8eb65998a60068d12a0a], that line hasn't actually been removed from the template file", "created": "2022-07-28T07:39:00.000000" } ], "components": [], "created": "2022-07-05T07:47:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@45f6d9a8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hef5:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8104447_*|*_3_*:*_1_*:*_9890547_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_63392111_*|*_10017_*:*_1_*:*_6215_*|*_10005_*:*_1_*:*_1915150600" } ], "description": "*Problem:*\n\nThe web routes config file docuemntation for puppet 7 still refers to legacy route services which were removed under *https://puppet.atlassian.net/browse/SERVER-2791*\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/server/config_file_web-routes.html\n\n_Current text :_\n\nThe\u00a0{{web-routes.conf}}\u00a0file looks like this:\n\n{{}}\n{code:java}\n# Configure the mount points for the web apps. \nweb-router-service: \n{ # These two should not be modified because the Puppet 4 agent expects them to # be mounted at these specific paths. \n\"puppetlabs.services.ca.certificate-authority-service/certificate-authority-service\": \"/puppet-ca\" \n\"puppetlabs.services.master.master-service/master-service\": \"/puppet\" \n\"puppetlabs.services.legacy-routes.legacy-routes-service/legacy-routes-service\": \"\n\" # This controls the mount point for the Puppet administration API. \"puppetlabs.services.puppet-admin.puppet-admin-service/puppet-admin-service\": \"/puppet-admin-api\" }{code}\n{{}}\n\n_Suggested improvement:_\n\nWe should remove {{}}\n{code:java}\n\"puppetlabs.services.legacy-routes.legacy-routes-service/legacy-routes-service\": \"{code}\n{{}}\n\nbut it may be advisable to confirm the template for the web-route.conf file on puppet 7\n\n*Summary:*\n\n*https://puppet.atlassian.net/browse/SERVER-2791* removed the legacy routes services we should remove them from our documentation example and probably check the default contents of this file if it has not been reviewed for a while.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54612", "fixedVersions": [], "id": "54612", "issueType": "Task", "key": "DOCUMENT-1330", "labels": [ "osp", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-28T10:23:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]", "timeSpent": "PT0S", "updated": "2022-07-28T10:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2022-07-01T14:04:00.000000", "name": "2022-07-01-220232_1602x381_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14232" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68], thank you for pointing this out. However, this is from version 2021.2. Although this version is published on the website, it is no longer maintained and we can't edit it.", "created": "2022-07-05T08:05:00.000000" } ], "components": [], "created": "2022-07-01T14:04:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4f7e5727" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hea1:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_324061759_*|*_6_*:*_1_*:*_0" } ], "description": "Hi,\n\nat the bottom of [https://puppet.com/docs/pe/2021.2/installing_pe_client_tools.html] is a bullet list with one empty bullet:\n\n!2022-07-01-220232_1602x381_scrot.png!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55006", "fixedVersions": [], "id": "55006", "issueType": "Bug", "key": "DOCUMENT-1329", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "No Available Fix", "resolutionDate": "2022-07-05T08:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PuppetDB docs: broken bullet list", "timeSpent": "PT0S", "updated": "2022-07-05T08:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68], thank you for your feedback. We always appreciate it. We've had some staffing changes recently and our documentation team is currently very short staffed. We're doing our best to keep our heads above water, but it is challenging.\n\nThe software we use to write docs is separate from the publishing engine and unfortunately it will report a \"404\" link as a valid link (since technically it is well-formed). We're working on getting google analytics set up to help us better detect 404s.\n\nI would like to know if you have some specific examples of versions that people feel has been archived too soon? Also, are your comments above in reference to the Open Source Puppet docs or to all of our docs generally?\n\nThanks again for your feedback.", "created": "2022-06-24T11:19:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "Hi [~accountid:616989d3048360006aeb55e8], \nthanks for the quick response.\nbq. We're doing our best to keep our heads above water, but it is challenging.\nSorry to hear, I know that feeling quite well :(\n\nbq. I would like to know if you have some specific examples of versions that people feel has been archived too soon?\nThis is usually reported from people upgrading from an old version to a newer one. Sometimes they want to do that in some steps, like from 4.x to 5.2 (because the latter is packaged by the distro they are using). But the docs for 5.2 aren't online anymore, only 5.5, 6.27.1 and 7.17.\n\nbq. Also, are your comments above in reference to the Open Source Puppet docs or to all of our docs generally?\nMostly Open Source Puppet/Puppetserver/PuppetDB.", "created": "2022-06-27T08:07:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68]\u00a0 - We've started a team project to address the backlog of tickets related to Open Source Puppet, Puppet Server, and PuppetDB. It might take us a few months, but we are working to address the concerns you brought up.", "created": "2022-07-07T10:34:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "Hi [~accountid:616989d3048360006aeb55e8],\nthanks for the feedback. Let me know if I can help somehow.", "created": "2022-07-07T14:57:00.000000" } ], "components": [], "created": "2022-06-24T05:42:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69e8906a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Quality of the documentation" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0h8jt:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Jun/22" } ], "description": "Hi!\nIn the past months I created 19 tickets in this Jira project. On a regular basis I receive complaints during trainings/workshops about the quality of the docs. My impression of the pain points are:\n* There are dead links within the docs, sometimes even broken links to other Puppet documentation\n* Docs are very inconsistent (see https://puppet.atlassian.net/projects/DOCUMENT/issues/DOCUMENT-1326 / https://puppet.atlassian.net/projects/DOCUMENT/issues/DOCUMENT-1318 )\n* Searching via google often brings up the correct content, but for Puppet 5.3 and not latest, which is odd/confusing\n* docs for old versions are removed, some people say too early. Reading their archived version on GitHub is... tricky?\n\nI don't know which software is used to render/maintain the docs. I know that at least parts of it come from private git repo(s?) and they were public in the past and people could just submit PRs. That was a nice and transparent solution, at least for contributors. I'm surprised by the inconsistencys/dead links. I would expect that a software that manages such a documentation is able to check for this.\n\nAnyhow, I don't know how Puppet itself thinks about the quality of the documentation (quality might be the wrong term here), but I wanted to provide feedback from a users point of view.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54333", "fixedVersions": [], "id": "54333", "issueType": "Epic", "key": "DOCUMENT-1327", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "In Progress", "statusCategory": "In Progress", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Quality of the documentation", "timeSpent": "PT0S", "updated": "2023-06-05T15:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2022-06-24T05:22:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1f7d104c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0h8jl:" } ], "description": "Hi,\nby accident I discovered https://puppet.com/docs/puppetserver/5.3/puppet-api/v3/tasks.html. I wasn't aware of this API endpoint. I did some testing and it's present in Puppetserver 6/7 as well. However it's not documented for Puppetserver 6/7. Can you add the docs back / is there a reason the endpoint isn't documented anymore?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54261", "fixedVersions": [], "id": "54261", "issueType": "Bug", "key": "DOCUMENT-1326", "labels": [ "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "/puppet/v3/tasks documentation missing in Puppetserver 6/7", "timeSpent": "PT0S", "updated": "2023-05-18T07:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [ { "attacher": "616989d3048360006aeb55e8", "created": "2022-07-06T10:18:00.000000", "name": "image-2022-07-06-10-18-03-866.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14252" } ], "comments": [ { "author": "5c2ff2e8e6047225b6d53614", "body": "I referred to\u00a0\n\n[https://puppet.com/docs/continuous-delivery/4.x/pam/maintenance-and-tuning.html#rebooting_nodes]\n\nShould this effectively shut down PAM / CD4PE and when you are ready you can then reboot the node back into operation ???\n\nDoes that make sense?\ng...", "created": "2022-06-22T05:07:00.000000" }, { "author": "70121:2acaa019-4ea1-43dc-8e7d-66f953c46dfd", "body": "My understanding of that was for draining & rebooting of individual nodes in a cluster, hence keeping service up which is not the requirement when patching PE. I may be wrong", "created": "2022-06-22T05:15:00.000000" }, { "author": "5c2ff2e8e6047225b6d53614", "body": "[~accountid:70121:2acaa019-4ea1-43dc-8e7d-66f953c46dfd]\u00a0 - You are entirely right!! and my advice was wrong hence the urgent need for the doc!!\ng...", "created": "2022-06-22T05:24:00.000000" }, { "author": "5c2ff2e8e6047225b6d53614", "body": "[~accountid:616989d3048360006aeb55e8] for context for this one this is what came from Murray at Blackrock:\n{code:java}\nI am going to be upgrading Puppet Enterprise from version 2019.8.5 to 2019.8.11.\n\nDuring previous upgrades I shutdown the docker cd4pe services during the upgrade to avoid any deployments to PE.\n\nNow that we are running CD4PE V4 given I cannot stop the cd4pe pods how can I bring down cd4pe during the upgrade? {code}\nif it helps contextualise it!\n\ng...", "created": "2022-06-22T08:47:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Adding the link to the slack thread. I think the current status is that it's not advisable to stop the application unless its for a specific troubleshooting reason, in which case there should be a KB created for that specific scenario.\n\n[https://puppet.slack.com/archives/CF85N5A91/p1655908769926369]\u00a0", "created": "2022-06-23T13:47:00.000000" }, { "author": "5c2ff2e8e6047225b6d53614", "body": "Hi folks - would it be possible to provide a way to shutdown down CD4PE if required for whatever reason?\n\n\u00a0\n\nWhat we have via [https://puppet.com/docs/continuous-delivery/4.x/pam/maintenance-and-tuning.html#rebooting_nodes] is a mechanism to shutdown and drain an individual node in the cluster.\u00a0 \n\n\nEssentially\u00a0 - if you don't do PArt 3 (the reboot) I have to presume\u00a0 that one would need to define a\u00a0 series of Nodes to stop CD4PE.\u00a0\n\nWould this same approach be used to shut down the cluster and bring it back up in a healthy state?\n\nThanks,\ng...", "created": "2022-06-27T03:46:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:5c2ff2e8e6047225b6d53614], I recommend posting your question in the #prod-CDPE channel. Since this is a DOCUMENT ticket, the CDPE engineers won't see your comment here.", "created": "2022-07-06T08:01:00.000000" }, { "author": "5c2ff2e8e6047225b6d53614", "body": "Hi [~accountid:616989d3048360006aeb55e8] ,\n\nThe devs provided the following as a way to \"Shut down\" CD4PE (for whatever reason):\n\nTo \"stop\" CD4PE\n{code:java}\nkubectl scale deploy cd4pe --replicas=0{code}\n\u00a0\n\nTo \"start\" CD4PE\n{code:java}\nkubectl scale deploy cd4pe --replicas=1{code}", "created": "2022-07-06T08:58:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:5c2ff2e8e6047225b6d53614], I've added the commands to the Troubleshooting page of the docs below the command for restarting the pod.\n\nPlease let me know if you have any feedback about what I wrote. Based on the discussion in slack, I added the Caution that these commands are for specific situations, and that users should try restarting the pod first.\n\n!image-2022-07-06-10-18-03-866.png|width=560,height=570!", "created": "2022-07-06T10:18:00.000000" }, { "author": "5c2ff2e8e6047225b6d53614", "body": "[~accountid:616989d3048360006aeb55e8] - that looks good to me!\nThanks a mill!", "created": "2022-07-06T10:44:00.000000" } ], "components": [], "created": "2022-06-21T23:35:00.000000", "creator": "70121:2acaa019-4ea1-43dc-8e7d-66f953c46dfd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2ccacb99" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0h5sp:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "48726" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jun/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_137546092_*|*_3_*:*_1_*:*_1811377_*|*_10009_*:*_1_*:*_1684926_*|*_5_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_1108863502" } ], "description": "We don't have details of the best approach for upgrading PE in an environment with CD4PE. To avoid issues, and unhappy CD4PE users, it's seems sensible to shutdown CD4PE so that there is no traffic to PE, but we don\u2019t seem to have this information here [https://puppet.com/docs/pe/2021.6/upgrading_pe.html.] Could we have an additional section covering this scenario?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54332", "fixedVersions": [], "id": "54332", "issueType": "Improvement", "key": "DOCUMENT-1325", "labels": [ "cd4pe", "jira_escalated", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:2acaa019-4ea1-43dc-8e7d-66f953c46dfd", "resolution": "Fixed", "resolutionDate": "2022-07-06T10:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE upgrade instructions in environment with CD4PE", "timeSpent": "PT0S", "updated": "2022-07-06T10:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2022-06-21T02:13:00.000000", "name": "2022-06-21-101119_1696x638_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14278" } ], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in current and upcoming versions", "created": "2022-07-06T10:16:00.000000" } ], "components": [], "created": "2022-06-21T02:14:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@77e14b22" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0h51t:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_28159519_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1296803404" } ], "description": "Hi,\nI was reading through https://puppet.com/docs/puppet/7/function.html#lookup and noticed that the bottom doesn't render correctly:\n\n\nbq. 3. The indicated module's data provider, if the key is of the form ::.\nbq.\nbq. ###\\sArguments\n\nI also did a screenshot of it:\n !2022-06-21-101119_1696x638_scrot.png|thumbnail! \n\nThe error exists on Puppet 6 and Puppet 7 documentation, not Puppet 5.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54331", "fixedVersions": [], "id": "54331", "issueType": "Bug", "key": "DOCUMENT-1324", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-07-06T10:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "function overview doesn't render correctly", "timeSpent": "PT0S", "updated": "2022-07-06T10:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Hi [~accountid:6220db9494f7e20069fe964a] I've made this change and it will ship with the PAM release going out tomorrow (15 June). One question: should the audit log storage also be noted in the Detailed hardware requirements section [https://puppet.com/docs/continuous-delivery/4.x/pam/pam-sysreqs.html#detailed_hardware_requirements] ?\u00a0", "created": "2022-06-14T17:02:00.000000" }, { "author": "6220db9494f7e20069fe964a", "body": "Actually, missed that one. Yes both for primary and secondary. Thanks for spotting that", "created": "2022-06-15T05:39:00.000000" }, { "author": "6220db9494f7e20069fe964a", "body": "Also, Releases notes needs updated to this respect too.\n\n[https://puppet.com/docs/continuous-delivery/4.x/pam/pam-release-notes.html#pam-release-notes-12-april-2022] says:\n\n```\n * *Other component upgrades.*\u00a0This version includes an upgrade of\u00a0KOTS\u00a0to version 1.68.0.\n\n```\n\nand would update to\n\n```\n * *Other component upgrades.*\u00a0This version includes an upgrade of\u00a0KOTS to version 1.68.0 which enables Kubernetes audit event logging by default (1 Gb requirement for `/var/log/apiserver`.\n\n```\n\nLet me know if you want a separate ticket for the release notes update", "created": "2022-06-15T05:47:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Great, I've made these changes as well. Thanks!\u00a0", "created": "2022-06-15T11:05:00.000000" } ], "components": [ "DOC" ], "created": "2022-06-14T05:27:00.000000", "creator": "6220db9494f7e20069fe964a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@737fe152" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0h0a9:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Jun/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_16510442_*|*_10007_*:*_1_*:*_79507871_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_25220314" } ], "description": "In light of [/var/log/apiserver logs]([https://puppetlabs.zendesk.com/agent/tickets/48607),] K8s has introduced a audit logging functionality that it is enabled by default as part of the Replicated install (PAM). As such, this generates a 1GB disk requirement for the PAM install that we are currently not specifying in [PAM system requirements]([https://puppet.com/docs/continuous-delivery/4.x/pam/pam-sysreqs.html)]\n\nWe currently have 3 sections (Continuous Delivery for Puppet Enterprise (PE),Puppet Comply and Continuous Delivery for Puppet Enterprise (PE)\u00a0and\u00a0Puppet Comply) where we provide the below storage ref:\n\n```\n\nAn additional 100 GB for\u00a0{{{}/var/lib{}}}. This is primarily divided among:\n * 2 GB for\u00a0{{/var/lib/etcd}}\n * 10 GB for\u00a0{{/var/lib/rook}}\u00a0(plus buffer)\n * 32 GB for\u00a0{{/var/lib/kubelet}}\n * 40 GB for\u00a0{{/var/lib/containerd}}\n\n```\n\nand each section should now read\n\n```\n\n{{1 GB for /var/log/apiserver for Kubernetes Audit logs.}}\n\nAn additional 100 GB for\u00a0{{{}/var/lib{}}}. This is primarily divided among:\n * 2 GB for\u00a0{{/var/lib/etcd}}\n * 10 GB for\u00a0{{/var/lib/rook}}\u00a0(plus buffer)\n * 32 GB for\u00a0{{/var/lib/kubelet}}\n * 40 GB for\u00a0{{/var/lib/containerd}}\n\n```\n\nMany thanks in advance.\n\n\u00a0\n\nBest regards,\n\n\u00a0\n\nJordi Garcia", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54455", "fixedVersions": [], "id": "54455", "issueType": "Bug", "key": "DOCUMENT-1323", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db9494f7e20069fe964a", "resolution": "Done", "resolutionDate": "2022-06-15T15:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PAM requirements need updated", "timeSpent": "PT0S", "updated": "2022-06-15T15:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-05-23T18:12:00.000000", "creator": "5a1beb0b007eb21a79e5d6de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@91a5d47" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0gofi:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_662161723_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_528284356" } ], "description": "*Problem:*\n\nPuppet added Fedora 34 support in Puppet 6.23.0, but that added support isn't reflected in the release notes\n\n*Suggested improvement:*\n\n_https://puppet.com/docs/puppet/6/release_notes_puppet.html_\n\n_Current text :_\n\nn/a\n\n_Suggested improvement:_\n\nSupport for Fedora 34\n\nThis release adds support for Fedora 34 [PUP-10892|https://puppet.atlassian.net/browse/PUP-10892]\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54126", "fixedVersions": [], "id": "54126", "issueType": "Task", "key": "DOCUMENT-1321", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a1beb0b007eb21a79e5d6de", "resolution": "Fixed", "resolutionDate": "2022-06-06T12:52:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Fedora 34 Support Missing", "timeSpent": "PT0S", "updated": "2022-06-06T12:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-05-20T10:40:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1900f2f6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0gmji:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_948620481_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_527816819" } ], "description": "*Problem:*\n\nThe example for capitalize accidentally refers to upcase it should be corrected.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/6/function.html#capitalize]\n[https://puppet.com/docs/puppet/7/function.html#capitalize|https://puppet.com/docs/puppet/6/function.html#capitalize]\n\n\n\n_Current text :_\n\n_'hello'.capitalize()_\n_upcase('hello')_\n\n_Suggested improvement:_\n\n_'hello'.capitalize()_\n_{*}capitalize{*}('hello')_\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*Summary:*\n\nCorrect the 2nd example from upcase to capitalize", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54609", "fixedVersions": [], "id": "54609", "issueType": "Task", "key": "DOCUMENT-1320", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-06-06T12:48:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Functions capatalize example mistake", "timeSpent": "PT0S", "updated": "2022-06-06T12:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-05-20T01:29:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@57d193af" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hriw:4" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/May/22" } ], "description": "Could you please document why the expiration field is required for the /puppet/v3/facts/ endpoint (https://puppet.com/docs/puppet/7/http_api/http_facts.html)? As far as I know PuppetDB doesn't use this value. Is this used for anything?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54260", "fixedVersions": [], "id": "54260", "issueType": "Improvement", "key": "DOCUMENT-1319", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppetserver facts API: document expiration field", "timeSpent": "PT0S", "updated": "2023-05-18T07:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in current and upcoming versions", "created": "2022-07-06T11:03:00.000000" } ], "components": [], "created": "2022-05-19T06:38:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7cc0b717" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0gk7i:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1049363850_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3113739134" } ], "description": "Hi!\n* https://puppet.com/docs/puppet/5.5/http_api/http_facts.html\n* https://puppet.com/docs/puppet/6/http_api/http_facts.html\n* https://puppet.com/docs/puppet/7/http_api/http_facts.html\n\nI think that in the example section in those three links, the json payload could be put into a pre block to make it more readable. The actual issue is that the page isn't listed in the navigation bar.\n\nWorking example: https://puppet.com/docs/puppet/6/http_api/http_catalog.html. on the right navigation are the different API endpoints:\n* catalog\n* node\n* file bucket file\n* file content\n* file metadata\n* report\n* environments\n* status\n\nI think facts is missing here.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54125", "fixedVersions": [], "id": "54125", "issueType": "Bug", "key": "DOCUMENT-1318", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-07-06T11:03:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppetserver facts API endpoint doesn't render correctly", "timeSpent": "PT0S", "updated": "2022-07-06T11:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in upcoming release", "created": "2022-06-06T13:14:00.000000" } ], "components": [], "created": "2022-05-05T06:45:00.000000", "creator": "607fe3679c4625006b1ba4b2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@23dd18bd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0g6vq:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_443783887_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2344391343" } ], "description": "Hello,\n\npage [https://puppet.com/docs/puppet/7/dirs_confdir.html#dirs_confdir-confdir-location] references configuration option `{{{}jruby-puppet.master-conf-dir{}}}` but it should be `{{{}jruby-puppet.server-conf-dir{}}}`.\n\n\u00a0\n\nRegards, JH\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54859", "fixedVersions": [], "id": "54859", "issueType": "Bug", "key": "DOCUMENT-1317", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "607fe3679c4625006b1ba4b2", "resolution": "Fixed", "resolutionDate": "2022-06-06T13:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet/7/dirs_confdir.html reference master-conf-dir instead of server-conf-dir", "timeSpent": "PT0S", "updated": "2022-06-06T13:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "Thank you for this feedback. Members of the Technical Publications team met today to discuss the suggestion. We agreed that the glossary and the terminology page have different goals:\n\n- The glossary defines Puppet terms.\n- The terminology page helps Puppet employees by providing guidelines about capitalization, word order, avoidance of deprecated terms, and similar.\n\nTo process your request, we need more information. Can you point out specific terms that should be copied from the terminology page and added to the glossary? ", "created": "2022-05-11T16:57:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Im going to go out to SE, TAMS and customers a bit but I think the definitions for\n\nagentless\nPE deployment\ncorrective change\nintentional change\n\nShould be included and thinking about it more the missing terms may be related to products such as cd4pe which doesn't currently have a glossary", "created": "2022-05-18T04:27:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "razor should also be removed from the glossary", "created": "2022-05-18T04:45:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "Thank you, David. I have been making minor updates in the glossary source code, including the removal of the \"Razor\" item. Those updates should be showing up on the public website later this week. I will also look into the other terms that you have suggested. This is great feedback.", "created": "2022-05-19T09:47:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "This is a work in progress. I prepared glossary definitions for the listed terms and will be discussing the definitions with a member of the Tech Pubs Team on June 8. After that, I will ask one or more developers to review the definitions.", "created": "2022-06-06T15:34:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "The updated glossary definitions were reviewed for style by a member of the Tech Pubs team. After that, the updated glossary was reviewed by two subject matter experts, and their feedback was implemented. The updated glossary is available on the internal documentation preview site:\n\nhttps://docs-herrera-preview.netlify.app/docs/puppet/7/glossary.html#puppet_enterprise\n\nI expect that the updated glossary will become _publicly_ available in July or whenever the next Open Source Puppet release takes place. If you would like to have the updated glossary published earlier, let me know, and I'll see what I can do. \n\n", "created": "2022-06-16T14:10:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "I learned today that the open source Puppet release is now scheduled for July 26. That's when the updated glossary should be published.\n\nI discussed this ticket today with my colleagues on the Tech Pubs team. They said that, because the glossary updates are already visible on the [preview server|https://docs-herrera-preview.netlify.app/docs/puppet/7/glossary.html#puppet_enterprise] and because the updated glossary will be published in the next release, I can close the ticket. Closing now.", "created": "2022-07-12T10:12:00.000000" } ], "components": [], "created": "2022-05-03T08:36:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@24a19756" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0g3wu:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_610058432_*|*_3_*:*_1_*:*_3093290778_*|*_5_*:*_1_*:*_9745_*|*_6_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_2350515859" } ], "description": "*Problem:*\n\nThe glossary documentation page is missing a number of definitions and customers have commented these can be hard to find.\n\n*Suggested improvement:*\n\nThe [https://puppet.com/docs/puppet/7/glossary.html] page would be more complete taking the extra definitions in the internal glossary page [https://confluence.puppetlabs.com/display/Writing/Puppet+terminology#Puppetterminology-PuppetEnterpriseusage]\n\n*Summary:*\n\nThe glossary page should be updated with all extra definitions in the terminology page.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55124", "fixedVersions": [], "id": "55124", "issueType": "Task", "key": "DOCUMENT-1316", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-07-12T10:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] The public facing glossary page is missing many definitions in the internal terminology page", "timeSpent": "PT0S", "updated": "2022-11-02T11:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "This seems like a good idea. The first step here is to make a list of the components that should be listed in this proposed new table. Here's my first pass at one, based on all version updates we've mentioned in the PAM release notes to date.\u00a0\n\nQuestion for [~accountid:609a8eb65998a60068d12a0a]: which of these do users care about/want to know which versions are running? Is anything missing from this list?\u00a0\n\nQuestion for [~accountid:557058:745ad6f8-2461-4691-9873-549d5904bb16] or [~accountid:557058:252602f6-56c9-47a2-a176-2c9c57106330]: are any PAM components missing from this list?\u00a0\u00a0\n * KOTS version (which we also use as the PAM version)\u00a0\n * Kubernetes\n * Project Contour\n * containerd\n * ekco\n * Rook\n * Weave\n * Velero\n * Metrics Server\n * Prometheus\n * Prometheus Operator\n * Goldpinger?\n * runC?\u00a0", "created": "2022-05-03T11:43:00.000000" }, { "author": "557058:745ad6f8-2461-4691-9873-549d5904bb16", "body": "Listing out addon versions is possible, but going to be some maintenance work going forward. I'd be curious if the list of components installed by kURL would suffice. It would be far easier to maintain, since we maintain that list as part of the distribution already. In addition, customers can view it anytime they want by going to {{https://kurl.sh/}}, so we wouldn't have to maintain a docs page for it. So for the HA installer, one could go to https://kurl.sh/puppet-application-manager.\n\nWould that meet the spirit of the request here?", "created": "2022-05-03T12:58:00.000000" }, { "author": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "body": "As far as I know, {{https://kurl.sh/}} is limited to only showing what the latest and greatest is. Which isn't the same as what a customer has in their current installation.", "created": "2022-05-03T13:20:00.000000" }, { "author": "557058:745ad6f8-2461-4691-9873-549d5904bb16", "body": "Correct, that link is only for the latest version available. I was working under the assumption this was related to customers who were going to install, but wanted to know what they were installing beforehand.\n\nIf a customer already has a version of PAM installed and wants to know what components are installed, they can get that same view with {noformat}kubectl get installer -o jsonpath=\"{.items[].spec}\" |jq{noformat}.", "created": "2022-05-03T14:14:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Documenting those two commands would certainly be a lighter lift and require a lot less dev/docs upkeep than a reference table. If that approach would get users what they're asking for, that seems like a great plan.\u00a0\n\n\u00a0", "created": "2022-05-03T14:41:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "My issue with that approach is it puts an operational burden on the team with access to those commands, who may have such limited access it takes an access request to run the command (big enterprise sucks). It will continue to raise the question of why haven't we documented it anywhere as well. Would there be a good way of saving this output in the docs which wouldn't burden the product team on each release?", "created": "2022-05-03T14:58:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Ah, that's very helpful context, [~accountid:609a8eb65998a60068d12a0a], thank you. Saving the component versions shown on the [https://kurl.sh/] page for each release in a table in the docs sounds like the right path forward, in that case. I'll also document those commands, of course.\u00a0\n\nSo, in place of the list I made above, we'd publish a table with the 11 components shown in the *What you get* column on that page. I'm still curious to know if users want/need a record of all 11.\u00a0\n\n[~accountid:557058:745ad6f8-2461-4691-9873-549d5904bb16] does the team have easy access to the component version info that ends up on [https://kurl.sh/] before the new PAM release ships? If not, I can just wait to update the table until after PAM ships (I expect that this would delay the docs release by maybe half an hour at most, which doesn't seem too terrible).", "created": "2022-05-03T15:32:00.000000" }, { "author": "557058:745ad6f8-2461-4691-9873-549d5904bb16", "body": "Yes, we can provide that list pretty easily before each release.\n\nIf there is interest in this table going to releases before 1.68.0, it will be a little tricky. The kURL version varied based on the day the customer installed the system prior to 1.68.0, so we wouldn't be able to make as reliable a table. With version 1.68.0 and later we have everything pinned down.\n\nFor 1.68.0, however, we would have:\n\nhttps://github.com/puppetlabs/puppet-application-manager/blob/2022-04-12/regular.yaml for HA installations\nhttps://github.com/puppetlabs/puppet-application-manager/blob/2022-04-12/standalone.yaml for standalone installations\n\nYou can also use the links https://kurl.sh/puppet-application-manager (HA) and https://kurl.sh/puppet-application-manager-standalone (standalone) until we have another release. \n\nWe would also be able to provide this data for legacy installations, but I don't know if we even want to bother with it since it is deprecated.", "created": "2022-05-03T16:11:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Ok, that's great to hear, thanks Adam!\n\n+1 to starting the table with 1.68.0, and to not worrying about legacy installations.\u00a0\n\nI'm on PTO tomorrow, but can start drafting this when I get back on Thursday.\u00a0", "created": "2022-05-03T16:26:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Hey, folks. Here's a draft of this new component versions page for your review and comment: [https://docs-herrera-preview.netlify.app/docs/pam/1.0/pam-component-versions.html]\u00a0\n\n(Note that I've included some placeholder content to show how the table will look with multiple PAM versions, and I'll remove this before publication.)\u00a0\n\nI'm also wondering if it would make sense to move the other component info from where it currently lives in the Troubleshooting section to this new page: https://puppet.com/docs/continuous-delivery/4.x/pam/pam-troubleshooting.html#pam-components", "created": "2022-05-06T16:37:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thanks for the info, Adam. I renamed that element in the component table \"Prometheus bundle\", and we can add additional explanation if it ever becomes necessary.\u00a0\n\nHere's the published page.\u00a0\n\n[https://puppet.com/docs/continuous-delivery/4.x/pam/pam-component-versions.html]\u00a0", "created": "2022-05-13T15:59:00.000000" } ], "components": [], "created": "2022-05-03T08:28:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@525eda56" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0g3wm:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10008488_*|*_3_*:*_1_*:*_610628155_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_270445079" } ], "description": "*Problem:*\n\nCustomers are asking questions about the version of KOTS and replicated used and there is no direct page to find this without searching the release notes.\n\n{*}Suggested improvement:{*}\n\n_Currently no page exists but a page similar to [https://puppet.com/docs/pe/2021.5/component_versions_in_recent_pe_releases.html#component_versions_in_recent_pe_releases]_\n\n_at_\u00a0\n\n_[https://puppet.com/docs/continuous-delivery/4.x/cd-pam-index.html] would be helpful._\n\n\n*Summary:*\n\nAdd component versions for KOTS and Replicated for PAM", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54821", "fixedVersions": [], "id": "54821", "issueType": "Task", "key": "DOCUMENT-1315", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-05-13T15:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] CD4PE PAM does not list versions of underlying components", "timeSpent": "PT0S", "updated": "2022-11-02T04:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "5e3375e183d74c0e821851f3", "body": "[~accountid:557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca] [~accountid:5b590061a3f8512ca5eb3be7] Are there other spots where this could be wrong?", "created": "2022-05-02T10:43:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi Jarret, the comments on PE-32074 ended up with with \"The module collects Puppet metrics by default, but system metrics collection is disabled.\"\nWas this eventually changed that they are both disabled?", "created": "2022-05-02T15:56:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:5e3375e183d74c0e821851f3] I can't edit previous versions*, but I've just pushed up the change on 2019.8.10 (and it will be in 2019.8.11). There were 4 topics I found that mentioned metrics collector (including the 2019.8.8 release notes) so I've edited all of those to properly state that metrics collection is entirely disabled by default.\n\n\u00a0\n\n/* This means I can't go back to the 2019.8.9 or 2019.8.8 versions of the docs to edit them. I was able to edit the 2019.8.8 release note because it is printed in the 2019.8.10 docs (and, by extension, the upcoming 2019.8.11 docs): [https://puppet.com/docs/pe/2019.8/release_notes_pe.html#release_notes_pe]\u00a0\n\n\u00a0\n\n\u00a0\n\nOther updated topics are:\u00a0\n\n[https://puppet.com/docs/pe/2019.8/metrics_collection.html#metrics_collection]\n\nand\n\n[https://puppet.com/docs/pe/2019.8/getting_support_for_pe.html#puppet_metrics_collector]\u00a0", "created": "2022-05-03T13:22:00.000000" } ], "components": [], "created": "2022-05-02T10:42:00.000000", "creator": "5e3375e183d74c0e821851f3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6c2fb2c8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0fni2:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "48226" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18298268_*|*_3_*:*_2_*:*_1267174_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_62980050_*|*_10006_*:*_2_*:*_13510075" } ], "description": "The Puppet Enterprise metrics page for 2019.8 has the wrong value for {{puppet_enterprise::enable_metrics_collection}}. In 2019.8 this is disabled by default and in 2021.x it has been enabled by default.\n\nOn [https://puppet.com/docs/pe/2019.8/metrics_collection.html], please change the following.\n\n{noformat}\npuppet_enterprise::enable_metrics_collection: Collect metrics from PE services, such as Puppet Server and PuppetDB. This parameter is enabled by default.\n{noformat}\n\u00a0\nTo be\n\n{noformat}\npuppet_enterprise::enable_metrics_collection: Collect metrics from PE services, such as Puppet Server and PuppetDB. This parameter is disabled by default.\n{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54856", "fixedVersions": [], "id": "54856", "issueType": "Bug", "key": "DOCUMENT-1314", "labels": [ "jira_escalated", "pe", "small", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5e3375e183d74c0e821851f3", "resolution": "Fixed", "resolutionDate": "2022-05-03T13:23:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Metrics Collection Article in 2019.8 has the wrong default", "timeSpent": "PT0S", "updated": "2022-05-03T13:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2022-04-20T06:20:00.000000", "name": "2022-04-20-142020_1714x362_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14231" } ], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Fixed in upcoming release.", "created": "2022-06-06T13:09:00.000000" } ], "components": [], "created": "2022-04-20T06:20:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ebf128f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ftqu:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jun/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_531791631_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3553566436" } ], "description": "The last codeblock at https://puppet.com/docs/puppet/7/lang_exported.html doesn't look correct:\n\n !2022-04-20-142020_1714x362_scrot.png|thumbnail! ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54454", "fixedVersions": [], "id": "54454", "issueType": "Bug", "key": "DOCUMENT-1313", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-06-06T13:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Exported Resource documentation doesn't render correctly", "timeSpent": "PT0S", "updated": "2022-06-06T13:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a434701f8660070b62e0a", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "Josh Cooper got back to me today with feedback about this topic, and so I updated the text accordingly. Here's the new text:\n\n_By default, compiler variables have a value of undef (undefined). If you reference an undefined compiler variable, and you have specified the strict_variables=true setting, an error message flags the undefined variable._\n\nThe updated text is now available on the docs preview server:\n\nhttps://docs-herrera-preview.netlify.app/docs/puppet/7/lang_facts_builtin_variables.html\n\n", "created": "2022-09-26T11:07:00.000000" } ], "components": [], "created": "2022-04-01T07:02:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4a1251a7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0fjyu:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Jul/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_356498583_*|*_3_*:*_1_*:*_1379087220_*|*_4_*:*_1_*:*_243565_*|*_5_*:*_2_*:*_15695_*|*_6_*:*_2_*:*_4041898154_*|*_10005_*:*_1_*:*_9616202266" } ], "description": "Hi, there seems to be a charater missing in https://puppet.com/docs/puppet/7/lang_facts_builtin_variables.html#lang_facts_builtin_variables-compiler-variables\n\n{code}\nThese variables are always considered defined, suc strict_variables\n{code}\n\n{{suc}} seems to be wrong, maybe {{so}}?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54853", "fixedVersions": [], "id": "54853", "issueType": "Bug", "key": "DOCUMENT-1309", "labels": [ "osp", "Puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-09-26T11:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "typo in lang_facts_builtin_variables.html", "timeSpent": "PT0S", "updated": "2022-09-26T11:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "Did this a while ago and forgot to close- addendum should be a separate ticket", "created": "2023-01-09T10:24:00.000000" } ], "components": [], "created": "2022-03-31T07:46:00.000000", "creator": "6220dbd449c90000701fd0c5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@74c30dca" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hriw:c" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Jan/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_440184895_*|*_3_*:*_1_*:*_9671730382_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_14438764895" } ], "description": "*Problem:*\n\nThe logging instructions for Windows Puppet Agents is out of date and lists a file that is no longer provided. Please see [https://github.com/puppetlabs/puppet-agent/pull/1749] for more details.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/services_agent_windows.html#configuring_win_agent-logging-puppet-agent-windows-systems]\n\n_Current text : {{\"C:\\Program Files\\Puppet Labs\\Puppet\\puppet\\bin\\puppetres.dll\"}}_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement: \"%SystemRoot%\\System32\\EventCreate.exe\"_\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\n*Summary:*\n\nThe documentation needs to be reworked to *remove references to \"puppetres.dll\" as it no longer exists, and use the native \"EventCreate.exe\" instead.* Discovered while providing support in [https://puppetlabs.zendesk.com/agent/tickets/47455].\n\nADDENDUM:\nIn addition, {*}a section should be added regarding redirecting the PXP-Agent logs on Windows as well{*}. In the support ticket referenced they have a Group Policy blocking both the puppet agent and nssm-pxp-agent from the Application log.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54330", "fixedVersions": [], "id": "54330", "issueType": "Task", "key": "DOCUMENT-1308", "labels": [ "DOCS", "osp", "Puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbd449c90000701fd0c5", "resolution": "Fixed", "resolutionDate": "2023-01-09T10:24:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet agent Windows logging docs outdated", "timeSpent": "PT0S", "updated": "2023-01-09T10:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-03-09T03:30:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@36ee68de" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0f1rq:" } ], "description": "*Problem:*\n\nThe hiera example presented in [https://puppet.com/docs/puppet/7/hiera_config_yaml_5.html#config_syntax] is not typical of how we would suggest writing it. In most cases seperation of named hiearcys is only required for external sources such as Puppet Data service\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/hiera_config_yaml_5.html#config_syntax\n\n_Current text :_\n\n\u00a0\n{code:java}\nversion: 5\ndefaults: \u00a0# Used for any hierarchy level that omits these keys.\n\u00a0 datadir: data \u00a0 \u00a0 \u00a0 \u00a0 # This path is relative to hiera.yaml's directory.\n\u00a0 data_hash: yaml_data \u00a0# Use the built-in YAML backend.\nhierarchy:\n\u00a0 - name: \"Per-node data\" \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 # Human-readable name.\n\u00a0 \u00a0 path: \"nodes/%{trusted.certname}.yaml\" \u00a0# File path, relative to datadir.\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0# ^^^ IMPORTANT: include the file extension!\n\u00a0 - name: \"Per-datacenter business group data\" # Uses custom facts.\n\u00a0 \u00a0 path: \"location/%{facts.whereami}/%{facts.group}.yaml\"\n\u00a0 - name: \"Global business group data\"\n\u00a0 \u00a0 path: \"groups/%{facts.group}.yaml\"\n\u00a0 - name: \"Per-datacenter secret data (encrypted)\"\n\u00a0 \u00a0 lookup_key: eyaml_lookup_key \u00a0 # Uses non-default backend.\n\u00a0 \u00a0 path: \"secrets/nodes/%{trusted.certname}.eyaml\"\n\u00a0 \u00a0 options:\n\u00a0 \u00a0 \u00a0 pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem\n\u00a0 \u00a0 \u00a0 pkcs7_public_key: \u00a0/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem\n\u00a0 - name: \"Per-OS defaults\"\n\u00a0 \u00a0 path: \"os/%{facts.os.family}.yaml\"\n\u00a0 - name: \"Common data\"\n\u00a0 \u00a0 path: \"common.yaml\"\n{code}\n\u00a0\n\n_Suggested improvement:_\n{code:java}\nversion: 5\ndefaults: \u00a0# Used for any hierarchy level that omits these keys.\n\u00a0 datadir: data \u00a0 \u00a0 \u00a0 \u00a0 # This path is relative to hiera.yaml's directory.\nhierarchy:\n\u00a0 - name: \"Hiera data in yaml and eyaml files committed to the control-repo\"\n\u00a0 \u00a0 lookup_key: eyaml_lookup_key\n\u00a0 \u00a0 options:\n\u00a0 \u00a0 \u00a0 pkcs7_private_key: /etc/puppetlabs/puppet/eyaml/private_key.pkcs7.pem\n\u00a0 \u00a0 \u00a0 pkcs7_public_key: \u00a0/etc/puppetlabs/puppet/eyaml/public_key.pkcs7.pem\n\u00a0 \u00a0 paths:\n\u00a0 \u00a0 \u00a0 - \"nodes/%{trusted.certname}.yaml\"\n\u00a0 \u00a0 \u00a0 - \"location/%{facts.whereami}/%{facts.group}.yaml\"\n\u00a0 \u00a0 \u00a0 - \"groups/%{facts.group}.yaml\"\n\u00a0 \u00a0 \u00a0 - \"secrets/nodes/%{trusted.certname}.eyaml\"\n\u00a0 \u00a0 \u00a0 - \"os/%{facts.os.family}.yaml\"\n\u00a0 \u00a0 \u00a0 - \"common.yaml\"{code}\n*Summary:*\n\nAs adivsed by [~accountid:557058:97578a32-3955-4c5c-939e-58a878437b49] its more typical with eyaml and yaml specifically to\u00a0 ONLY use lookup_key: eyaml because eyaml can read yaml values just fine, and you don\u2019t have to encrypt every key. You can just encrypt the ones you want encrypted.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54820", "fixedVersions": [], "id": "54820", "issueType": "Improvement", "key": "DOCUMENT-1307", "labels": [ "Hiera", "osp" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Revise Hiera Config Syntax", "timeSpent": "PT0S", "updated": "2023-05-17T18:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Hi [~accountid:623c0f891c7f6a007049e734], thank you for the recommendation. We've made that change in the docs and it will be live shortly.\u00a0\u00a0", "created": "2022-03-09T14:39:00.000000" } ], "components": [ "PE" ], "created": "2022-03-08T19:08:00.000000", "creator": "623c0f891c7f6a007049e734", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6730b6e3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0f1ra:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Mar/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_52863315_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_17360883" } ], "description": "*Problem:*\n\nThe documentation at [https://puppet.com/docs/pe/2021.5/supported_operating_systems.html#supported_operating_systems] states that \"All primary servers require a 64-bit architecture.\" Currently, the PE primary installation package is only available for x86-64. Unless there are plans to release packages for other architectures, such as aarch64, in the near term, it would be better to explicitly list x86 as a requirement.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.5/supported_operating_systems.html#supported_operating_systems]\n\n_Current text :_\n\nAll primary servers require a 64-bit architecture.\n\n_Suggested improvement:_\n\nAll primary servers require *an x86-64* architecture.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54729", "fixedVersions": [], "id": "54729", "issueType": "Improvement", "key": "DOCUMENT-1306", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Low (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0f891c7f6a007049e734", "resolution": "Fixed", "resolutionDate": "2022-03-09T14:39:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]", "timeSpent": "PT0S", "updated": "2022-03-09T14:39:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:60e4906e4134aa006931a5d6]\u00a0", "created": "2022-03-08T10:30:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Probably not relevant to the OSP docs, but some information about the metrics modules were added to the PE docs recently since these modules are now included and (partially) enabled by default. Just dropping the link here in case it helps whomever works on this. [https://puppet.com/docs/pe/2021.5/metrics_collection.html#metrics_collection]\u00a0", "created": "2022-03-22T08:44:00.000000" } ], "components": [], "created": "2022-03-08T10:27:00.000000", "creator": "5b590061a3f8512ca5eb3be7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3872b99c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0exxy:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Mar/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_592695040_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_12803119062" } ], "description": "[This article|https://puppet.com/docs/puppet/7/server/puppet_server_metrics.html]\u00a0about monitoring Puppet sever metrics is out-of-date and could use a refresher. It could also be an opportunity to plug the beta version of the [new metrics dashboard|https://forge.puppet.com/modules/puppetlabs/puppet_operational_dashboards], and I can help with identifying what should go in the new article.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54329", "fixedVersions": [], "id": "54329", "issueType": "Improvement", "key": "DOCUMENT-1305", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b590061a3f8512ca5eb3be7", "resolution": "Duplicate", "resolutionDate": "2022-08-10T12:31:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Monitoring Puppet Server metrics article", "timeSpent": "PT0S", "updated": "2022-08-10T12:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:60e4906e4134aa006931a5d6] This one is for you.", "created": "2022-03-08T09:55:00.000000" } ], "components": [], "created": "2022-03-07T10:57:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@30ccdcd7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0hriw:f" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "47571" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Mar/22" } ], "description": "The --tasks option is not documented on the puppet parser man page:\nhttps://puppet.com/docs/puppet/7/man/parser.html\n\nThis is an important parameter as without it validation fails against tasks and plans", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54963", "fixedVersions": [], "id": "54963", "issueType": "Improvement", "key": "DOCUMENT-1304", "labels": [ "generated-docs", "jira_escalated", "osp", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Jul/23 11:09 AM", "summary": "Puppet parser validate --tasks is not documented", "timeSpent": "PT0S", "updated": "2023-07-11T11:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "609a8eb65998a60068d12a0a", "body": "Apologies I miss read versions", "created": "2022-02-28T06:15:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Ok so it was tried and worked this was \u00a0v2021.4.0 and Bitbucket is self hosted and v7.16.0 despite KB article indicating this was for older puppet. Spoke to Suzanne who is going to update KB too", "created": "2022-02-28T14:59:00.000000" } ], "components": [], "created": "2022-02-28T03:34:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5f837c87" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0exct:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_78428196_*|*_3_*:*_1_*:*_317739_*|*_5_*:*_1_*:*_0_*|*_6_*:*_1_*:*_31323804_*|*_10006_*:*_1_*:*_695885943" } ], "description": "*Problem:*\n\nThe code manager configuration page [https://puppet.com/docs/pe/2021.5/code_mgr_config.html]\ndoesn't include the information in this kb [https://support.puppet.com/hc/en-us/articles/227829007-Fix-your-Bitbucket-Stash-Code-Manager-configuration-in-Puppet-Enterprise-2015-3-to-2017-2]\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2021.5/code_mgr_config.html] and all previous and current versions we can edit\n\n_Current text :_\n\nr10k_remote - Enter a string that is a valid SSH URL for your Git control repository. For example: \"git@:puppet/control.git\".\n\n_Suggested improvement:_\n\nr10k_remote - Enter a string that is a valid SSH URL for your Git control repository. For example: \"git@:puppet/control.git\".\n\nor for Bitbucket r10k_remote - Enter a string that is a valid SSH URL for your Git control repository. For example: \"git@:puppet/control.git\".\n\n*For Bitbucket you must add ssh://\u00a0 for example \"ssh://git@:puppet/control.git\".*\n\n*Summary:*\n\nThe information in [https://support.puppet.com/hc/en-us/articles/227829007-Fix-your-Bitbucket-Stash-Code-Manager-configuration-in-Puppet-Enterprise-2015-3-to-2017-2] is missing from our code manager configuration documetnation", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54962", "fixedVersions": [], "id": "54962", "issueType": "Bug", "key": "DOCUMENT-1303", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-03-09T11:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] code manager configuration doesn't mention bitbucket difference", "timeSpent": "PT0S", "updated": "2022-03-09T11:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2022-02-23T09:08:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@698713" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0emee:" } ], "description": "The doc \u00a0[https://puppet.com/docs/puppet/7/types/exec.html] and [https://puppet.com/docs/puppet/6/types/exec.html] talk about the importance of idempotency and highlight the 3 scenarios to make an exec idempotent, but in one of them, where the command being run itself is idempotent, it should note: even if the command is idempotent, it will still mark a changed resource, because the command will run in every puppet run; therefore, the other 2 scenarios should always be used to avoid this.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54727", "fixedVersions": [], "id": "54727", "issueType": "Improvement", "key": "DOCUMENT-1302", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The exec resource type page should highlight a command being idempotent won't stop it logging events", "timeSpent": "PT0S", "updated": "2023-05-17T18:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-02-18T03:47:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1cef93e3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ejr2:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_368105125_*|*_3_*:*_1_*:*_131593_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_14603523247" } ], "description": "*Problem:*\u00a0\n\nIn the document [https://puppet.com/docs/puppet/7/lang_resources.html#lang_resources-namevars-and-name] it states that provider is a namevar for the package type. I think that was true in puppet 5 but with puppet 6 + the namevar is now name and command. As per [https://puppet.com/docs/puppet/6/types/package.html] compared to [https://puppet.com/docs/puppet/5.5/types/package.html]\u00a0\n\n*Suggested improvement:*\n\n\u00a0https://puppet.com/docs/puppet/7/lang_resources.html#lang_resources-namevars-and-name and \u00a0https://puppet.com/docs/puppet/6/lang_resources.html#lang_resources-namevars-and-name\u00a0\n\n_Current text :_\n\nFor example, both the yum provider and the gem provider have mysql packages, so both the name and the provider attributes are namevars, and Puppet uses both to identify the resource.\n\n_Suggested improvement:_\n\nFor example, both the yum provider and the gem provider have mysql packages, so both the name and the *command* attributes are namevars, and Puppet uses both to identify the resource.\n\n*Summary:*\n\nThe namevars changed from puppet 5 to 6 for package\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54607", "fixedVersions": [], "id": "54607", "issueType": "New Feature", "key": "DOCUMENT-1301", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-08-10T11:36:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Package type NAMEVAR changed from puppet 5 to 6 resource doc needs updated", "timeSpent": "PT0S", "updated": "2022-08-10T11:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "* {{puppet-code-repo - }}This is the name we use internally for the Puppet code repo (ie the thing at the codedir) which contains all the code at that should be synced across compilers (usually including all user supplied code repos). This is configurable in files for testing purposes but must be coordinated across several services and should not be changed.\n ** Type: String\n ** Default: \"puppet-code\"\n ** Not Configurable/Should not change\n\n * {{enable-file-sync-locking -\u00a0}} File-sync {_}client{_}'s default behavior is to \"lock\" the JRuby pool, causing nearly all requests the Puppet Server to block. They will block until the currently executing requests are finished and then file-sync will sync the codedir and release the lock. At which time the Puppet Server will begin to serve requests again. This toggles the behavior of \"locking\" the JRuby pool.\n ** Type: Boolean\n ** Default: true\n ** Configurable in data via {{puppet_enterprise::master::file_sync::file_sync_locking_enabled}} / Discouraged from changing (see Note)\n\n * {{pre-commit-hook-commands -\u00a0}} Scripts which the file-sync _storage server_ will execute against a repo after it receives a change but before those changes are committed and synced across compilers. This provides a similar ability to r10k's \"post deploy hook\" and the \"generate-puppet-types.rb\" script will do exactly that. There is more documentation detailing the inputs to the script in the [dev docs|https://github.com/puppetlabs/pe-puppet-server-extensions/blob/2019.8.x/documentation/config_settings.markdown#pre-commit-hook-commands].\n ** Type: Array of Strings\n ** Default: [ \"/opt/puppetlabs/server/bin/generate-puppet-types.rb\"]\n ** Configurable in data via {{puppet_enterprise::master::puppetserver::pre_commit_hook_commands}} / If users wish to configure they should be warned that their values will override the default and the element \"/opt/puppetlabs/server/bin/generate-puppet-types.rb\" should still be included in their values, unless the explicitly want to disable type generation in this way.\n\n\u00a0\n\n\u00a0\n\n{_}Note{_}: When set to {{false}} the behavior is similar to FOSS installs running r10k without coordination between the r10k run and the Server. Instead of disabling this locking we recommend users enable {{versioned-dirs}} (see [lockless deploys documentation|https://puppet.com/docs/pe/2021.6/lockless-code-deploys.html#lockless-code-deploys] which will deploy the puppet code repo into versioned directories and turn the codedir into a symlink which points to the latest version.", "created": "2022-06-06T11:03:00.000000" } ], "components": [], "created": "2022-02-17T02:09:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7f44f2ff" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0egy6:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/May/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_459852803_*|*_3_*:*_1_*:*_13148728_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_25406455_*|*_10006_*:*_1_*:*_60003773_*|*_10016_*:*_2_*:*_2927399385_*|*_10005_*:*_1_*:*_6046697502" } ], "description": "Hi!\nPuppet Enterprise links to https://puppet.com/docs/pe/2019.8/config_puppetserver.html#pe_puppet_server_conf_settings for puppet server configuration. PE ships the /etc/puppetlabs/puppetserver/conf.d/pe-puppet-server.conf file. The file contains some puppetserver options but also:\n{code}\npe-puppetserver: {\n puppet-code-repo: puppet-code\n pre-commit-hook-commands:[\n \"/opt/puppetlabs/server/bin/generate-puppet-types.rb\"\n ]\n enable-file-sync-locking: true\n}\n{code}\n\nthose options are not documented in the puppetserver docs and not in the enterprise docs. Could you please:\n* document the existing options\n* check if there are a few settings in that block that are currently not used but could be configured?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54528", "fixedVersions": [], "id": "54528", "issueType": "Improvement", "key": "DOCUMENT-1300", "labels": [ "pe", "puppet-server" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-06-07T11:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Please document /etc/puppetlabs/puppetserver/conf.d/pe-puppet-server.conf specific settings", "timeSpent": "PT0S", "updated": "2022-06-07T11:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [ "DOC" ], "created": "2022-01-31T17:41:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@512862e9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0e41s:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_58912627_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_97279399" } ], "description": "The \"report processor enabled\" link on https://puppet.com/docs/puppet/7/reporting_about.html is broken. It links to https://puppet.com/docs/puppetdb/latest/connect_puppet_master.html which has moved to https://puppet.com/docs/puppetdb/latest/connect_puppet_server.html.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54818", "fixedVersions": [], "id": "54818", "issueType": "Bug", "key": "DOCUMENT-1298", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2022-02-02T13:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"report processor enabled\" link broken on https://puppet.com/docs/puppet/7/reporting_about.html", "timeSpent": "PT0S", "updated": "2022-02-02T13:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "5b64ddd7d1e8dc2d916c6289", "body": "bulk_pluginsync is a tar file that is generated to ship all of the custom facts and resources in your environment over to the node you are installing the agent on in order to make the installation process faster, so the things don't need to be downloaded one by one. If you're seeing this error, it's likely either an issue that's been fixed in the latest releases, or an issue with the bulk_pluginsync tar generation process on the primary. ", "created": "2022-02-01T14:08:00.000000" }, { "author": "61ba0348acc926006a06fc59", "body": "[~accountid:5b64ddd7d1e8dc2d916c6289] We install all the packages listed in the required package list on new servers before running the script. But if we start with a minimal image and the server does not have the tar package, the install script will fail if bulk plugin sync is active (which is the default). So tar is missing in the package list.", "created": "2022-02-01T15:10:00.000000" }, { "author": "5b64ddd7d1e8dc2d916c6289", "body": "Oh, I misunderstood. You mean the actual package that provides the {{tar}} binary itself. You're right, we should add that for all the platforms.", "created": "2022-02-01T15:19:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:61ba0348acc926006a06fc59] thank you for letting us know about this. I've added {{tar}} to all platforms, as suggested by [~accountid:5b64ddd7d1e8dc2d916c6289].\u00a0\n\n[https://puppet.com/docs/pe/2021.4/supported_operating_systems.html#platform-dependencies]\u00a0", "created": "2022-02-02T12:48:00.000000" } ], "components": [ "PE" ], "created": "2022-01-26T07:05:00.000000", "creator": "61ba0348acc926006a06fc59", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@14e1e032" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0dxw8:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/Jan/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_449272214_*|*_3_*:*_1_*:*_2075534_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_173894950_*|*_10006_*:*_1_*:*_132204" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.4/supported_operating_systems.html#centos_dependencies\n\n_Current text :_\n\nThe table is missing the tar package\n\n_Suggested improvement:_\n\nadd the tar package\n\n*Summary:*\n\nWhen trying to install a puppet agent on a minimal image with centos 8, I received an error in the bulk_pluginsync section, tar is not found.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55123", "fixedVersions": [], "id": "55123", "issueType": "Bug", "key": "DOCUMENT-1297", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "61ba0348acc926006a06fc59", "resolution": "Done", "resolutionDate": "2022-02-02T12:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PE supported_operating_systems centos_dependencies tar package missing", "timeSpent": "PT0S", "updated": "2022-02-02T12:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2022-01-14T08:14:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6241c1e2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0djig:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_350497691_*|*_3_*:*_1_*:*_254851_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_76031379" } ], "description": "*Problem:*\n\ncommand is missing a closing bracket for api call\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2019.8/forming_node_classifier_requests.html#forming_node_classifier_requests\n\n_Current text :_\n\ntype_header='Content-Type: application/json'\ncert=\"$(puppet config print hostcert)\"\ncacert=\"$(puppet config print localcacert)\"\nkey=\"$(puppet config print hostprivkey)\"\nuri=\"https://$(puppet config print server:4433/classifier-api/v1/groups\"\n\ncurl --header \"$type_header\" --cert \"$cert\" --cacert \"$cacert\" --key \"$key\" \"$uri\"\n\n_Suggested improvement:_\n\ntype_header='Content-Type: application/json'\ncert=\"$(puppet config print hostcert)\"\ncacert=\"$(puppet config print localcacert)\"\nkey=\"$(puppet config print hostprivkey)\"\nuri=\"https://$(puppet config print server{*}){*}:4433/classifier-api/v1/groups\"\n\ncurl --header \"$type_header\" --cert \"$cert\" --cacert \"$cacert\" --key \"$key\" \"$uri\"\n\n*Summary:*\n\nIn the uri variable assignment a closing bracket is missing to get the hostname", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54817", "fixedVersions": [], "id": "54817", "issueType": "Bug", "key": "DOCUMENT-1295", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-01-19T06:47:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] command is missing a closing bracket for api call", "timeSpent": "PT0S", "updated": "2022-01-19T06:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "body": "Here's the equivalent docs page from GitHub, where {{-t ed25519}} is recommended as the default method of generating keys:\n\nhttps://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent\n\nUsing {{-t rsa}} will cease to function out-of-the-box after March 15th unless PE-33354 is resolved by a PE patch release.", "created": "2022-01-11T12:27:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Theres further documents such as [https://puppet.com/docs/pe/2019.8/code_mgr_config.html#code_mgr_enable] which refer to id-control_repo.rsa which may want to do a search and generally update.", "created": "2022-01-11T15:38:00.000000" } ], "components": [], "created": "2022-01-11T10:01:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6e792c26" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0dfcw:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jan/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_16144303_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_27652963_*|*_10005_*:*_1_*:*_587214460" } ], "description": "*Problem:*\nGithub are tightening their key requirements as per [https://github.blog/2021-09-01-improving-git-protocol-security-github/] but due to our use of libssh2 the keys are no longer working (discussed with Charlie Sharpsteen)\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/control_repo.html]\n\nInclude the text that should be corrected or improved here.\n\nssh-keygen -t rsa -b 2048 -P '' -f /etc/puppetlabs/puppetserver/ssh/id-control_repo.ed25519\n\nProvide suggested improvements here. When adding specific text, please {*}bold changes{*}.\n\nssh-keygen -t *ed25519* -P '' -f /etc/puppetlabs/puppetserver/ssh/id-control_repo.{*}ed25519{*}\n\n*Summary:*\n\n\u00a0It may make sense to change it to a note on an incompatibility with github and to use ed25519 in that case", "environment": "*strong text*", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54604", "fixedVersions": [], "id": "54604", "issueType": "Bug", "key": "DOCUMENT-1292", "labels": [ "code-mgmt", "pe", "r10k" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-01-18T17:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] rsa key generation doesn't work for github", "timeSpent": "PT0S", "updated": "2022-01-18T17:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "I knew you can define a parameterized Integer type and iterate that (like a range):\n\n{noformat}\n$ bx puppet apply -e 'Integer[0,1].each |$i| { notice($i) }'\nNotice: Scope(Class[main]): 0\nNotice: Scope(Class[main]): 1\n{noformat}\n\nBut I didn't know you could iterate the integer directly:\n\n{noformat}\n$ bx puppet apply -e '2.each |$i| { notice($i) }'\nNotice: Scope(Class[main]): 0\nNotice: Scope(Class[main]): 1\n{noformat}\n\nNote there seems to be an off-by-one issue though. The [comment|https://github.com/puppetlabs/puppet/blob/7.13.1/lib/puppet/pops/types/iterable.rb#L44] says it yields the number, but it only yields up to, but not including the number, which is surprising given that {{Integer[0, 1]}} is inclusive by default.\n", "created": "2022-01-06T09:57:00.000000" }, { "author": "623c0d687910a200718b9199", "body": "I'd say the comment is ambiguous", "created": "2022-01-06T15:53:00.000000" }, { "author": "70121:4596f954-1fdf-472f-a700-6b7c2ffbc525", "body": "[~accountid:5b0340d43eafdb09dee5bc3a] , fyi", "created": "2022-01-10T08:20:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "I'm going to move this to DOCUMENT so it's more visible to the docs team", "created": "2022-01-13T10:51:00.000000" } ], "components": [ "DOC" ], "created": "2022-01-05T17:50:00.000000", "creator": "623c0d687910a200718b9199", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@493a82aa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0dbyg:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Jan/22" } ], "description": "I discovered, entirely by accident, that an Integer is an Iterable which expands to the range from zero to one less than the Integer. I can find this in the code and it's clearly an intended behavior:\n\nhttps://github.com/puppetlabs/puppet/blob/7.13.1/lib/puppet/pops/types/iterable.rb#L44\nhttps://github.com/puppetlabs/puppet/blob/7.13.1/lib/puppet/pops/types/iterable.rb#L92\n\nI can't find this documented at all, though. Unless I'm missing something, the closest I can find is references to the Iterable type, though these pages don't enumerate what the type contains:\nhttps://puppet.com/docs/puppet/7/functions_iterative.html\nhttps://puppet.com/docs/puppet/7/lang_data_abstract.html#iterable-data-type\n\nThanks,\nCorey", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54959", "fixedVersions": [], "id": "54959", "issueType": "Improvement", "key": "DOCUMENT-1293", "labels": [ "Language", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0d687910a200718b9199", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Iterable behavior of Integers not documented?", "timeSpent": "PT0S", "updated": "2023-05-17T18:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [ { "attacher": "5b565d7b8d25d52cd63245c5", "created": "2022-01-04T09:16:00.000000", "name": "_Firewall_Postgres.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14230" }, { "attacher": "5b565d7b8d25d52cd63245c5", "created": "2022-01-04T08:41:00.000000", "name": "_Firewall_XL.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14221" }, { "attacher": "60e30461471e61006a2ea157", "created": "2022-01-04T04:50:00.000000", "name": "pe-post3.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14229" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:60e30461471e61006a2ea157], I want to make sure I understand the necessary changes:\n # The connection from PE Server to Postgres should be 1-way, and currently it is facing the wrong way in the diagram.\n # The connection from PE Replica Server to Postgres should be 1-way, and currently it is 2-way in the diagram.\n # Update the 5432 row in the table to reflect the correct, 1-way connections.\n\nIs this correct?", "created": "2022-01-04T07:50:00.000000" }, { "author": "60e30461471e61006a2ea157", "body": "HI [~accountid:616989d3048360006aeb55e8]\u00a0\n # Correct\n # Correct\n # Correct\n\nThanks.", "created": "2022-01-04T07:57:00.000000" }, { "author": "5b565d7b8d25d52cd63245c5", "body": "[~accountid:616989d3048360006aeb55e8] Grand, that's a quick fix. Here is the updated diagram. Let me know if it looks correct:\n!_Firewall_XL.png|thumbnail! \n\nI also noticed there is another diagram with Postgres connections on that page in the docs: https://puppet.com/docs/pe/2019.8/system_configuration.html#firewall_postgres\n\nIt also shows a two way connection between the PE server and Postgres. Should that diagram also be updated to a one way PE server -> Postgres?", "created": "2022-01-04T08:44:00.000000" }, { "author": "60e30461471e61006a2ea157", "body": "[~accountid:5b565d7b8d25d52cd63245c5] that updated diagram now looks correct.\n\n\u00a0\n\nThe second diagram that you linked also looks incorrect and should mirror the firewall rules of the XL architecture. \u00a0[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] could you confirm?", "created": "2022-01-04T08:51:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:60e30461471e61006a2ea157] Indeed.", "created": "2022-01-04T08:59:00.000000" }, { "author": "60e30461471e61006a2ea157", "body": "[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] has confirmed that [https://puppet.com/docs/pe/2019.8/system_configuration.html#firewall_postgres] should also reflect the unidirectional connection.", "created": "2022-01-04T08:59:00.000000" }, { "author": "5b565d7b8d25d52cd63245c5", "body": "Updated the Firewall Postgres diagram as well to a one way connection PE server -> Postgres: !_Firewall_Postgres.png|thumbnail! ", "created": "2022-01-04T09:16:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Thank you all for the quick responses. I will work on updating the doc today or tomorrow.", "created": "2022-01-04T09:24:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Hi [~accountid:60e30461471e61006a2ea157], the changes have been made. Please let me know if you need me to change the wording in the table:\n * The primary server and replica use this port to replicate\u00a0PostgreSQL\u00a0data on PE-PostgreSQL nodes.\n\n\u00a0", "created": "2022-01-04T14:22:00.000000" }, { "author": "60e30461471e61006a2ea157", "body": "Hi [~accountid:616989d3048360006aeb55e8], that wording is accurate.\n\n[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] do you think it would be beneficial to mention that the PuppetDB service manages the PostgreSQL replication?", "created": "2022-01-04T14:31:00.000000" } ], "components": [], "created": "2022-01-04T04:50:00.000000", "creator": "60e30461471e61006a2ea157", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Diagram updated to reflect attached image.\n\nSupporting text updated to reflect updated diagram." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@39d6ac5f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0da1k:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jan/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10852456_*|*_3_*:*_1_*:*_4027471_*|*_10009_*:*_1_*:*_490962678_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_17724641_*|*_10005_*:*_2_*:*_1736213" } ], "description": "For the XL architecture for Puppet, the Postrges connections over 5432 are not quite correct.\u00a0 I have provided an updated diagram that correctly reflects just the connections between the PE server, PE replica and the Postgres databases.\n\n\u00a0\n\n[https://puppet.com/docs/pe/2019.8/system_configuration.html#firewall_xl]\n\n\u00a0\n\nThe error relates to the direction of the 5432 connections.\u00a0 The text supporting the diagram also needs updating accordingly.", "environment": "PE 2019 Public Documentation\n\nPE 2021 Public Documentation", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54957", "fixedVersions": [], "id": "54957", "issueType": "Bug", "key": "DOCUMENT-1291", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "60e30461471e61006a2ea157", "resolution": "Fixed", "resolutionDate": "2022-01-10T06:45:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Incorrect port direction for 5432 between PE servers and Postgres databases", "timeSpent": "PT0S", "updated": "2022-01-10T06:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [ "PE", "RBAC Service" ], "created": "2021-12-21T06:17:00.000000", "creator": "616989d3048360006aeb55e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@35363f07" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0d6r4:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_134334_*|*_3_*:*_2_*:*_2686831_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_2502169247" } ], "description": "Url:\n\n[https://puppet.com/docs/pe/2019.8/rbac_permissions_intro.html#user_permissions]\u00a0\n\u00a0\n\nComment:\nMissing information on *User permissions* table.\n\nIn 2019.8 there are permissions called:\n\nNodes\nAdd and delete connection information from inventory service\n-\n\n\u00a0\n\nProjects\nDeploy projects\n-\n\n\u00a0\n\nProjects\nRun tasks and plans from projects\n-\n\n\u00a0\n\nScheduled jobs\nDelete another user\u2019s scheduled jobs\nAll\n\n\u00a0\n\n\u00a0\n\n-----\n\n\u00a0\n\nEmail:\n[pieter.vander.sluis@apg.nl|mailto:pieter.vander.sluis@apg.nl]\n\nSubject:\nDocs Site Feedback\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54725", "fixedVersions": [], "id": "54725", "issueType": "Improvement", "key": "DOCUMENT-1290", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "616989d3048360006aeb55e8", "resolution": "Fixed", "resolutionDate": "2022-01-19T06:06:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Feedback - Missing Permissions from User Permissions page", "timeSpent": "PT0S", "updated": "2022-01-19T06:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:5b0340d43eafdb09dee5bc3a]\u00a0 I am guessing this would be needed on both LTS and latest?", "created": "2021-12-16T14:03:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "Yeah, definitely both", "created": "2021-12-16T15:17:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Nick Burgan suggested adding this wording that I will add to the doc today:\n\nFor agents, you can exclude C:\\ProgramData\\PuppetLabs\\pe_patch if your antivirus is holding a lock on log files and causing patching failures.", "created": "2021-12-17T10:03:00.000000" } ], "components": [], "created": "2021-12-16T08:54:00.000000", "creator": "6220dbd449c90000701fd0c5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@426e6d73" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0d4ls:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Dec/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14648057_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_6778040_*|*_10005_*:*_1_*:*_75897188" } ], "description": "Have an open ticket where we suspect antivirus of locking pe-patch log files but client's security team is wary of exclusions unless they are officially documented.\n\nThis section is obviously intended for the primary server, however we seem to be lacking a section for agents and more specifically Windows agents. If something could be created with even some very general parameters (such as excluding .log files in a puppet directory) that could be publicly viewable that would be great.\n\nhttps://puppet.com/docs/pe/2019.8/system_configuration.html#antivirus-considerations", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54724", "fixedVersions": [], "id": "54724", "issueType": "Task", "key": "DOCUMENT-1289", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbd449c90000701fd0c5", "resolution": "Fixed", "resolutionDate": "2021-12-17T11:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Expand Antivirus/antimalware Considerations to Agents", "timeSpent": "PT0S", "updated": "2021-12-17T11:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Docs note: Boolean should also be capitalized", "created": "2022-01-04T10:10:00.000000" } ], "components": [ "Puppet Language" ], "created": "2021-12-16T02:27:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@30a46aed" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0d4g0:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jan/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1669382005_*|*_3_*:*_1_*:*_607584_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_18836874425_*|*_10005_*:*_1_*:*_7291" } ], "description": "https://puppet.com/docs/puppet/7/lang_data_boolean.html says \"accepts no parameters\". But the Boolean type actually accepts a parameter of either true or false, e.g. {{Boolean[true] $b}}, which restricts the accepted data to the value given as a parameter.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55122", "fixedVersions": [], "id": "55122", "issueType": "Bug", "key": "DOCUMENT-1288", "labels": [ "documentation", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2022-08-10T11:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Boolean data type can take a parameter, but docs say it accepts no parameters", "timeSpent": "PT0S", "updated": "2022-08-10T11:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-12-14T05:25:00.000000", "creator": "623c100c4a57610068e74585", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e349617" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hynm5k:" } ], "description": "In the report format documentation ([https://puppet.com/docs/puppet/7/format_report.html#puppet-util-metric]) it states:\n{quote}{{resources}} Includes the metrics {{{}failed{}}}, {{{}out_of_sync{}}}, {{{}changed{}}}, and {{{}total{}}}. Each value in the {{resources}} category is an integer.\n{quote}\nThe JSON schema has more. Copying from [https://github.com/puppetlabs/puppet/blob/c4e72a38fad7d768a38a6f80d9a4c435a5ee9b8b/api/schemas/report.json#L304-L317] I can see:\n * failed\n * out_of_sync\n * changed\n * total\n * skipped\n * failed_to_restart\n * restarted\n * scheduled\n * corrective_change\n\nAre some simply not reported but still referenced in the schema or is the documentation incomplete?\n\nAnother thing that isn't clear to me is whether corrective_change is part of changed or if I need to add them together to get the complete changed resource count.\n\nSimilarly, is failed_to_restart part of failed or do I need to add these together?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54114", "fixedVersions": [], "id": "54114", "issueType": "Improvement", "key": "DOCUMENT-1287", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c100c4a57610068e74585", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Inconsistent documentation for report metrics", "timeSpent": "PT0S", "updated": "2023-05-17T18:04:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-12-14T05:08:00.000000", "creator": "623c100c4a57610068e74585", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7bb9e513" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hynm5o:" } ], "description": "In the report format documentation for status ([https://puppet.com/docs/puppet/7/format_report.html#puppet-resource-status|https://puppet.com/docs/puppet/7/format_report.html#puppet-resource-status)]) there are deprecations. Both {{out_of_sync}} and {{changed}} are clear in what's the replacement, but {{failed}} isn't.\n\nI did some digging and found that it's also there in the schema ([https://github.com/puppetlabs/puppet/blob/main/api/schemas/report.json] - [https://github.com/puppetlabs/puppet/blob/c4e72a38fad7d768a38a6f80d9a4c435a5ee9b8b/api/schemas/report.json] at the time of writing). A simple git blame points to [https://github.com/puppetlabs/puppet/commit/ec07b5c2b5fabdfb29823443ccf170db58932e6c] (changed in 2013) but that just moves things around. [https://github.com/puppetlabs/puppet/commit/e957ab9bd119695ba15941074030127f38ab8f33] added it as new files. That documents report format 3, also way back in 2013.\n\nI'm writing a report processor and I'm trying to figure out how to best consume this. What should I use?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55121", "fixedVersions": [], "id": "55121", "issueType": "Improvement", "key": "DOCUMENT-1286", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c100c4a57610068e74585", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Unclear deprecations in the report format", "timeSpent": "PT0S", "updated": "2023-05-17T18:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2021-12-14T02:28:00.000000", "name": "2021-12-14-102820_1657x197_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14268" } ], "comments": [], "components": [], "created": "2021-12-14T02:28:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c06fe5e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0d2rk:" } ], "description": "Hi,\nwhile browsing https://puppet.com/docs/puppet/7/types/exec.html#exec-attribute-path is noticed that one sentence isn't complete:\n{quote}The search path used for command execution. Commands must be fully qualified if no path is specified. Paths can be specified as an array or as a '{quote}\n\nMaybe the single quote breaks the rendering?\n\n !2021-12-14-102820_1657x197_scrot.png|thumbnail! ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55120", "fixedVersions": [], "id": "55120", "issueType": "Bug", "key": "DOCUMENT-1285", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "exec resource documentation is missing some words", "timeSpent": "PT0S", "updated": "2023-05-17T18:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [ "PE" ], "created": "2021-12-09T10:52:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3b0afb83" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0d0nc:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_416939051_*|*_3_*:*_1_*:*_213635_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_8850916" } ], "description": "On this page: [https://puppet.com/docs/pe/2019.8/pe_database_maintenance.html]\n\nThe text is:\n\nTo enable the module, set the parameter to {{{}true{}}}.\n\u00a0\n{{puppet_enterprise::enable_database_maintenace: true}}\n\n\u00a0\n\nIn the above example, the word maintenance is misspelled.\n\nOf course, as I type this I'm using a brand new keyboard, so I'm sure there are typos in my own writing.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54714", "fixedVersions": [], "id": "54714", "issueType": "Task", "key": "DOCUMENT-1284", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2021-12-14T09:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in pe_databases example configuration", "timeSpent": "PT0S", "updated": "2021-12-14T09:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2021-12-01T09:28:00.000000", "name": "2021-12-01-172754_609x1727_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14240" } ], "comments": [], "components": [], "created": "2021-12-01T09:28:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@30a729a0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cspk:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_518732005_*|*_4_*:*_1_*:*_7113_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_7442559130_*|*_10005_*:*_1_*:*_3723" } ], "description": "Hi,\nat https://puppet.com/docs/puppetdb/7/configure.html , the API section is listed twice in the left navigation bar\n\n !2021-12-01-172754_609x1727_scrot.png|thumbnail! ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54845", "fixedVersions": [], "id": "54845", "issueType": "Bug", "key": "DOCUMENT-1283", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-03-03T12:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PuppetDB 7 docs list API documentation twice", "timeSpent": "PT0S", "updated": "2022-03-03T12:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "60e4906e4134aa006931a5d6", "body": "The OS support listed in 2019.8.9 is correct, as per [https://confluence.puppetlabs.com/display/PROD/Currently+Supported+OS+Platforms] . This has changed in Puppet 7.x, but should not have changed in Puppet 6.x.", "created": "2021-12-14T21:49:00.000000" } ], "components": [], "created": "2021-11-30T08:34:00.000000", "creator": "6088343433d5250069016105", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@28c7d7a5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cryw:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Dec/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_3373043_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_649011742_*|*_10005_*:*_1_*:*_605419303" } ], "description": "*Problem:*\u00a0we have some inconsistencies in the\u00a0[2019.8.9|https://puppet.com/docs/pe/2019.8/supported_operating_systems.html#supported_operating_systems_and_devices-supported-agent-platforms]\u00a0and Platform\u00a0[6.25.1|https://puppet.com/docs/puppet/6/system_requirements.html#supported_operating_systems]\u00a0docs under the supported operating systems table shows SLES 11,12, 15 for PE agent but not the platform.\u00a0(edited)\u00a0\n\n\u00a0\n\n*Suggested improvement:*\n\n*[2019.8.9|https://puppet.com/docs/pe/2019.8/supported_operating_systems.html#supported_operating_systems_and_devices-supported-agent-platforms]*\u00a0\n\n*[6.25.1|https://puppet.com/docs/puppet/6/system_requirements.html#supported_operating_systems]*\u00a0\n\n\u00a0\n\n*Please validate and correct supported operating systems for 2019.8.9 and 6.25.1 and update the table and all other references.*\u00a0", "duedate": "2021-12-03T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55119", "fixedVersions": [], "id": "55119", "issueType": "Bug", "key": "DOCUMENT-1281", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6088343433d5250069016105", "resolution": "Fixed", "resolutionDate": "2021-12-14T21:57:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Inconsistencies in the 2019.8.9 and Platform 6.25.1 public docs", "timeSpent": "PT0S", "updated": "2021-12-14T21:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "70121:4596f954-1fdf-472f-a700-6b7c2ffbc525", "body": "[~accountid:60e4906e4134aa006931a5d6]\u00a0 fyi", "created": "2021-12-13T04:00:00.000000" }, { "author": "70121:4596f954-1fdf-472f-a700-6b7c2ffbc525", "body": "[~accountid:5b0340d43eafdb09dee5bc3a] , fyi", "created": "2022-01-10T08:46:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "Moving to DOCUMENT so it's more visible to the docs team", "created": "2022-01-13T10:53:00.000000" } ], "components": [ "DOC" ], "created": "2021-11-18T12:54:00.000000", "creator": "623c135250bb2b0070b6b3d4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@660b14aa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cm6w:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Dec/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4831200970_*|*_3_*:*_1_*:*_223174_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_18491710508" } ], "description": "PUP-7307 /\u00a0[0d89cb1c1f44fcb30fbf8478327c2422e8a10b90|https://github.com/puppetlabs/puppet/commit/0d89cb1c1f44fcb30fbf8478327c2422e8a10b90] made `tidy` not attempt to remove managed resources, but didn't update the documentation to document this behaviour.\n\nNot removing managed resources makes perfect sense, but should be called out, as it provides n very useful way to make exceptions to `tidy`s behaviour with `recurse` is used.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54251", "fixedVersions": [], "id": "54251", "issueType": "Bug", "key": "DOCUMENT-1294", "labels": [ "puppet", "tbd" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c135250bb2b0070b6b3d4", "resolution": "Fixed", "resolutionDate": "2022-08-15T12:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Document that `tidy` does not remove managed resources", "timeSpent": "PT0S", "updated": "2022-08-15T12:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "5e3375e183d74c0e821851f3", "body": "Based on the description in this ticket, the parameters are likely still set somewhere. Here are the defaults for the related {{puppet_enterprise::profile::console}} parameters. These have been the same since 2019.4.0\n\n\u00a0\n{code:java}$browser_ssl_cert = \"/opt/puppetlabs/server/data/console-services/certs/console-cert.cert.pem\",\n$browser_ssl_private_key = \"/opt/puppetlabs/server/data/console-services/certs/console-cert.private_key.pem\",{code}\nThose keys are copied in place from {{/etc/puppetlabs/puppet/ssl/certs/console-cert.pem}} and\u00a0{{/etc/puppetlabs/puppet/ssl/private_keys/console-cert.pem}}. The defaults for these keys will be overwritten by the above parameters. After removing the two parameters, the agent run would enforce the state to update to the default settings. Since this was not corrected until those two parameters were in the console, it is likely that the parameters were not removed. You may want to check hiera with something like the following.\n\n\u00a0\n{code:java}puppet lookup puppet_enterprise::profile::console::browser_ssl_cert --node --explain --compile\npuppet lookup puppet_enterprise::profile::console::browser_ssl_private_key --node --explain --compile{code}\n\u00a0If you see those parameters in hiera, please remove them.\n\nIt may also be worth looking in the {{/etc/puppetlabs/enterprise/conf.d/**/*.conf}} files for these parameters and remove them if they exist.", "created": "2021-11-30T07:43:00.000000" }, { "author": "623a4a598d8b9c0068b7e31a", "body": "Yes, we had those settings configured in hiera. Thanks.", "created": "2021-12-06T15:24:00.000000" } ], "components": [ "Puppet Server" ], "created": "2021-11-18T12:19:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@fa90ef" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cm60:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1015763965_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_521622478" } ], "description": "Similar to DOCUMENT-1123, it seems that the steps in https://puppet.com/docs/pe/2019.8/use_a_custom_ssl_cert_for_the_console.html are still wrong. In step 4, removing browser_ssl_cert and browser_ssl_private_key from the puppet_enterprise::profile::console class causes pe-nginx to look for a key at {{/etc/ssl/private/puppet.key}} and a certificate at {{/etc/ssl/private/puppet.pem}}, which doesn't work if you have installed your custom key and cert at {{/etc/puppetlabs/puppet/ssl/private_keys/console-cert.pem}} and {{/etc/puppetlabs/puppet/ssl/certs/console-cert.pem}} according to steps 2 and 3 of that document. The pe-nginx service then fails to start because it can't load the certificate. So, it seems that you have to have browser_ssl_cert and browser_ssl_private_key specified in the PE console for it to work correctly.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54815", "fixedVersions": [], "id": "54815", "issueType": "Bug", "key": "DOCUMENT-1280", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "No Available Fix", "resolutionDate": "2021-12-06T07:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"Use a custom SSL certificate for the console\" steps incorrect", "timeSpent": "PT0S", "updated": "2021-12-06T15:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2021-11-18T06:42:00.000000", "creator": "616989d3048360006aeb55e8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76d43287" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0clxs:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7093_*|*_3_*:*_1_*:*_532886_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_762518_*|*_10006_*:*_1_*:*_3298729_*|*_10005_*:*_1_*:*_1047562944" } ], "description": "We have documentation for how to stop a task, but not for how to stop a plan.\n----\nOriginal customer feedback:\n\nComment:\n This is great for a task,\u00a0 but how do you stop a plan in progress?\n\nEmail:\n [Martin.Bain@frit.frb.org|mailto:Martin.Bain@frit.frb.org]\n\nSubject:\n Docs Site Feedback\n\nUrl:\n [https://puppet.com/docs/pe/2019.8/stop_a_task.html]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54112", "fixedVersions": [], "id": "54112", "issueType": "Improvement", "key": "DOCUMENT-1279", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "616989d3048360006aeb55e8", "resolution": "Fixed", "resolutionDate": "2021-11-30T10:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Docs Feedback - How to stop a plan in progress?", "timeSpent": "PT0S", "updated": "2021-11-30T10:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Hello [~accountid:6220db9494f7e20069fe964a], I have made the change, please review it here (Slack me if you need the password):\n\n[https://docs-herrera-preview.netlify.app/docs/pe/2021.4/patch_management_setup.html#patch_management_where_patches_come_from]\n\nI have some questions:\n\n1) Does this also apply to the LTS (2019.8.9) documentation? [https://puppet.com/docs/pe/2019.8/patch_management_setup.html#patch_management_where_patches_come_from]\u00a0\n\n2) Does this change need to be applied to the documentation immediately, or can it go out with the next release (February)?", "created": "2021-11-30T08:11:00.000000" }, { "author": "6220db9494f7e20069fe964a", "body": "Hi April,\n\nThere is no need to update\nhttps://puppet.com/docs/pe/2019.8/patch_management_setup.html#patch_management_where_patches_come_from\nreference. Thanks\n\nBest regards,\n\n*Jordi Garcia*\nSenior DevOps Engineer\nJordi.Garcia@puppet.com\n\n\nOn Tue, Nov 30, 2021 at 3:37 PM April Murphy (Jira) <\nissue-updates+AprilMurphy@puppet.com> wrote:\n\n> There is *1 comment*.\n>\n>\n> Documentation /\n> DOCUMENT-1278 In\n> Progress\n> Need to add WSUS reference to Patch management along as the tool to use to\n> restrict updates\n>\n> View issue \u00b7 Add\n> comment \n>\n> 1 comment\n>\n> *April Murphy* on 2021/11/30 7:34 AM\n>\n> Hello [~accountid:6220db9494f7e20069fe964a], does this also apply to the LTS (2019.8.9)\n> documentation? [\n> https://puppet.com/docs/pe/2019.8/patch_management_setup.html#patch_management_where_patches_come_from\n> ]\n>\n> Also, does this change need to be applied to the documentation\n> immediately, or can it go out with the next release (February)?\n>\n>\n> This message was sent by Atlassian Jira (v8.13.2#813002-sha1:c495a97) [image:\n> Atlassian logo]\n> Jira is improving email notifications, share your feedback\n> !\n> Get Jira notifications on your phone! Download the Jira Server app for\n> Android\n> \n> or iOS .\n>", "created": "2021-12-01T02:20:00.000000" } ], "components": [ "PE" ], "created": "2021-11-17T09:28:00.000000", "creator": "6220db9494f7e20069fe964a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@277b67ac" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0ck5k:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1112993677_*|*_3_*:*_2_*:*_2985297_*|*_10009_*:*_1_*:*_77972754_*|*_5_*:*_2_*:*_2787768_*|*_10006_*:*_1_*:*_4769237_*|*_10005_*:*_1_*:*_28876" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.4/patch_management_setup.html#patch_management_where_patches_come_from\n\n_Current text :_\n\n\u00a0\n{code:java}\nThe\u00a0pe_patch\u00a0module uses OS level tools or APIs to find patches for nodes. You still have to manage the configuration of your package manager, like YUM, APT, Zypper, or\u00a0Windows\u00a0Update, so your nodes can search for updates. For example, if you need to go through a proxy and you use YUM, you must configure this on your own.{code}\n\u00a0\n\n_Suggested improvement:_\n\nThe\u00a0{{pe_patch}}\u00a0module uses OS level tools or APIs to find patches for nodes. You still have to manage the configuration of your package manager, like YUM, APT, Zypper,v\u00a0*WSUS* or\u00a0Windows\u00a0Update, so your nodes can search for updates. For example, if you need to go through a proxy and you use YUM, you must configure this on your own.\n\n_Current text :_\n{code:java}\nNote:\u00a0To restrict which packages your OS finds and applies patches to, pin a package using\u00a0yum versionlock,\u00a0apt-mark, or\u00a0zypper addlock, or with a package resource defined in the catalog for the node. The\u00a0pinned_packages\u00a0field in the\u00a0pe_patch\u00a0fact refers to versions locked using these methods; it does not refer to apt\u00a0pinned\u00a0packages, which prioritize packages, rather than locking them at a specific version.{code}\n_Suggested improvement:_\n\n*Note:\u00a0If there is a need to restrict which packages/patches your OS finds and what patches get applied, use one the below processes:* \n\n\u00a0 \u00a0 \u00a0*a) For *nix agents patching: Pin a package using\u00a0{{yum versionlock}},\u00a0{{apt-mark}},\u00a0{{zypper addlock}}\u00a0or a package resource defined in the catalog for the node. The\u00a0{{pinned_packages}}\u00a0field in the\u00a0{{pe_patch}}\u00a0fact refers to versions locked using these methods. However, apt\u00a0pinned\u00a0packages is used to prioritize packages rather than locking packages at a specific version.*\n\n\u00a0 \u00a0 \u00a0*b) For Windows agents patching: Use WSUS to approve desired updates independently if the actual updates are getting delivered by WSUS or by Windows Update*\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54248", "fixedVersions": [], "id": "54248", "issueType": "Task", "key": "DOCUMENT-1278", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db9494f7e20069fe964a", "resolution": "Fixed", "resolutionDate": "2021-12-01T07:13:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Need to add WSUS reference to Patch management along as the tool to use to restrict updates ", "timeSpent": "PT0S", "updated": "2021-12-01T07:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b], do you happen to know who owns this doc?", "created": "2021-11-16T10:05:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "ping [~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b] :)", "created": "2022-02-03T05:25:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "Added to web team's work log", "created": "2022-06-06T15:51:00.000000" } ], "components": [], "created": "2021-11-11T08:27:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@75452ce4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cfvs:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_437982773_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_17469830630" } ], "description": "Hi,\nhttps://puppet.com/community/puppet-champions/ describes the puppet champions program. Champions are documented at https://puppet-champions.github.io/profiles.html, but that domain isn't listed on the puppet.com website.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54712", "fixedVersions": [], "id": "54712", "issueType": "Bug", "key": "DOCUMENT-1274", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-06-06T15:51:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet champions documentation on puppet.com isn't complete", "timeSpent": "PT0S", "updated": "2022-06-06T15:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1], can you triage this when you return?", "created": "2021-11-16T10:07:00.000000" } ], "components": [], "created": "2021-11-10T17:45:00.000000", "creator": "557058:91233464-4152-4228-81dd-172d43a52a03", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@25a1fafe" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cfmw:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/21" } ], "description": "The slack thread that started this is https://puppetcommunity.slack.com/archives/C0W298S9G/p1635784392254500\n\nThis page https://puppet.com/docs/puppet/7/config_file_oid_map.html says:\n\n{quote}\nIt is only valid on a primary Puppet server. In Puppet apply, the compiler doesn\u2019t add certificate extensions to $trusted.\n{quote}\n\nThe \"primary\" part is confusing. It would be better to say something like, \"if you want to reference human readable object identifiers (OIDs) in puppet manifests, then specify a custom trusted oid mapping file for each compiler and specify the short name for the OID in your manifest. For example, if you have a custom OID {{1.3.6.1.4.1.34380.1.2.1}}, then you can create the following file (on every compiler):\n\n{noformat}\n# cat /etc/puppetlabs/puppet/custom_trusted_oid_mapping.yaml \n---\noid_mapping:\n '1.3.6.1.4.1.34380.1.2.1':\n shortname : 'myshortname'\n longname: 'My Long Name'\n{noformat}\n\nAnd then reference the *value* of the *shortname* for that OID (\"myshortname\") in your manifest:\n\n{code:puppet}\nnotify { $trusted['myshortname']: }\n{code}\n\nIt is in theory possible for us to allow {{puppet apply}} to reference shortnames for certificate extensions. However, the node likely doesn't have a client certificate, so the point is moot.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54325", "fixedVersions": [], "id": "54325", "issueType": "Bug", "key": "DOCUMENT-1273", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:91233464-4152-4228-81dd-172d43a52a03", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Trusted OID Mapping description needs updating", "timeSpent": "PT0S", "updated": "2023-05-18T07:41:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "5a028139c24efb3c4ed448c4", "body": "Yeah I think that seems fine. I'm not sure at what point in the future we might consider dropping any mention of splunk at all from this page, but for now I suppose there is the possibility that some user on an older version of splunk_hec might convert to a fips server and not understand why the module is suddenly not working if we fail to mention this here.\u00a0", "created": "2021-11-17T08:49:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "Ok thank you! I will make the change.", "created": "2021-11-17T08:53:00.000000" } ], "components": [], "created": "2021-11-10T15:18:00.000000", "creator": "5a028139c24efb3c4ed448c4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@398a0c4f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cfa8:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_499823931_*|*_3_*:*_1_*:*_199711_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_2844927_*|*_10006_*:*_2_*:*_84018123_*|*_10005_*:*_1_*:*_1630148" } ], "description": "[The FIPS support documentation page|https://puppet.com/docs/pe/2019.8/fips.html] states that splunk_hec cannot be used with FIPS enabled servers because it uses the native Ruby SSL Gems.\n\nThis is no longer accurate. [Splunk_hec v1.1.0|https://forge.puppet.com/modules/puppetlabs/splunk_hec] now supports FIPS enabled servers. The module was modified to detect that it's running in a FIPS environment and use the Puppet internal HTTP client instead.\n\nThere are still a few limitations to how well it can support a FIPS environment. The feature set is not 100% the same, but the limitations involved with running in a FIPS environment are detailed in [this section of the splunk_hec module's readme|https://forge.puppet.com/modules/puppetlabs/splunk_hec#fips-mode].", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54710", "fixedVersions": [], "id": "54710", "issueType": "Task", "key": "DOCUMENT-1272", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a028139c24efb3c4ed448c4", "resolution": "Fixed", "resolutionDate": "2021-11-17T10:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Splunk_hec now supports FIPS enabled Puppet Servers", "timeSpent": "PT0S", "updated": "2021-11-17T10:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "Link no longer appears to be broken.", "created": "2022-04-18T10:25:00.000000" } ], "components": [], "created": "2021-11-10T06:45:00.000000", "creator": "623c0ef0761efb0069ce038e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8530a98" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cew8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Apr/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_530669786_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_13216536775" } ], "description": "h2. Who found the bug?\n\nBroken link on Open Source Puppet homepage\nh2. Where was the bug found?\n * [https://puppet.com/docs/puppet/7/puppet_index.html]\n * In the \"Learn about the Puppet platform\" section\n * Click on \"Puppet server\"\n * Link is broken (leads to https://puppet.com/docs/puppet/7/server.html)\n\nh2. What is malfunctioning?\n\nLink should work :)\nh2. What does success look like?\n\nA link leading to the puppet server doc page\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54708", "fixedVersions": [], "id": "54708", "issueType": "Bug", "key": "DOCUMENT-1271", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0ef0761efb0069ce038e", "resolution": "Cannot Reproduce", "resolutionDate": "2022-04-18T10:25:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken link in Open Source Puppet homepage", "timeSpent": "PT0S", "updated": "2022-04-18T10:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-11-07T23:55:00.000000", "creator": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Service resource documentation has been reworked so that all providers have their actual features listed and properly explained." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17198f5f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hynm5j:1" } ], "description": "The [Service resource documentation|https://puppet.com/docs/puppet/6/types/service.html] says there are provider features \"delayed_startable\" and \"manual_startable\" but it doesn't tell which provider actually supports these (I guess it's Windows, though).\n\nThe same is true for \"maskable\", which I believe is a feature of systemd.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54110", "fixedVersions": [], "id": "54110", "issueType": "Improvement", "key": "DOCUMENT-1270", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Service resource documentation doesn't tell which provider has features \"delayed_startable\" and/or \"manual_startable\"", "timeSpent": "PT0S", "updated": "2023-05-17T18:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "We have two tickets referencing this same typo. I am closing this ticket, because we will track the work on the other ticket.", "created": "2022-08-10T15:26:00.000000" } ], "components": [], "created": "2021-11-05T08:28:00.000000", "creator": "557058:fe90cc1f-7037-43dd-b189-cc0a891922b8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@22ece14a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cbmo:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Aug/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_345894098_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_23698379757" } ], "description": "*Problem:*\n\nIn the examples of the {{capitalize}} function, one of the examples given is using the {{upcase}} function instead of the {{capitalize}} function.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/function.html#capitalize\n\n_Current text :_\n\n'hello'.capitalize()\nupcase('hello')\n\n\u00a0\n\n\u00a0\n\n_Suggested improvement:_\n\n'hello'.capitalize()\n*capitalize('hello')*\n\n*Summary:*\n\n\u00a0Just need to update the function used in the example.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54109", "fixedVersions": [], "id": "54109", "issueType": "Bug", "key": "DOCUMENT-1269", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:fe90cc1f-7037-43dd-b189-cc0a891922b8", "resolution": "Duplicate", "resolutionDate": "2022-08-10T15:26:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Incorrect example in capitalize() function documentation", "timeSpent": "PT0S", "updated": "2022-08-10T15:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-10-29T09:21:00.000000", "creator": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e7944ea" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o063g7:17" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_349092751_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1435045837" } ], "description": "In [https://puppet.com/docs/pe/2021.3/puppetfile.html#declare_puppet_forge_modules_in_the_puppetfile]\u00a0the wording for using no options is confusing.\u00a0\u00a0Specifically\u00a0{{_If you specify no options, code management installs the latest version and keeps the module at that version_.}}\u00a0 To me that doesn't clearly state what it does on subsequent code deploys.\u00a0 After reading it a few times, I get the idea, but wonder if wording like\u00a0_{{If you specify no options, code management installs the current version the first time it runs after the line is added, but does not update the module to newer versions on subsequent runs.}}_\u00a0would be clearer?\u00a0\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54843", "fixedVersions": [], "id": "54843", "issueType": "Improvement", "key": "DOCUMENT-1268", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "resolution": "Fixed", "resolutionDate": "2021-11-18T23:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Unclear wording in \"Declaring Forge Modules in a Puppetfile\"", "timeSpent": "PT0S", "updated": "2021-11-18T23:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2021-10-26T11:46:00.000000", "creator": "6220dbd415521d00726b0564", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@c202e3b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0c3g8:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "46259" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_174576923_*|*_3_*:*_1_*:*_342949_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_526057803_*|*_10005_*:*_1_*:*_13291" } ], "description": "*Problem:*\u00a0The purpose of api_user is not clearly viewable by end users of PE. The api_user seems to be referenced in the delete users endpoint docs [https://puppet.com/docs/pe/2021.3/rbac_api_v1_user.html#delete_users_lt_sid_gt]\u00a0and RBAC service errors [https://puppet.com/docs/pe/2021.3/rbac_api_service_errors.html]\u00a0pages but doesn't have a definition of the api_user's purpose.\u00a0\n\n\u00a0\n\n*Suggested improvement:*\nInclude text about the admin and api_user users' purposes as well as why they cannot be deleted. Possible locations for this updated information can be Creating and Managing Users and User Roles page ([https://puppet.com/docs/pe/2021.3/rbac_user_roles_intro.html#creating_and_managing_users_and_user_roles)|https://puppet.com/docs/pe/2021.3/rbac_user_roles_intro.html#creating_and_managing_users_and_user_roles]\u00a0and the delete users API docs\u00a0https://puppet.com/docs/pe/2021.3/rbac_api_v1_user.html#delete_users_lt_sid_gt\n\nSuggested text for api_user definition\n*The API user is used for service-to-service authentication within PE.\u00a0 It cannot be used with the standard login and is only available via certificate based authentication.\u00a0 RBAC has an \u201callow list\u201d that identifies (via certname) which certificates can be used for API user authentication.*\n\n\u00a0\n\n\u00a0Thank you!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54841", "fixedVersions": [], "id": "54841", "issueType": "Improvement", "key": "DOCUMENT-1267", "labels": [ "001G000001p3dQmIAI", "jira_escalated", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbd415521d00726b0564", "resolution": "Fixed", "resolutionDate": "2021-11-03T14:29:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "api_user definition not included in Puppet docs", "timeSpent": "PT0S", "updated": "2021-11-03T14:30:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-10-26T11:30:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2ad3539c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0c3ew:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_600687621_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_528902664" } ], "description": "I've a few customers that enabled multithread support in Puppetserver 6/7 and run into some issues. According to a few messages on slack it's still experimental. I think it would be helpful if the docs would mention that:\n* https://puppet.com/docs/pe/2021.3/config_puppetserver.html#config_multithread_setting_puppetserver\n* https://puppet.com/docs/puppet/7/server/config_file_puppetserver.html#settings\n* https://puppet.com/docs/puppet/7/experiments_overview.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55117", "fixedVersions": [], "id": "55117", "issueType": "New Feature", "key": "DOCUMENT-1266", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2021-11-08T12:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "mark Puppetserver multithread support as experimental", "timeSpent": "PT0S", "updated": "2021-11-08T12:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [ { "attacher": "609a8eb65998a60068d12a0a", "created": "2022-01-04T08:01:00.000000", "name": "Screenshot 2022-01-04 at 15.00.04.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14193" }, { "attacher": "609a8eb65998a60068d12a0a", "created": "2022-01-04T08:01:00.000000", "name": "Screenshot 2022-01-04 at 15.00.33.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14206" } ], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Just to verify, you were unable to retrieve the listed statuses from the endpoint?\n\n[~accountid:557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8], forgive me if you aren't the right person, but can you verify this list or point me to someone who can?", "created": "2021-10-22T16:45:00.000000" }, { "author": "557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8", "body": "If you want the status of the puppetserver, the status request would need to be made against port `8140` as listed in the chart on the page. Each service has its own status service. The services covered are listed in the chart next to the ports.", "created": "2021-10-22T16:55:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It sounds like the information on the page is correct, and this section says you must list the port in the request, so I'm closing this as won't fix. [~accountid:609a8eb65998a60068d12a0a], if you run into further trouble, please do let us know!", "created": "2021-10-26T09:54:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] i got muddled before but what I am seeing is this, the puppet-server endpoint doesn't work but if you put it as server instead you get the expected result\n\n !Screenshot 2022-01-04 at 15.00.04.png|thumbnail! !Screenshot 2022-01-04 at 15.00.33.png|thumbnail! ", "created": "2022-01-04T08:01:00.000000" }, { "author": "60e4906e4134aa006931a5d6", "body": "[~accountid:557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8] It looks like this endpoint still isn't working even with port specified. Is this as simple as needing to change \"puppet-server\" to \"server\" in documentation, or is something else going on here? Thank you- lmk if someone else would be better to ask", "created": "2022-01-10T11:19:00.000000" }, { "author": "557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8", "body": "Hi [~accountid:60e4906e4134aa006931a5d6] it is a little confusing. The request is made to puppetserver, but the service within the status service is known as \"server\". This works on my local test machine:\n\n{code}\ncurl --insecure --header \"Content-Type: application/json\" --request GET https://localhost:8140/status/v1/services/server\n{code}\n\nReturns:\n{code}\n{\"service_version\":\"7.5.0-20211202_144559-g81eb178\",\"service_status_version\":1,\"detail_level\":\"info\",\"state\":\"running\",\"status\":{},\"active_alerts\":[],\"service_name\":\"server\"}\n{code}\n\nDoes that help?", "created": "2022-01-10T11:36:00.000000" }, { "author": "557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8", "body": "Also, you can omit the \"server-type\" suffix, and it will list all the services it knows about.", "created": "2022-01-10T11:37:00.000000" }, { "author": "609a8eb65998a60068d12a0a", "body": "Sorry to reopen but the documentation is still listed with puppet-server\n\n[https://puppet.com/docs/pe/2019.8/status_api_json_endpoints.html#get_status_v1_services_lt_service_name_gt-query_parameters]\n\n[https://puppet.com/docs/pe/2021.4/status_api_json_endpoints.html#get_status_v1_services_lt_service_name_gt-query_parameters]\n\nRequest format\nThis endpoint fetches the status for any one of the following services:\nactivity-service (4433)\nclassifier-service (4433)\ncode-manager-service (8140)\norchestrator-service (8143)\npuppet-server (8140)\npuppetdb-service (8081)\n\nand as discussed above it should be\nactivity-service (4433)\nclassifier-service (4433)\ncode-manager-service (8140)\norchestrator-service (8143)\n*server (8140)*\npuppetdb-service (8081)", "created": "2022-01-21T07:05:00.000000" }, { "author": "60e4906e4134aa006931a5d6", "body": "Was changed only in upcoming versions. Applied change to current versions.", "created": "2022-01-28T10:22:00.000000" } ], "components": [], "created": "2021-10-21T05:41:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2406aa5e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0byso:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_3_*:*_413622403_*|*_3_*:*_1_*:*_81972635_*|*_6_*:*_3_*:*_6897893266_*|*_10004_*:*_1_*:*_320889954_*|*_10006_*:*_1_*:*_522510070_*|*_10005_*:*_1_*:*_337144164" } ], "description": "*Problem:*\n\n\u00a0As far as I can see the list of services you could put in here is wrong\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2019.8/status_api_json_endpoints.html#get_status_v1_services_lt_service_name_gt\n\n_Current text :_\n\nThis endpoint fetches the status for any one of the following services:\nactivity-service (4433)\nclassifier-service (4433)\ncode-manager-service (8140)\norchestrator-service (8143)\npuppet-server (8140)\npuppetdb-service (8081)\n\n_Suggested improvement:_\n\nI would appear to me from the output of status the list of services is actually from this\n\n{\n \"activity-service\": {\n \"active_alerts\": [],\n \"detail_level\": \"info\",\n \"service_status_version\": 1,\n \"service_version\": \"2019.8.5.1\",\n \"state\": \"running\",\n \"status\": {\n \"db_pool\": {\n \"state\": \"ready\"\n },\n \"db_up\": true,\n \"replication\": {\n \"mode\": \"source\",\n \"status\": \"active\"\n }\n }\n },\n \"classifier-service\": {\n \"active_alerts\": [],\n \"detail_level\": \"info\",\n \"service_status_version\": 1,\n \"service_version\": \"2019.8.5.2\",\n \"state\": \"running\",\n \"status\": {\n \"activity_up\": true,\n \"db_pool\": {\n \"state\": \"ready\"\n },\n \"db_up\": true,\n \"rbac_up\": true,\n \"replication\": {\n \"mode\": \"source\",\n \"status\": \"active\"\n }\n }\n },\n \"pe-console\": {\n \"active_alerts\": [],\n \"detail_level\": \"info\",\n \"service_status_version\": 1,\n \"service_version\": \"2019.8.5.8\",\n \"state\": \"running\",\n \"status\": {}\n },\n \"rbac-service\": {\n \"active_alerts\": [],\n \"detail_level\": \"info\",\n \"service_status_version\": 1,\n \"service_version\": \"2019.8.5.1\",\n \"state\": \"running\",\n \"status\": {\n \"activity_up\": true,\n \"db_pool\": {\n \"state\": \"ready\"\n },\n \"db_up\": true,\n \"replication\": {\n \"mode\": \"source\",\n \"status\": \"active\"\n }\n }\n },\n \"status-service\": {\n \"active_alerts\": [],\n \"detail_level\": \"info\",\n \"service_status_version\": 1,\n \"service_version\": \"1.1.1\",\n \"state\": \"running\",\n \"status\": {}\n }\n\n\n\n*Summary:*\n\n\u00a0List of services available via api seems wrong, or if im wrong can you tell me how I would call puppet-server and maybe docs need to be clearer on it", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54839", "fixedVersions": [], "id": "54839", "issueType": "Task", "key": "DOCUMENT-1265", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2022-01-28T10:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] api status documentation service list wrong?", "timeSpent": "PT0S", "updated": "2022-01-28T10:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:616989d3048360006aeb55e8], verify this with the installer team and we can make this change.", "created": "2021-10-26T10:10:00.000000" }, { "author": "616989d3048360006aeb55e8", "body": "[~accountid:636beee59cde59261829fe22]\u00a0does this also apply to LTS?", "created": "2021-10-28T12:15:00.000000" } ], "components": [], "created": "2021-10-20T10:26:00.000000", "creator": "636beee59cde59261829fe22", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7225d737" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0byb4:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_517400016_*|*_3_*:*_1_*:*_177164247_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_586498969_*|*_10005_*:*_1_*:*_2072185" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2021.3/supported_operating_systems.html\n\n\u00a0\n\n_Suggested improvement:_\n\nIn the \"RHEL dependencies\" table, *recommend we add the package `initscripts`* for the primary server.\n\n*Summary:*\n\nA prospect is attempting to install PE on RHEL 8.4 and ran into an error that nothing provided this package.\u00a0 They may have used a minimal RHEL installation, but we should explicitly call this out to avoid confusion in the future.\u00a0 The pe-postgresql11-2021.3.11.13-1.pe.el8.x86_64 package relies upon the initscripts package.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54837", "fixedVersions": [], "id": "54837", "issueType": "Improvement", "key": "DOCUMENT-1264", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "636beee59cde59261829fe22", "resolution": "Fixed", "resolutionDate": "2021-11-04T06:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add `initscripts` to requirements for the primary server", "timeSpent": "PT0S", "updated": "2021-11-04T06:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2021-10-18T14:44:00.000000", "creator": "6220dbd449c90000701fd0c5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@317832b3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bw80:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_673836690_*|*_3_*:*_1_*:*_1027328_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1467314635" } ], "description": "While working through a client issue, it was pointed out that in both code blocks of section 2d of [Upgrade Unmanaged Postgres|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade-unmanaged-postgres]\u00a0has a seemingly incorrect/extra line. 4th from the bottom, it simply states\u00a0\n{code:java}\nTABLES TO \"pe-inventory-read\";\n{code}\n\nThis line probably needs remedied or removed", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54956", "fixedVersions": [], "id": "54956", "issueType": "Task", "key": "DOCUMENT-1263", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbd449c90000701fd0c5", "resolution": "Fixed", "resolutionDate": "2021-11-12T08:47:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Confirm \"Upgrade Unmanaged Postgres\" code accuracy", "timeSpent": "PT0S", "updated": "2021-11-12T08:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [], "components": [], "created": "2021-10-15T05:31:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@9e24c10" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bu94:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14288294_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_282872541" } ], "description": "*Problem:*\n\n\u00a0Broken link to puppetdb from puppet server page\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/7/server/\n\n_Dropdown on left has_\n\n_PuppetDB with link of\u00a0https://puppet.com/docs/puppet/7/server/puppetdb_overview.html_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement._\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\nPuppetDB with link of *https://puppet.com/docs/puppetdb/7/overview.html*\n\n*Summary:*\n\n\u00a0Change puppetdb link", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54324", "fixedVersions": [], "id": "54324", "issueType": "Task", "key": "DOCUMENT-1262", "labels": [ "server" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Done", "resolutionDate": "2021-10-18T16:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] broken link to puppetdb from puppet server page", "timeSpent": "PT0S", "updated": "2021-10-18T16:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This is now fixed. Thanks for letting us know!", "created": "2021-10-18T05:05:00.000000" } ], "components": [], "created": "2021-10-15T04:28:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5621847" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bu88:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_257644687_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3802442" } ], "description": "Hi,\nI was scrolling through https://puppet.com/docs/puppet/6/server/release_notes.html#puppet-server-6170 . The enhancements section contain this bullet point:\n{code}\nScripts as a default mount Puppet Server 6+ now has a new default mount named 'scripts'. You can use the new default mount with API endpoints such as {{file_content}}, {{file_metadata}}, and {{static_file_content}} to load scripts from the {{scripts/}} directory of a module. SERVER-3058\n{code}\n\nI think the curly braces aren't there on purpose/ it's not correctly rendered as monospace font?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54954", "fixedVersions": [], "id": "54954", "issueType": "Bug", "key": "DOCUMENT-1261", "labels": [ "puppet", "server" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2021-10-18T05:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppetserver 6.17 release notes broken", "timeSpent": "PT0S", "updated": "2021-10-18T05:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623c0d77a1d81f0069d8df12", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:623c0d77a1d81f0069d8df12]! Is it okay for us to close this ticket?", "created": "2021-10-22T15:47:00.000000" }, { "author": "623e7820761efb0069cf477c", "body": "This is fine, I wanted to see if Puppet customers receive an email response\nwith submitting an issue through the document form. I did not receive an\nemail. So that might need to be changed so people don't go into a black\nhole per se.\n\nOn Fri, Oct 22, 2021 at 5:48 PM Jean Bond (Jira) <\nissue-updates+JeanBond@puppet.com> wrote:\n\n> There is *1 comment*.\n> * You've been mentioned in a comment. *\n>\n>\n> Documentation /\n> DOCUMENT-1260 Open\n> jmccarthy - test\n>\n> View issue \u00b7 Add\n> comment \n>\n> 1 comment\n>\n> *Jean Bond* on 2021/10/22 2:47 PM\n>\n>\n> Hi Jenna McCarthy\n> !\n> Is it okay for us to close this ticket?\n>\n>\n> This message was sent by Atlassian Jira (v8.13.2#813002-sha1:c495a97) [image:\n> Atlassian logo]\n> Jira is improving email notifications, share your feedback\n> !\n> Get Jira notifications on your phone! Download the Jira Server app for\n> Android\n> \n> or iOS .\n>", "created": "2021-10-22T16:30:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I understand. Hopefully my responses help you verify that they *do* receive an email when anything happens to the ticket. :)", "created": "2021-10-22T16:35:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It also shows up on our triage board, which is why I asked about closing it. Hope this was helpful!", "created": "2021-10-22T16:36:00.000000" } ], "components": [], "created": "2021-10-14T15:27:00.000000", "creator": "623c0d77a1d81f0069d8df12", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@30ecc528" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bu2o:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_695277151_*|*_6_*:*_1_*:*_0" } ], "description": "test", "environment": "test", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54245", "fixedVersions": [], "id": "54245", "issueType": "Bug", "key": "DOCUMENT-1260", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0d77a1d81f0069d8df12", "resolution": "Won't Fix", "resolutionDate": "2021-10-22T16:35:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "jmccarthy - test", "timeSpent": "PT0S", "updated": "2021-10-22T16:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [], "components": [], "created": "2021-09-24T04:58:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4b2e39a7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bfj7:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "45920" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_284205286_*|*_3_*:*_1_*:*_216842_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_6216695626" } ], "description": "https://puppet.com/docs/pe/2019.8/groups_endpoint_examples.html#pin_a_second_node_to_the_my_nodes_group\n\nIt notes when pinning a second node, that you have to provide a list of all nodes to pin. \n\nThis is misleading and not the case, there is no need to re-pin a node. Specifying just the new nodes is sufficient. The docs will need updated to reflect this\n\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54704", "fixedVersions": [], "id": "54704", "issueType": "Improvement", "key": "DOCUMENT-1258", "labels": [ "jira_escalated", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2021-12-08T09:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Node classifier api docs are misleading on pinning a second node", "timeSpent": "PT0S", "updated": "2021-12-08T09:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [ { "attacher": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "created": "2021-09-23T06:37:00.000000", "name": "2021-09-23-143717_1854x1039_scrot.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14251" } ], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68]\u00a0Hello Tim. The page you linked ([https://puppet.com/docs/pe/2019.8/plans_limitations.html]) describes the limitations of _run_as in PE. Could you let me know if there is something specific you feel we should add to it?", "created": "2021-11-15T10:30:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "ah odd, I think I missed that somehow. I think we can close the ticket.", "created": "2021-11-15T12:35:00.000000" } ], "components": [], "created": "2021-09-23T06:37:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2ae693a0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0be0z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_364691349_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_448825576_*|*_10006_*:*_1_*:*_3790755366" } ], "description": "Hi,\nI was looking through https://puppet.com/docs/pe/2019.8/plans_limitations.html and https://puppet.com/docs/bolt/latest/applying_manifest_blocks.html#applying-manifest-blocks-from-a-puppet-plan\nIn Bolt Plans we can do:\n{code}\napply($targets, _catch_errors => true, _noop => true, _run_as => root) {\n include 'docker'\n}\n{code}\n\nHowever on PE Plans, the _run_as option isn't available\n\n !2021-09-23-143717_1854x1039_scrot.png|thumbnail! ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55116", "fixedVersions": [], "id": "55116", "issueType": "Bug", "key": "DOCUMENT-1257", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Cannot Reproduce", "resolutionDate": "2021-11-15T12:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "missing constraint for PE 2019 plans", "timeSpent": "PT0S", "updated": "2021-11-15T12:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] thank you for the great example! We're always looking for useful examples to add to the docs. I've added this to the group example page, and included links to that topic from the respective task and plan run topics.\n\n[https://puppet.com/docs/pe/2021.5/groups_endpoint_examples.html#get_group_ids_for_all_node_groups]\u00a0\n\n[https://puppet.com/docs/pe/2021.5/running_tasks_from_the_command_line.html#run-task-node-group]\u00a0", "created": "2022-02-25T10:10:00.000000" } ], "components": [], "created": "2021-09-17T07:14:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@21bceb2b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0e9oh:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_355735071_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_13568822804" } ], "description": "Hi,\n`puppet task run` and `puppet plan run` can take a node group. But it requires the ID of the group, not the actual human readable name. So I hacked something together to get a list of all groups + their ids:\n\n{code}\nauth_header=\"X-Authentication: $(puppet-access show)\"\nuri=\"https://$(puppet config print server):4433/classifier-api/v1/groups\"\ncurl --silent --header \"$auth_header\" \"$uri\" | jq -M -r '.[] | \"\\(.name) \\(.id)\"'\n{code}\n\nThe output is:\n{code}\nAll Nodes 00000000-0000-4000-8000-000000000000\nPE Master 07002034-c20f-44de-97d2-91d28da96e18\nDevelopment one-time run exception 124a11d8-b912-45f0-9a6d-5ddd81aaa0ed\nPE PuppetDB 289f176b-1c30-4e85-ad07-d886774d1c49\nPE Database 28b78e75-3b7e-464e-8f02-29a80b88fe02\nDevelopment environment 388f2eea-2f91-4ed7-8f84-807d0232576c\nPE Orchestrator 3f490039-395f-4c87-8dfb-f72d03e481fb\nProduction environment 43d438de-78da-4186-9405-6aa6a2489c71\nAll Environments 6a10e0eb-ab6b-4ba7-b637-131e55f29354\nPE Compiler 9cab6f77-f0cf-4c0e-b2ce-b8b7f49aec9b\nPE Infrastructure 9cd74d7e-6fb7-4d17-9cd8-e3f743989a5c\nPE Patch Management aae9e4cd-fed5-4f07-8149-98a699a3b692\nPE Certificate Authority d4065370-0cab-43cf-a4fa-93d8bf115ec5\nPE Agent d4cf6659-6fc8-4419-b2a2-28fdf91ed659\nPE Console de97e269-4a9e-4f3d-a931-86085af9aa3b\nPE Infrastructure Agent e46543a6-61c6-49f2-865f-39993b0ef3f6\n{code}\nI was scrolling through https://puppet.com/docs/pe/2019.8/groups_endpoint_examples.html to get some examples for the API. maybe the snippets could be added there. And maybe that can be added as related information on https://puppet.com/docs/pe/2019.8/running_tasks_from_the_command_line.html#run-task-node-group \n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54703", "fixedVersions": [], "id": "54703", "issueType": "New Feature", "key": "DOCUMENT-1256", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Done", "resolutionDate": "2022-02-25T10:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Enhancement suggestion for PE classifier API docs", "timeSpent": "PT0S", "updated": "2022-02-25T10:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [ { "attacher": "6220dbdaa12450006887cfd3", "created": "2021-09-14T17:57:00.000000", "name": "Screen Shot 2021-09-14 at 4.57.18 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14220" }, { "attacher": "6220dbdaa12450006887cfd3", "created": "2021-09-14T17:59:00.000000", "name": "Screen Shot 2021-09-14 at 4.59.14 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14205" } ], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Hi [~accountid:6220dbdaa12450006887cfd3]!\u00a0The complete resource example now lives here: [https://puppet.com/docs/puppet/7/resource-example.html|https://puppet.com/docs/puppet/7/resource-example.html.]. And I have removed that broken link in the navigation. Thanks for letting us know!", "created": "2021-10-05T05:46:00.000000" } ], "components": [], "created": "2021-09-14T18:00:00.000000", "creator": "6220dbdaa12450006887cfd3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@183e0a19" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0b6tf:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_576469337_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_366300_*|*_10016_*:*_1_*:*_1193561652" } ], "description": "While looking through the Puppet language docs at [https://puppet.com/docs/puppet/7], I noticed that the \"Complete Resource Example\" link in the nav sidebar is broken. The page loads but it just displays a \"Oops, something's broken\" message. The link can be found in the nav sidebar hierarchy under Developing Puppet Code -> The Puppet Language -> Complete Resource Example.\n\nThe broken link:\u00a0[https://puppet.com/docs/puppet/7/complete_resource_example.html]\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54814", "fixedVersions": [], "id": "54814", "issueType": "Bug", "key": "DOCUMENT-1252", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbdaa12450006887cfd3", "resolution": "Fixed", "resolutionDate": "2021-10-05T05:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] \"Complete Resource Example\" link broken", "timeSpent": "PT0S", "updated": "2021-10-05T05:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "6220dbdaa12450006887cfd3", "created": "2021-09-14T17:35:00.000000", "name": "Kapture 2021-09-14 at 15.31.16.gif", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14277" } ], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Hi [~accountid:6220dbdaa12450006887cfd3], thanks for pointing this out. It looks like there's an issue somewhere in our docs build. I'll have a look and get it sorted out!", "created": "2021-09-15T09:38:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "This should be fixed now. Those links are actually supposed to be expanding sections! Thanks for bringing this to our attention [~accountid:6220dbdaa12450006887cfd3]", "created": "2021-09-15T16:01:00.000000" }, { "author": "6220dbdaa12450006887cfd3", "body": "No problem [~accountid:5b0340d43eafdb09dee5bc3a]! Fix looks great. Glad to help any way I can (y).", "created": "2021-09-16T19:56:00.000000" } ], "components": [], "created": "2021-09-14T17:37:00.000000", "creator": "6220dbdaa12450006887cfd3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@fad5ba1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0b6s3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Sep/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_74234291_*|*_3_*:*_1_*:*_6433465_*|*_5_*:*_1_*:*_0" } ], "description": "While I was browsing the docs at [https://puppet.com/docs/puppet/7]\u00a0today I noticed that some titles in the navigation sidebar are not links although they appear clickable. I believe this is a bug because it results in a very confusing UX. It seems that some of these psuedo-links are headers within other pages and maybe should not be placed in the navigation sidebar at all although I'm not sure.\n\nI attached a GIF illustrating the issue.", "environment": "Chrome\u00a086.0.4240.183\n\nMacOS Big Sur\u00a011.5.2", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54243", "fixedVersions": [], "id": "54243", "issueType": "Bug", "key": "DOCUMENT-1251", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220dbdaa12450006887cfd3", "resolution": "Fixed", "resolutionDate": "2021-09-15T16:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Some navigation \"links\" do not work in nav sidebar", "timeSpent": "PT0S", "updated": "2021-09-16T19:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "623c100c4a57610068e74585", "body": "Thanks for the update. It generally looks better (big +1 including all changes since report version 8 in both 6 & 7 guides).\n\n\u00a0\n\nSome notes:\n\n[https://docs-herrera-preview.netlify.app/docs/puppet/7/format_report.html] has:\n\n{quote}\n\nPuppet versions 7 and later generate report format 12. This format is backward compatible with report formats 9-11.\n\n{quote}\n\n\u00a0\n\nI'm not sure you want \"and later\" in there. There's no guarantee that Puppet 8 won't introduce a new format.\n\n\u00a0\n\nI'm not a native speaker, but isn't it \"backwards compatible\"? And on that note: it removes a field so technically speaking it's not 100% compatible. I'd say something like \"it's mostly backwards compatible with 9-11, see CHANGES for details\". Does that make sense?\n\n\u00a0\n\nIn the {{Puppet::Transaction::Report}} table there's a row \"{{report_format}}\" and the value is 10. That should be 12. This is also true for the Puppet 6 document except that it should be 11 there.", "created": "2021-10-13T09:51:00.000000" }, { "author": "557058:d1729ddb-cd82-4029-b682-bf43efb49787", "body": "on [https://docs-herrera-preview.netlify.app/docs/puppet/7/format_report.html#format_report-format-9-differences] there is a 9 at the end of {{Puppet::Transaction::Report9 }}that most likly shouldn't be there as on the puppet 6 version it isn't there.", "created": "2021-10-13T10:00:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for your input! I've made these changes. Let me know what you think.", "created": "2021-10-14T07:51:00.000000" }, { "author": "623c100c4a57610068e74585", "body": "The Puppet 7 version looks good. There appears to a be a difference between 6 & 7 in the Changes overview. In 7 certain words are formatted as code while in 6 it's only done for version 10. I think Puppet 7 version is the correct one and I'd expect the same formatting in Puppet 6.", "created": "2021-10-14T08:54:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This is fixed now. Thanks!", "created": "2021-10-15T09:57:00.000000" } ], "components": [], "created": "2021-09-14T09:15:00.000000", "creator": "557058:d1729ddb-cd82-4029-b682-bf43efb49787", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5af9425" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0b6i3:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Oct/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_608032989_*|*_10009_*:*_1_*:*_180287327_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_9840485_*|*_10005_*:*_2_*:*_689270416_*|*_10016_*:*_1_*:*_1193475869" } ], "description": "*Problem:*\n\n\u00a0The documentation seems quiet outdated. E.g. it mentions that Puppet 7 generates format version 12 but there is only a navigation point for \"Differences from version 9\".\n\n\u00a0\n\nPossible it makes also sense to cross link to the json schema file: [https://github.com/puppetlabs/puppet/blob/7.10.0/api/schemas/report.json]\n\n\u00a0\n\nFor context from the vox pupli irc chat:\n{noformat}\n hmm, is there a complete historic view for all report formats?\n I'm looking at https://puppet.com/docs/puppet/7/format_report.html and wonder where \"restarted\" went\n @ewoud i like that it says \"string or integer\" :D\n TuningYourCode: also interesting that it first states \"Puppet versions 7 and later generate report format 12\" but the report_format column says '\"10\" or 10'\n https://puppet.com/docs/puppet/6/format_report.html describes Puppet 5\n I'm guessing that it also reports version 11 but that's just speculation\n well to not only hate/bitch at puppet i have to admit that their documentation is above the average of documentation of open source products\n oh I'm certainly happy that the report format itself is documented in such a way\n and if there was a git repo I could submit these fixes to I'd be happy\n well, i just opened some months ago a ticket in their jira for the documentation that some anchor links were broken - took some days but they at least fixed it :)\n and I miss the diff where master_used changed to server_used - looks like that's Puppet 6 or report format 11\n the reason I wonder about the historic changes is that in some old code (Foreman's report processor) I see \"restarted\" but not on puppet.com\n but it is in the schema: https://github.com/puppetlabs/puppet/blob/d135387bb7cf20cc71670c791f76d66352e64c40/api/schemas/report.json#L313\n psssst, it's a hidden feature you are not supposed to talk about :P\n probably would be nice to link from the documentation to that schema?\n possibly{noformat}\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/format_report.html]\n\n_Current text :_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54701", "fixedVersions": [], "id": "54701", "issueType": "Improvement", "key": "DOCUMENT-1250", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d1729ddb-cd82-4029-b682-bf43efb49787", "resolution": "Fixed", "resolutionDate": "2021-10-15T09:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Report format documentation outdated?", "timeSpent": "PT0S", "updated": "2021-10-15T09:57:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Hi [~accountid:60d9d228a3de4a006b68b978]! The types section of the docs is generally generated from the Puppet code, but this page, in particular, mostly comes from a preamble doc that is shared between the 2 versions (https://github.com/puppetlabs/puppet-docs/blob/master/lib/puppet_references/puppet/type_preamble.md). The only bit that would differ is the list of resource types if a change had been made between Puppet 6 and 7. Are you aware of a change in this list that is not being represented?", "created": "2021-09-20T12:35:00.000000" }, { "author": "60d9d228a3de4a006b68b978", "body": "A lot of types have been removed between 6 and 7.", "created": "2021-09-21T05:13:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "The big type removal happened with the update from Puppet 5.5 (now EOL) to Puppet 6. You can read about those here: https://puppet.com/docs/puppet/6/release_notes_puppet.html#new_features_puppet_x-0-0-select-moved-modules-types. There are minor changes in the types themselves, but those differences wouldn't appear on this page. A good place to look for these differences would be between https://puppet.com/docs/puppet/6/type.html and https://puppet.com/docs/puppet/7/type.html.", "created": "2021-09-21T10:39:00.000000" }, { "author": "5e870aab467ac20c1d94c86d", "body": "I've had a look on PE and on the agent and the additional types are there but it does look like they're not part of the main Puppet gem.\n\n_[root@2424nix0 vendor_modules]# pwd_\n_/opt/puppetlabs/puppet/vendor_modules_\n_[root@2424nix0 vendor_modules]# ls_\n_augeas_core cron_core host_core mount_core scheduled_task selinux_core sshkeys_core yumrepo_core zfs_core zone_core_\n\nAnd on the agents they do appear different between Linux and Windows. So maybe the problem is, where would a PE user (as opposed to on OSP user) go to get a full list of types that were bundled in with a standard install.\n\n\u00a0", "created": "2021-09-24T02:01:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "Hi [~accountid:5e870aab467ac20c1d94c86d], please open a new ticket and explain the use case so a PE writer can take a look.", "created": "2021-09-24T09:20:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:5e870aab467ac20c1d94c86d] The type reference should be accurate for, and note any differences in, both PE and Puppet. It's normal for PE users to use Puppet documentation for shared information. If you do open a new ticket, could you please call out what differences that you are looking for and not finding? The more detail we have about what it is you're looking for, the better. Thank you!", "created": "2021-09-24T09:58:00.000000" } ], "components": [ "Puppet Language" ], "created": "2021-09-10T04:19:00.000000", "creator": "60d9d228a3de4a006b68b978", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@713b39d7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0b3sr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Sep/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_274870949_*|*_3_*:*_1_*:*_78077288_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3179176_*|*_10005_*:*_1_*:*_617065825" } ], "description": "*Problem:*\n\n[https://puppet.com/docs/puppet/6/types]\n\nand\n\n[https://puppet.com/docs/puppet/7/types]\n\nshow the exact same documentation.\n\nI haven't dug deeper to figure out how much else has been overwritten.\n\n*Suggested improvement:*\n\nI don't know how that happened, but the correct documentation needs to be restored.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55115", "fixedVersions": [], "id": "55115", "issueType": "Bug", "key": "DOCUMENT-1248", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "60d9d228a3de4a006b68b978", "resolution": "Declined", "resolutionDate": "2021-09-21T10:39:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Types List for Puppet 6.x shows the same as 7.x", "timeSpent": "PT0S", "updated": "2021-09-24T09:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks for the ticket, [~accountid:623c0f891c7f6a007049e734]. Puppet 5.5 and Puppet Server 5.3 were end-of-life as of January 2021, so it was out of scope for the cleanup effort. I expect that's also why the links are broken", "created": "2021-09-20T16:26:00.000000" } ], "components": [ "Puppet Server" ], "created": "2021-09-08T19:37:00.000000", "creator": "623c0f891c7f6a007049e734", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@166c7163" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0b2qb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Sep/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1025351196_*|*_6_*:*_1_*:*_0" } ], "description": "[https://puppet.com/docs/puppetserver/5.3/scaling_puppet_server.html]\u00a0has links to the PE documents. However, all five of those links are broken - eg, the \"Compile masters\" link should go to\u00a0installing_compilers.html instead of installing_compile_masters.html.\n\nAlso - it looks like a few documents were missed in cleaning up the language; this is just one such example. (Should be \"Compile servers\" or \"compilation servers\", not \"compile masters\".)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54903", "fixedVersions": [], "id": "54903", "issueType": "Bug", "key": "DOCUMENT-1247", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0f891c7f6a007049e734", "resolution": "Won't Fix", "resolutionDate": "2021-09-20T16:26:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken links on Open Source Puppet documentation", "timeSpent": "PT0S", "updated": "2021-09-20T16:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:623c177cd32a94006a649c1d], thanks for the ticket. That's a great observation", "created": "2021-08-31T10:04:00.000000" }, { "author": "623c177cd32a94006a649c1d", "body": "That's hard to say, from looking through the docs there aren't many articles written about Pupperware at puppet.com, most of the info is just posted on the git repo here : [https://github.com/puppetlabs/pupperware]\n\nMaybe a section could be added to the main installation page [https://puppet.com/docs/puppet/7/install_puppet.html#install_puppet,]\u00a0that lists the alternative installation method of using pupperware. In that section (or in a page linked from that section), the checksums could be published. Would also need some mechanism to update these checksums when new containers are published, so whatever procedure used when publishing a new container would also need a note to update the documentation as well.", "created": "2021-08-31T16:50:00.000000" } ], "components": [], "created": "2021-08-29T10:40:00.000000", "creator": "623c177cd32a94006a649c1d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@61a1c3ac" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0av2b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/Aug/21" } ], "description": "*Problem:*\n\nChecksums for docker containers published at [https://hub.docker.com/u/puppet]\u00a0seem to only be published at docker.com. A bad actor that had control over docker.com or the Puppet account at hub.docker.com could publish a new malicious container and likewise update the checksum there. \u00a0\n\n*Suggested improvement:*\n\n\u00a0\n\nPublishing the checksum at a different location under puppet.com would improve the ability to verify these containers were free from manipulation, since now a bad actor would have to compromise vulnerabilities of both docker.com and puppet.com", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54952", "fixedVersions": [], "id": "54952", "issueType": "New Feature", "key": "DOCUMENT-1245", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c177cd32a94006a649c1d", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "List dockerhub checksums on puppet.com", "timeSpent": "PT0S", "updated": "2023-05-18T07:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-08-24T00:22:00.000000", "creator": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Documentation of no_proxy setting is more specific about the expected format." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7dc34e75" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bz8w:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_110651023_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_8445575771" } ], "description": "*Problem:* The documentation for the \"no_proxy\" setting is quite vague when it comes to the format the values should be provided in. I was not sure what \"list\" means here. Something like \"...string of comma separated values...\" would be more clear. I needed to lookup the code to be 100% certain.\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/6/configuration.html#no-proxy|https://puppet.com/docs/puppet/6/configuration.html#no-proxy]\n\n_Current text:_\n\nList of host or domain names that should not go through http_proxy_host. Environment variable...\n\n_Suggested improvement:_\n\n*String containing a comma separated l*ist of host or domain names that should not go through http_proxy_host. Environment variable...\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54835", "fixedVersions": [], "id": "54835", "issueType": "Improvement", "key": "DOCUMENT-1244", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "resolution": "Fixed", "resolutionDate": "2021-12-01T00:05:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Configuration Reference: Format for no_proxy should be made more clear", "timeSpent": "PT0S", "updated": "2021-12-01T00:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-08-22T04:01:00.000000", "creator": "609a8eb65998a60068d12a0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1856723f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bz92:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_270347223_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_8923593857" } ], "description": "*Problem:*\n\n\u00a0The verify packages contains a suggestion of using http to a site which has now shutdown see [https://puppet.slack.com/archives/CF72NNBGD/p1629474070220700]\u00a0for discussion with installer team to confirm [~accountid:557058:31c596d1-7e27-4c91-bc18-1254edb3caab]\u00a0confrimed and\u00a0[https://sks-keyservers.net/] \"Update 2021-06-21: Due to even more GDPR takedown requests, the DNS records for the pool will no longer be provided at all.\"\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/7/verify_packages.html]\n\n_Current text :_\n The key is also available via HTTP using\u00a0pool.sks-keyservers.net:11371/pks/lookup?op=get&search=0x4528B6CD9E61EF26\n _Suggested improvement:_\n\nRemove line\n\n*Summary:*\n\n\u00a0Remove no longer available key server from doc there may be other docs that refer to this if we have an easy way to search.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54700", "fixedVersions": [], "id": "54700", "issueType": "Improvement", "key": "DOCUMENT-1243", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "609a8eb65998a60068d12a0a", "resolution": "Fixed", "resolutionDate": "2021-12-06T12:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Verify packages has redundant link for pgp cert", "timeSpent": "PT0S", "updated": "2021-12-06T12:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [ { "author": "5b9fcedc03b52466f05c4510", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] for every custom_fact that is created or retrieved, the name is transformed to string: https://github.com/puppetlabs/facter/blob/main/lib/facter/custom_facts/util/collection.rb#L157-L174. It does not matter if you use a symbol or a String, eg: 'my_fact' and :my_fact are getting saved as 'my_fact' internally.\n\nFor example, having the following two facts:\n\n{noformat}\nFacter.add('cf2') do\n setcode do\n 'cf2_string'\n end\nend\n\nFacter.add(:cf2, weight: 9999) do\n setcode do\n 'cf2'\n end\nend\n\n\u276f bx facter cf2 --custom-dir $custom_dir\ncf2\n{noformat}\n\nSo to answer your questions: it should not matter if you use strings or symbols as fact names and you should be able to test them, no matter what you use.\n\nNow getting back to your test example, I did some debugging and for me 'network_nexthop_ip' does not get resolved, seems that facter confuses that with the 'network_*' fact, and is not able to resolve `network_nexthop_ip`, due to the name collision. So this is a bug in Facter(it works on CLI, but not when using Facter.value / Facter.fact) -> https://puppet.atlassian.net/browse/FACT-3067\n\n\n{noformat}\n[1] pry(#)> Facter.value('network_nexthop_ip')\nD, [2021-08-26T09:20:04.959020 #38417] DEBUG -- : Facter::FactManager - resolving fact with user_query: network_nexthop_ip\nD, [2021-08-26T09:20:04.959608 #38417] DEBUG -- : Facter::FactManager - Searching fact: network_nexthop_ip in file: network_nexthop_ip.rb\nD, [2021-08-26T09:20:04.962669 #38417] DEBUG -- : Facter::FactManager - Searching fact: network_nexthop_ip in core facts and external facts\nD, [2021-08-26T09:20:04.962702 #38417] DEBUG -- : Facter::FactLoader - Loading all internal facts\nD, [2021-08-26T09:20:04.964297 #38417] DEBUG -- : Facter::QueryParser - List of resolvable facts: [#]\nD, [2021-08-26T09:20:04.964473 #38417] DEBUG -- : Facter::Core::Execution::Posix - Executing command: ifconfig -a\nD, [2021-08-26T09:20:04.976763 #38417] DEBUG -- : Facter::Core::Execution::Posix - Executing command: ipconfig getoption en0 server_identifier\nD, [2021-08-26T09:20:04.982869 #38417] DEBUG -- : Facter::Core::Execution::Posix - Executing command: ipconfig getoption awdl0 server_identifier\nD, [2021-08-26T09:20:04.992180 #38417] DEBUG -- : Facter::Core::Execution::Posix - Executing command: ipconfig getoption llw0 server_identifier\nD, [2021-08-26T09:20:05.000786 #38417] DEBUG -- : Facter::Core::Execution::Posix - Executing command: route -n get default\nD, [2021-08-26T09:20:05.009482 #38417] DEBUG -- : Facter::FactLoader - Loading external facts\nD, [2021-08-26T09:20:05.009763 #38417] DEBUG -- : Facter::FactManager - fact \"network_lo0\" has resolved to: 127.0.0.0\nD, [2021-08-26T09:20:05.009796 #38417] DEBUG -- : Facter::FactManager - fact \"network_en0\" has resolved to: 192.168.100.0\n=>\n{noformat}\n\nthe important line from the debug:\n\n{noformat}\nD, [2021-08-26T09:20:04.964297 #38417] DEBUG -- : Facter::QueryParser - List of resolvable facts: [#]\n{noformat}\n\n\n\nJust to validate my assumption, i renamed 'network_nexthop_ip' to 'xnetwork_nexthop_ip' and the new fact shows up.\n\n\n\n", "created": "2021-08-26T00:27:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "Hi [~accountid:5b9fcedc03b52466f05c4510], thanks for the awesome explanation. Would it be possible to update the documentation and explain the difference between symbols and strings or just use one of them? The docs jump back and forth between symbolized custom facts and strings and as a new user it's not really clear if that's on purpose/a requirement.", "created": "2021-09-01T02:59:00.000000" }, { "author": "5b9fcedc03b52466f05c4510", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] Sure, I'll take a look and make sure we are consistent in the docs.", "created": "2021-09-01T03:28:00.000000" }, { "author": "60e4906e4134aa006931a5d6", "body": "Changed symbol names to strings in upcoming version", "created": "2022-02-17T12:42:00.000000" } ], "components": [], "created": "2021-08-20T10:53:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4b2b7423" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0bz90:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Aug/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_418514855_*|*_3_*:*_1_*:*_6306514397_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_8847242369_*|*_10005_*:*_1_*:*_76299384" } ], "description": "Hi,\nI was working through https://puppet.com/docs/puppet/6/custom_facts.html\nit mentions that you can create custom facts as strings:\n{code}\nFacter.add('hardware_platform') do\n{code}\n\nor symbols:\n{code}\nFacter.add(:osfamily) do\n{code}\n\nalso one example with an underscore:\n{code}\nFacter.add(:fact_name, :type => :aggregate) do\n{code}\n\nI think the last option is impossible to test with rspec. I had to add quotes to the fact like this:\n{code}\nFacter.add(\":fact_name\", :type => :aggregate) do\n{code}\n\nmy example code:\n\n{code}\nrequire 'facter'\nFacter.add(\":network_nexthop_ip\") do\n confine kernel: 'Linux'\n confine { Facter::Util::Resolution.which('ip') }\n my_gw = nil\n setcode do\n gw_address = Facter::Util::Resolution.exec('ip route show 0/0')\n if gw_address.include? ' via '\n my_gw = gw_address.split(%r{\\s+})[2].match(%r{^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$}).to_s\n end\n my_gw\n end\nend\n\nFacter.add(:network_nexthop_ip) do\n confine kernel: 'Linux'\n confine { Facter::Util::Resolution.which('ip') }\n my_gw = nil\n setcode do\n gw_address = Facter::Util::Resolution.exec('ip route show 0/0')\n if gw_address.include? ' via '\n my_gw = gw_address.split(%r{\\s+})[2].match(%r{^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$}).to_s\n end\n my_gw\n end\nend\n\nFacter.add(:networknexthopip) do\n confine kernel: 'Linux'\n confine { Facter::Util::Resolution.which('ip') }\n my_gw = nil\n setcode do\n gw_address = Facter::Util::Resolution.exec('ip route show 0/0')\n if gw_address.include? ' via '\n my_gw = gw_address.split(%r{\\s+})[2].match(%r{^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$}).to_s\n end\n my_gw\n end\nend\n{code}\n\nwith the following test:\n{code}\n# frozen_string_literal: true\n\nrequire 'spec_helper'\nrequire 'facter'\nrequire 'facter/network'\n\ndescribe :network_nexthop_ip, type: :fact do\n subject(:fact) { Facter.fact(:network_nexthop_ip) }\n\n before do\n # perform any action that should be run before every test\n Facter.clear\n allow(Facter.fact(:kernel)).to receive(:value).and_return('Linux')\n allow(Facter::Util::Resolution).to receive(:which).with('ip').and_return('/usr/bin/ip')\n end\n\n it 'returns a the gateway' do\n expect(Facter::Util::Resolution).to receive(:exec).with('ip route show 0/0').and_return('default via 192.168.178.1 dev eth0')\n expect(fact.value).to eq('192.168.178.1')\n end\nend\n\ndescribe \":network_nexthop_ip\", type: :fact do\n subject(:fact) { Facter.fact(\":network_nexthop_ip\") }\n\n before do\n # perform any action that should be run before every test\n Facter.clear\n allow(Facter.fact(:kernel)).to receive(:value).and_return('Linux')\n allow(Facter::Util::Resolution).to receive(:which).with('ip').and_return('/usr/bin/ip')\n end\n\n it 'returns a the gateway' do\n expect(Facter::Util::Resolution).to receive(:exec).with('ip route show 0/0').and_return('default via 192.168.178.1 dev eth0')\n expect(fact.value).to eq('192.168.178.1')\n end\nend\n\ndescribe :networknexthopip, type: :fact do\n subject(:fact) { Facter.fact(:networknexthopip) }\n\n before do\n # perform any action that should be run before every test\n Facter.clear\n allow(Facter.fact(:kernel)).to receive(:value).and_return('Linux')\n allow(Facter::Util::Resolution).to receive(:which).with('ip').and_return('/usr/bin/ip')\n end\n\n it 'returns a the gateway' do\n expect(Facter::Util::Resolution).to receive(:exec).with('ip route show 0/0').and_return('default via 192.168.178.1 dev eth0')\n expect(fact.value).to eq('192.168.178.1')\n end\nend\n{code}\n\nso I've a few questions to the docs:\n* When should I use symbolized facts?\n* Why should I use symbolized facts?\n* In which situations can't I use/test them?\n\nalso some examples about testing and not only creating custom facts would be super helpful.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54600", "fixedVersions": [], "id": "54600", "issueType": "Task", "key": "DOCUMENT-1242", "labels": [ "facter", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2022-02-17T12:42:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation for custom facts might be wrong", "timeSpent": "PT0S", "updated": "2022-02-17T12:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "616989d3048360006aeb55e8", "body": "This ticket requested quantifiable examples of recommended backup frequency.\n\n\u00a0\n\nI can't action this ticket without such input from product or engineering. Further complicating this are varying customer needs and infrastructure scale. If you have a lot of data to backup, you might want to backup frequently, but it could cause slowdowns, so you would possibly choose a less-frequent schedule. If the customer is a bank or government, they might back up more frequently regardless of the size of the infrastructure. A customer with a small infrastructure and infrequent changes might only backup once a week.\u00a0\n\nI recently revised this page to better describe the backup and restore scope, but it remains up to the customer to decide what is appropriate for their backup frequency. [https://puppet.com/docs/pe/2021.7/backing_up_and_restoring_pe.html#backup-and-restore-pe-backup-restore-scope]\u00a0\n\n\u00a0\n\nIf we were able to determine some calculation formula or quantifiable examples, I think this type of information might be more appropriate for Patterns and tactics documentation, which is handled by the solarch team.\u00a0\n\n[https://puppet.com/docs/patterns-and-tactics/latest/patterns-and-tactics.html]\u00a0", "created": "2022-09-09T08:56:00.000000" } ], "components": [], "created": "2021-08-05T12:07:00.000000", "creator": "6009bf1ae2a13500697ef4ff", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@190478bf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0a997:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_81742346_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_34466830661" } ], "description": "*Problem:*\n\nThe backup pages does not offer best practices for interval, storage, and retention policies for Puppet Backups.\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2019.8/backing_up_and_restoring_pe.html#backup-and-restore-pe-backup-restore-scope\n\n_Current text :_\n\nCustomizing backup and restore scope section.\n\n_Suggested improvement:_\n\nAdd a paragraph with the suggested best practices with an example. This section says you should backup based on quantifiable examples like 10 code base and 1,000 nodes checking in hourly, we recommend the following: backups should be scheduled 1x daily for PuppetDB, while the code base should be backed up 2x daily. An example of this configuration etc. (I made those numbers up).\n\n*Summary:*\n\nPlease put some quantifiable examples for some better, best practices.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54950", "fixedVersions": [], "id": "54950", "issueType": "Task", "key": "DOCUMENT-1240", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6009bf1ae2a13500697ef4ff", "resolution": "No Available Fix", "resolutionDate": "2022-09-09T08:56:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Backup pages does not offer best practices for interval, storage, and retention", "timeSpent": "PT0S", "updated": "2022-09-09T08:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "[~accountid:5b11973d6e93913e31e27218]\u00a0would it be possible for you or one of the other devs to do some brief predocs on this workaround for me, maybe as part of our upcoming sprint?\u00a0", "created": "2021-08-03T14:37:00.000000" }, { "author": "5b11973d6e93913e31e27218", "body": "[~accountid:557058:0a2bfc9c-1912-49b1-9776-665ef20c8769]I have never personaly done this, and do not have step-by-step instructions on this process.\n\n[~accountid:557058:6710b319-779a-49c9-b66f-f584a24dab53] Do you know if we have this process documented somewhere we can use as pre-docs?", "created": "2021-08-04T09:50:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Ok, thanks [~accountid:5b11973d6e93913e31e27218]. I saw you answering in Slack so picked on you first. :D\u00a0\n\nAnother question is whether this is more of a KB article type of thing. KB articles can use more specific versioning than our docs do, if upcoming features are going to make this irrelevant to users on the latest 4.x.", "created": "2021-08-04T10:04:00.000000" }, { "author": "557058:b48b0f05-017b-4213-8991-5322047991c4", "body": "Could be a KB article if it's not in docs\u00a0\n\nKB articles shouldn't\u00a0\n * Duplicate existing content. That content should be updated instead. (Not the case here.)\n * Include content that is better suited to other types of request (such as engineering or docs requests).\u00a0\n\nKB articles should\n * Prevent Support tickets from being opened (or help close tickets sooner)\n * Be relevant to supported versions of our enterprise software (At this point probably we don't want 3.x)\n * Affect more than one or two people (How many people are affected? How often does it happen?)\n\nIf you decide it (amongst all of you) that it is, please go ahead and open a SUP ticket with the request a KB article template, if you do that on M-W next week ping Erin O'Malley on it, (I'm on PTO then.)", "created": "2021-08-12T17:37:00.000000" }, { "author": "5b11973d6e93913e31e27218", "body": "I think this will be made moot by the addition of Secrets in CD4PE. Instead of injecting the cert via the job script, you will just be able to add the secret on the job template, and it will be automatically injected into any job runner machine via an environment variable.\n\nThis workaround will still technically exist and be usable, but I'm unsure we will need anyone to utilize it.", "created": "2022-02-01T09:24:00.000000" }, { "author": "557058:b48b0f05-017b-4213-8991-5322047991c4", "body": "That honestly sounds like an engineering solution (not a writing solution). It doesn't feel like docs from Chris' comment. \n\nIf Paddy feels a need for it I'm happy to discuss it as a KB, but otherwise I'm happy to let you close this one out. ", "created": "2022-02-01T10:58:00.000000" } ], "components": [], "created": "2021-08-03T08:56:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@463ef95" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0a6uj:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "45108" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Aug/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_3992202_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_15957400334_*|*_10005_*:*_1_*:*_16488332" } ], "description": "This issue arose from a support ticket where our customer had two cd4pe servers, both wanting to connect to a git:// repo on bitbucket defined in .fixtures.yaml, One cannot connect to the repo throwing the following error and the other can:\n\n\n{code:java}\nCloning into 'spec/fixtures/modules/chocolatey'...\n\nHost key verification failed.\n\nfatal: Could not read from remote repository.\n{code}\n\nTo workaround this, the customer has done the following:\n\n\"In the jobs section of a workspace in CD4PE, when we edit a certain job, say \"module-rspec-puppet\", there is a field \"commands\", where we can enter the steps to run the job. I don't see any documentation on the CD4PE product pages on the usage of this.\n\nHowever, turns out this step has the commands to inject the ssh key into the docker containers to authenticate to the bitbucket repos and was missing in our pre-prod environment but was configured in lab. After configuring the same, the code validation rspec stage works as expected.\"\n\nCan we get this method above properly documented?\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54598", "fixedVersions": [], "id": "54598", "issueType": "Improvement", "key": "DOCUMENT-1238", "labels": [ "cd4pe", "jira_escalated", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Won't Do", "resolutionDate": "2022-02-04T06:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documennt the use of CD4PE Commands field to inject SSL certs into docker containers", "timeSpent": "PT0S", "updated": "2022-02-04T06:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "body": "[~accountid:557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca]\u00a0CC for visibility as I'm sure Support have/will hit this, or if you happen to know where the docs are for this that I haven't been able to find", "created": "2021-08-02T05:12:00.000000" }, { "author": "5b50a69a2726b92cd5368cb3", "body": "[~accountid:557058:afa80a20-2814-4f2f-bbdd-ad5db4190123] are you seeing this come up when talking with customers? ACE is more behind the scenes. Which customers are looking to tune ACE or play around with it? Do you know what their use case is?", "created": "2021-08-19T14:23:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "It seems like it was an unpopular opinion to further document ACE and, since this ticket has gone stale, I'm going to close. Please reopen if you would like to continue to discuss.\u00a0", "created": "2022-01-25T09:44:00.000000" }, { "author": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "body": "I think a page stating what it is, the ports / protocols and stuff would be good as a reference stub.\n\nwe loosly mention it as a , service and as a component, and how to set up the SSL protocols for the service, we should have a general description of the component if we ship it", "created": "2022-01-25T09:53:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "I agree with [~accountid:557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca]. The service is shipped by default. Having that undocumented is really a bad practice. If nobody cares about the service, why is it in PE? ", "created": "2022-01-27T02:39:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I dont necessarily think people dont care about ACE, but the question is how much users need to know about it. The PE docs must be maintained, and I want to avoid adding information that must be maintained but isn't useful. That said, I actually did find some existing information about ACE in the configuration docs in the Orchestrator section, but I'm not sure why it's not appearing in the docs sight search: [https://puppet.com/docs/pe/2021.4/configuring_puppet_orchestrator.html#pe_ace_services_configuration]\u00a0\n\nI'll add concurrency to this list, as well as any other config options that are missing.\u00a0\n\nI can also flesh these topics out a bit to add some information about ACE:\n\n[https://puppet.com/docs/pe/2021.4/running_jobs_with_puppet_orchestrator_overview.html]\u00a0\n\n[https://puppet.com/docs/pe/2021.4/pe_architecture_overview.html]\u00a0\n\nAnd add the port here:\n\n[https://puppet.com/docs/pe/2021.4/system_configuration.html#system_configuration]\u00a0\n\nDoes that sound ok?\u00a0", "created": "2022-01-27T10:13:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I discovered WWM-11712 has already been opened to research relevant results not appearing in the searches, and added the ace config section as an example.\u00a0", "created": "2022-01-27T10:17:00.000000" } ], "components": [], "created": "2021-08-02T05:11:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@843b50d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0excm:i" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_98404566_*|*_3_*:*_1_*:*_3294174430_*|*_10009_*:*_1_*:*_242832929_*|*_4_*:*_1_*:*_181345441_*|*_6_*:*_2_*:*_521438_*|*_10004_*:*_1_*:*_14859406461_*|*_10006_*:*_1_*:*_684958184_*|*_10005_*:*_1_*:*_268607819" } ], "description": "Despite ACE being mentioned in some of the PE docs:\n\n[https://puppet.com/docs/pe/2021.2/what_gets_installed_and_where.html]\n\n[https://puppet.com/docs/pe/2021.2/component_versions_in_recent_pe_releases.html]\n\nIt isn't actually documented anywhere. Professional Services and Support (let alone customers) can't be expected to be able to troubleshoot and performance time components that have no available documentation\n\n\u00a0\n\nFor example there a tuneable setting called \"concurrency\" that is presumably related to performance tuning but is not documented anywhere. I have raised an issue in the repo about the lack of documentation: [https://github.com/puppetlabs/ace/issues/98]\u00a0However since this is a component of PE it should also be documented in the official docs, as well as the repo.\n\n\u00a0\n\nDocumentation should cover, at a minimum:\n * What is the component for? What does it do? (In more detail than \"provides agentless executions services for tasks and catalogs to Puppet Enterprise\")\n * How does this component communicate? What ports? What protocols?\n * How does this component scale? What resources does it use? How can these resource be tuned?\n * How is this component affected by DR?\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55114", "fixedVersions": [], "id": "55114", "issueType": "Improvement", "key": "DOCUMENT-1237", "labels": [ "medium", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Done", "resolutionDate": "2022-03-17T10:02:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Document ACE Server", "timeSpent": "PT0S", "updated": "2022-03-17T10:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5fc46fd09592df0076141ac0", "attachments": [], "comments": [], "components": [], "created": "2021-07-06T09:14:00.000000", "creator": "623e75671c7f6a00704b28f5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71ac5261" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o09kyz:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Jul/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2966840_*|*_3_*:*_1_*:*_1613235_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1396569218_*|*_10005_*:*_1_*:*_1197414078" } ], "description": "[https://puppet.com/docs/puppet/6/roles_and_profiles_example.html]\n\nmentions group and stage as custom facts, but doesn't explain how to assign those to individual nodes.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54323", "fixedVersions": [], "id": "54323", "issueType": "Improvement", "key": "DOCUMENT-1236", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623e75671c7f6a00704b28f5", "resolution": "Fixed", "resolutionDate": "2021-08-05T11:03:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add facts documentation to Roles and Profiles", "timeSpent": "PT0S", "updated": "2021-08-05T11:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Fixed in DOC-5036", "created": "2021-08-10T13:57:00.000000" } ], "components": [], "created": "2021-06-24T05:51:00.000000", "creator": "557058:d1729ddb-cd82-4029-b682-bf43efb49787", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "If you click on one of the attributes in the overview your browser should jump to the desired position on the website." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4183b908" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o09d7f:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_447300789_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3642692109" } ], "description": "The anchor links in the documentation of puppet built in types do not work.\n\nIf you click on the links on the user-resource in the overview of all attributes you get a link like:\n\n[https://puppet.com/docs/puppet/7/types/user.html#user-attribute-managehome]\n\nBut it has to be [https://puppet.com/docs/puppet/7/types/user.html#managehome]\n\n\u00a0\n\n\"Fun-Fact\" if you hover over the bolder headline for your headline you will get the right link from the anchor-icon.\n\n\u00a0\n\nI already mentioned it on the slack channel:\n\nhttps://puppetcommunity.slack.com/archives/C0W298S9G/p1624460568073200", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54902", "fixedVersions": [], "id": "54902", "issueType": "Bug", "key": "DOCUMENT-1235", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d1729ddb-cd82-4029-b682-bf43efb49787", "resolution": "Fixed", "resolutionDate": "2021-08-10T13:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "anchor links broken", "timeSpent": "PT0S", "updated": "2021-08-10T13:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "60e4906e4134aa006931a5d6", "attachments": [], "comments": [], "components": [], "created": "2021-06-23T02:08:00.000000", "creator": "557058:5f6a2765-dcc9-4181-be76-9b5478a2c63b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@11c5c3b9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o09b0z:" } ], "description": "[https://puppet.com/docs/puppet/6/lang_variables.html]\u00a0provides some information on the use of puppet variables.\n\nThere's even a part which talks about setting strict_variables = true so that any undefined variables are noticed and will generate an error.\n\nHowever, if using facter generated variables that might have global scope the fact may or may not exist depending on the state of the system being managed.\n\nThis means you need to wrap code that depends on that variable in such a way that if the variable is not defined it won't generate an error and if defined the related code can be used.\n\nHow to handle this is not clearly defined or even mentioned as there's an assumption that all variables will be defined and if they're not this is an error. Handling this specific issue would be good and some comments around it would be helpful.\n\n\u00a0", "environment": "Seen this running with\u00a0puppet-agent-6.19.1.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54527", "fixedVersions": [], "id": "54527", "issueType": "Bug", "key": "DOCUMENT-1234", "labels": [ "facter", "handling", "puppet", "undefined", "variabless" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:5f6a2765-dcc9-4181-be76-9b5478a2c63b", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "how to handle undefined variables in a puppet recipe", "timeSpent": "PT0S", "updated": "2023-05-17T18:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [], "components": [], "created": "2021-06-22T10:21:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@722369bc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsu4k:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_86163074_*|*_3_*:*_1_*:*_25489235_*|*_5_*:*_1_*:*_0" } ], "description": "I've tried ten random endpoint docs links in the 6.13 PuppetDB docs, and all of them give 404 errors. These docs are still relevant for our PE 2019.8.x customers.\n\nExamples:\n\nhttps://puppet.com/docs/puppetdb/6.y/api/query/v4/packages.html\nhttps://puppet.com/docs/puppetdb/6.y/api/query/v4/environments.html\nhttps://puppet.com/docs/puppetdb/6.y/api/status/v1/status.html\n\nAll of these are provided from the 6.13 docs here: https://puppet.com/docs/puppetdb/6.13/index.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54526", "fixedVersions": [], "id": "54526", "issueType": "Task", "key": "DOCUMENT-1233", "labels": [ "puppetdb", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2021-06-23T17:21:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "None of the PuppetDB 6.13 API Docs links work", "timeSpent": "PT0S", "updated": "2021-06-23T17:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Ensure is present on the single-file types reference: [https://puppet.com/docs/puppet/7/type.html]\n\n\u00a0\n\nStill figuring out what the issue is with the individual files", "created": "2021-06-22T10:42:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "I should be able to regenerate the type docs with the missing parameter after the next Strings release.", "created": "2021-07-02T10:13:00.000000" } ], "components": [], "created": "2021-06-22T10:16:00.000000", "creator": "5b0340d43eafdb09dee5bc3a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c927b39" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08t9e:w" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_166631_*|*_3_*:*_3_*:*_659124410_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_1935954137_*|*_10006_*:*_1_*:*_4575106" } ], "description": "The 'ensure' attribute is missing from the Puppet 6 and 7 docs:\n\n[https://puppet.com/docs/puppet/7/types/file.html]\n\n[https://puppet.com/docs/puppet/6/types/file.html]\n\n\u00a0\n\nConversation in Slack:\u00a0https://puppetcommunity.slack.com/archives/C0W298S9G/p1624353435015700\n\n\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55112", "fixedVersions": [], "id": "55112", "issueType": "Task", "key": "DOCUMENT-1232", "labels": [ "feedback-form-docs-site", "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b0340d43eafdb09dee5bc3a", "resolution": "Fixed", "resolutionDate": "2021-07-22T12:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "'ensure' parameter missing in generated docs", "timeSpent": "PT0S", "updated": "2021-07-22T12:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:ad3ba12f-a09f-4f5e-9fff-8660ad829629", "body": "Given that the above contains the *old* (7F43 ...) key (due to expire in August), I suspect the doc being used might also be old.\n\nFrom a slack conversation I had with [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] back in November:\n{quote}I've noticed that 'gpg --keyserver pgp.mit.edu --recv-key 4528B6CD9E61EF26' can be unreliable/flakey because of network issues at pgp.mit.edu\n\nIt could be helpful to note in the documentation to try 'gpg --keyserver hkp://keyserver.ubuntu.com:11371 --recv-key 4528B6CD9E61EF26' should the former fail.\n{quote}\nTo the best of my knowledge, some version of the above is in the current documentation", "created": "2021-06-10T14:31:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "Ah! It looks like this made it to [Puppet 7,|https://puppet.com/docs/puppet/7/verify_packages.html] but not 6. I'll update with the newer doc.", "created": "2021-06-10T14:36:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "I've updated the page to use the\u00a0keyserver.ubuntu.com server that we use in the Puppet 7 docs", "created": "2021-06-10T17:15:00.000000" }, { "author": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "body": "Thanks a lot, [~accountid:5b0340d43eafdb09dee5bc3a].\n\nYes, I was indeed referring to the Puppet 6 version of the docs (didn't update to 7 yet, due to lack of support for it in The Foreman ", "created": "2021-06-11T01:51:00.000000" } ], "components": [], "created": "2021-06-10T04:28:00.000000", "creator": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "pgp.mit.edu is replaced with ha.pool.sks-keyservers.net on page [Manually verify packages|https://puppet.com/docs/puppet/6/verify_packages.html]." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@fbd12ac" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o092xv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_29861969_*|*_3_*:*_1_*:*_1097685_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_15032508" } ], "description": "Above page uses the keyserver *pgp.mit.edu* in its examples, but all URLs for HTTP retrieval use *pool.sks-keyservers.net*. It turns out that *pgp.mit.edu* is quite unreliable and slow these days, so that the command\n{code:java}gpg --keyserver pgp.mit.edu --recv-key 7F438280EF8D349F{code}\ndoesn't work most of the time, for example:\n{code:java}# gpg --keyserver pgp.mit.edu --recv-key 6F6B15509CF8E59E6E469F327F438280EF8D349F\ngpg: keyserver receive failed: No data\n# gpg --keyserver pgp.mit.edu --recv-key 6F6B15509CF8E59E6E469F327F438280EF8D349F\ngpg: keyserver receive failed: No keyserver available\n{code}\n\u00a0(Doesn't matter whether long or short version of the key is used.)\n\n\u00a0\n\nPlease replace *pgp.mit.edu* with *ha.pool.sks-keyservers.net*, which is both reliable and fast, in all examples.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54699", "fixedVersions": [], "id": "54699", "issueType": "Improvement", "key": "DOCUMENT-1231", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:89116718-adb8-45d4-bcd9-1483be79f43a", "resolution": "Fixed", "resolutionDate": "2021-06-10T17:15:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"Manually verify packages\" page: pgp.mit.edu is unreliable", "timeSpent": "PT0S", "updated": "2021-06-11T01:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "6422c2184b23217e558e1784", "attachments": [], "comments": [], "components": [], "created": "2021-06-08T03:27:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@11a3e8d9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzi6nw:xc" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jun/21" } ], "description": "https://puppet.com/docs/pe/2019.8/upgrading_pe.html should mention somewhere that if you don't have Internet access, you should download and install agent tarballs from https://puppet.com/misc/pe-files/pe_repo/ per https://puppet.com/docs/pe/2019.8/installing_agents.html#install_nix_agents_no_internet on your internal mirror of https://pm.puppetlabs.com/puppet-agent/ (that is, the $base_path parameter of the pe_repo module) _before_ upgrading. This is because the pe_repo module tries to download the agent tarballs during the upgrade. But if you don't know this is going to happen (because it doesn't say so on the Upgrading PE page), then that step of the PE upgrade fails, and you'll have to fix it then run the upgrade again. While you're fixing it, your agents will be contacting your primary server and trying to upgrade their agents (if you use the puppet_agent module with the version set to auto), which will also fail because you didn't have the agent tarballs in place beforehand. So it can save a lot of time if you prepare this ahead of time, which is why the Upgrading PE page should explain this a little bit.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54596", "fixedVersions": [], "id": "54596", "issueType": "Improvement", "key": "DOCUMENT-1230", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Upgrade PE should say that you should have your internal agent tarballs downloaded before upgrading PE", "timeSpent": "PT0S", "updated": "2023-06-05T15:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "5d9f43aac62f840db2b6ee35", "body": "Sorry [~accountid:557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3]\u00a0- Where is this information listed in our docs?\nit's not clear what you want here. A note/known issue in the customer-facing Comply docs that says these parameters are not available if you install v1.0.4?", "created": "2021-06-02T00:52:00.000000" }, { "author": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "body": "Actually [~accountid:5d9f43aac62f840db2b6ee35] it looks like I jumped the gun. In the next release those parameters will be moved to the comply class, but now they exist in the comply::scanners:ciscat class (as per the documentation). I was looking at the wrong version of the code, so please close this ticket, it's a non-issue.", "created": "2021-06-02T03:54:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "HI [~accountid:557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3]. Yes Ioannis told me the same. No problem.", "created": "2021-06-02T03:57:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Mistaken issue referring to next feature\u00a0parameters which haven't been released yet", "created": "2021-06-02T03:59:00.000000" } ], "components": [], "created": "2021-06-01T02:41:00.000000", "creator": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c537fd5" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08t83:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_26583429_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_7400165_*|*_10005_*:*_1_*:*_57087451" } ], "description": "In the parameters for the comply::scanners::ciscat v1.0.4 the following parameters are listed, but aren't actually available in that version:\n\nBoolean $allow_insecure \nOptional[Stdlib::Fqdn] $comply_fqdn\nBoolean $use_mtls\nBoolean $windows_manage_wget\n\nAs they were implemented after the release, and are only available if you download the source code directly from the git repo (ignoring the labels)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54593", "fixedVersions": [], "id": "54593", "issueType": "Bug", "key": "DOCUMENT-1228", "labels": [ "comply" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "resolution": "Won't Do", "resolutionDate": "2021-06-02T03:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Comply module documentation has parameters listed not available in version 1.0.4", "timeSpent": "PT0S", "updated": "2021-06-02T03:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [ { "attacher": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "created": "2021-05-22T11:20:00.000000", "name": "Screen Shot 2021-05-22 at 10.14.43 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14239" }, { "attacher": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "created": "2021-05-25T14:32:00.000000", "name": "Screen Shot 2021-05-25 at 1.22.29 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14204" } ], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Changes shipped along with 4.6.0 today. Thanks!\u00a0", "created": "2021-06-03T11:50:00.000000" } ], "components": [], "created": "2021-05-22T11:21:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4aa80b2f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08lwh:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_166820478_*|*_3_*:*_1_*:*_763985824_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_107744680" } ], "description": "I don't know if I'm creating the right kind of ticket. I used the link on the docs page to create a DOCUMENTATION ticket for the first one but now i see the feedback box on the page instead of the JIRA link. Normally I would just create CDPE tickets...anyway:\n\nStep 2 in the https://puppet.com/docs/continuous-delivery/4.x/migrate_4_x.html#migrate_task section says to \"select the Enable migration of an existing CD4PE instance option\". This is kind of a nit, like i didn't get completely lost, but the text is pretty different in the Replicated UI now (see attached screenshot). Note this is also in step 9.\n\nAnd while I'm here, step 3 says to \"On the Version history page, click Deploy.\" which is correct, but I wonder if it would be better to say something about clicking deploy on the latest version (the one that was just created after updating the config in step 2 and is briefly highlighted)? ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54901", "fixedVersions": [], "id": "54901", "issueType": "Bug", "key": "DOCUMENT-1227", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2021-06-03T11:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE migration docs: migration config text", "timeSpent": "PT0S", "updated": "2021-06-03T11:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thanks for catching this! I have the same doc in 3.x and 4.x, but I have to update each one individually. I made this fix a while back in 4.x but forgot to do so in 3.x.\u00a0", "created": "2021-05-25T15:58:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Changes shipped along with 4.6.0 today. Thanks!\u00a0", "created": "2021-06-03T11:50:00.000000" } ], "components": [], "created": "2021-05-22T11:09:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3bbe4c2d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08lwg:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/May/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_167562785_*|*_3_*:*_1_*:*_762865211_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_108817729" } ], "description": "In the \"Before you begin\" box of the https://puppet.com/docs/continuous-delivery/3.x/migrate_4_x.html#migrate_task section, we state that the latest version in the 3.x series is 3.13.4 when it is now 3.13.7. \nI don't anticipate that changing before August (fingers crossed, crying a little) but it _might_ so I think it's worth considering not calling out the specific version. But. I see why we would, in which case a simple update would do the trick.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54830", "fixedVersions": [], "id": "54830", "issueType": "Bug", "key": "DOCUMENT-1226", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2021-06-03T11:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE Migration docs: latest version needs to be updated", "timeSpent": "PT0S", "updated": "2021-06-03T11:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Filed separate ticket for graphics updates, so this is on hold ATM. \n\nNote: We also need to add 8143 to the table for standard installations.", "created": "2021-06-14T15:26:00.000000" } ], "components": [], "created": "2021-05-19T15:14:00.000000", "creator": "70121:4064cec6-dee3-4dca-a2f7-79a41ffd4602", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@46c51055" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08t9c:i" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_415766070_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_124849_*|*_10006_*:*_2_*:*_3293347085" } ], "description": "The system diagrams located on the documents page are missing port 8143 from the \"End Users\" to the \"Primary Server\". This port is necessary for users/systems to interact with the PE Orchestrator API.\n\n[https://puppet.com/docs/pe/latest/system_configuration.html]\n\nNote that the port is listed properly in the port tables below each diagram.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54525", "fixedVersions": [], "id": "54525", "issueType": "Bug", "key": "DOCUMENT-1225", "labels": [ "graphics", "melissa", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:4064cec6-dee3-4dca-a2f7-79a41ffd4602", "resolution": "Fixed", "resolutionDate": "2021-07-01T13:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "System config diagrams missing port 8143", "timeSpent": "PT0S", "updated": "2021-07-01T13:35:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "623c0a1a761efb0069ce016b", "body": "And the document is not clear while updating from one version to another (eg: 2019.8.1 to 2019.8.6)\n[https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrading_pe]", "created": "2021-05-17T23:08:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "There's not really a straightforward list of commands you can use to check component versions. {{puppet --version}} and {{puppetserver --version}} work, but that isn't a consistent pattern. You can use your package manager to see what's installed, but those commands aren't consistent across platforms. Alternatively, you can look in the packages directory of the tarball or, if they have a CLI, the components themselves might report their version, which might or might not match the tag on the package. In other words, the docs table is basically the easiest method to determine component versions in a given version of PE. If you wish, you might consider opening an ENTERPRISE ticket about adding consistent component version-checking commands to the product itself. As this is really beyond the realm of docs, we're closing this as won't fix. ", "created": "2021-05-18T11:06:00.000000" } ], "components": [], "created": "2021-05-17T22:52:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@749dbfdb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08k98:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/May/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_44051207_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem: It should be good if we provide the commands to identify the versions of components (puppet server,puppetdb,r10k..etc)*\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/component_versions_in_recent_pe_releases.html]\n\n_Current text :_\n\nThis table shows the components installed on all agent nodes /This table shows the components installed on all agent nodes.\n\n_Suggested improvement:_\n\nrather than that\u00a0*It should be good if we provide the commands to identify the versions of components (puppet server,puppetdb,r10k..etc)*\n\n\u00a0Cmdlet to get the Hiera version, puppet agent and master version..etc\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54592", "fixedVersions": [], "id": "54592", "issueType": "Improvement", "key": "DOCUMENT-1224", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Won't Fix", "resolutionDate": "2021-05-18T11:06:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add commands to check component versions", "timeSpent": "PT0S", "updated": "2021-05-18T11:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "616989d3048360006aeb55e8", "attachments": [], "comments": [ { "author": "623c0a1a761efb0069ce016b", "body": "we can add the SSH public key with the below steps.\n[https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops#step-2--add-the-public-key-to-azure-devops-servicestfs\n\nDo we have any other ways to authenticate ? if we can use the service account, do we have any steps ?|https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops#step-2--add-the-public-key-to-azure-devops-servicestfs]", "created": "2021-05-12T04:19:00.000000" } ], "components": [], "created": "2021-05-12T01:08:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56b1a403" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08hho:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Apr/22" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_550935687_*|*_3_*:*_1_*:*_16134965_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_6998524600_*|*_10005_*:*_1_*:*_20468953979_*|*_10016_*:*_1_*:*_2235810" } ], "description": "*Problem: The document is not covered the complete information*\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/control_repo.html]\n\n_Current text :_\n\nConfigure your\u00a0Git\u00a0host to use the SSH public key you generated. The process to do this is different for every\u00a0Git\u00a0host. Usually, you create a user or service account, and then assign the SSH public key to it.\n\nCode management needs read access to your control repository, as well as any module repositories referenced in the\u00a0Puppetfile.\n\n_Suggested improvement:_\n\nDid not covered *how to add a existing repository* and steps missed of\u00a0*how to provide the access to the code manager on repository.*\n\n*Summary:*\n\n\u00a0I have a repository which having the development and production (branches) environments. Now i would like to\u00a0 add the new environment as *staging*. No proper document is available to satisfy the requirement.\n\nExpecting a new page as how to add a new environment for the existing repository or created a new repository.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54900", "fixedVersions": [], "id": "54900", "issueType": "Improvement", "key": "DOCUMENT-1223", "labels": [ "code-mgmt", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Fixed", "resolutionDate": "2022-04-01T13:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add an environment to the existing repository and configuring the code manager", "timeSpent": "PT0S", "updated": "2022-04-01T13:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you for bringing this to our attention! Unfortunately, the 5.5 docs are no longer being updated, as 5.5 is EOL. The cron type was removed from Puppet core in 6.0, so current docs don't have this. Closing at won't fix.", "created": "2021-05-11T10:09:00.000000" } ], "components": [], "created": "2021-05-11T06:02:00.000000", "creator": "557058:fc567e44-6d3d-49db-ac38-0ed06b9e11c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7b6bd4d7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08fms:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/May/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14806206_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\n\u00a0If you remove weekday what was there stays.\u00a0 Docs say only numbers allowed, but * is allowed and needed if a change is made\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/5.5/types/cron.html#cron-attribute-weekday\n\n_Current text :_\n\nThe weekday on which to run the command. Optional; if specified, must be either:\n * A number between 0 and 7, inclusive, with 0 or 7 being Sunday\n * The name of the day, such as \u2018Tuesday\u2019.\n\n.\n\n_Suggested improvement:_\n\nThe weekday on which to run the command. Optional; if specified, must be either:\n * A number between 0 and 7, inclusive, with 0 or 7 being Sunday\n * The name of the day, such as \u2018Tuesday\u2019.\n * ** for all days*\n\n_*If you have a numeric entry for weekday and want to remove it, you must replace it with '*' or the previous entry will remain.*_\n\n*Summary:*\n\n\u00a0Added in * for all days which is supported in 5.5 but is undocumented and is needed if you change the entry.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54107", "fixedVersions": [], "id": "54107", "issueType": "Bug", "key": "DOCUMENT-1222", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:fc567e44-6d3d-49db-ac38-0ed06b9e11c8", "resolution": "Won't Fix", "resolutionDate": "2021-05-11T10:09:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "correction to cron parameter", "timeSpent": "PT0S", "updated": "2021-05-11T10:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5fc46fd09592df0076141ac0", "attachments": [], "comments": [ { "author": "5fc46fd09592df0076141ac0", "body": "[~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de]\u00a0- active docs (version 6 and 7) updated to reflect new subdirectory:\u00a0\n\n[https://puppet.com/docs/puppet/7/puppet_strings.html]\n\n\u00a0", "created": "2021-06-07T15:25:00.000000" } ], "components": [], "created": "2021-05-07T19:25:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4fe2e7f4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08eak:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Jun/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_312275298_*|*_3_*:*_1_*:*_607063_*|*_10009_*:*_1_*:*_3520958_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1577219665_*|*_10005_*:*_1_*:*_770417229" } ], "description": "In this section:\n\n[https://puppet.com/docs/puppet/5.5/puppet_strings.html#concept-3933]\n\nwe just need to add {{plans/}} to the list. \n\nHere's the list in the code for reference: https://github.com/puppetlabs/puppet-strings/blob/main/lib/puppet-strings.rb#L7-L12", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54322", "fixedVersions": [], "id": "54322", "issueType": "Bug", "key": "DOCUMENT-1221", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2021-06-07T15:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet strings style guide missing a subdir", "timeSpent": "PT0S", "updated": "2021-06-07T15:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:623c0f891c7f6a007049e734], thanks for catching this discrepancy. We recently revised our hardware requirements and downsized the node recommendations for standard installations based on our internal use of PE. We now broadly recommend adding compilers to improve performance around 2,500 nodes. We'll update the supported architectures page accordingly. ", "created": "2021-05-05T08:57:00.000000" } ], "components": [ "PE" ], "created": "2021-05-03T16:27:00.000000", "creator": "623c0f891c7f6a007049e734", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4e89ca39" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o084ky:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/May/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_63784083_*|*_5_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_82329555" } ], "description": "*Problem:*\n\nIn the \"Supported architectures\" page ([https://puppet.com/docs/pe/2019.8/supported_architectures.html),] there is a table describing node limits for standard installations (4000), large installations (4000-20000) and extra-large installations (more than 20000). However, the \"hardware requirements\" page ([https://puppet.com/docs/pe/2019.8/hardware_requirements.html#hardware_requirements)] gives the upper limit for a standard installation as 2500 nodes; and a large installation as being between 2500 and 20000 nodes.\n\n*Suggested improvement:*\n\nI am not in a position to determine which of these recommendations is correct. Being cautious, I would go with the lower figures when talking to clients, but it would be better if an appropriate subject matter expert updates one or the other to match the actual recommendations.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55111", "fixedVersions": [], "id": "55111", "issueType": "Bug", "key": "DOCUMENT-1220", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0f891c7f6a007049e734", "resolution": "Fixed", "resolutionDate": "2021-05-05T09:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Conflicting information in Puppet documentation", "timeSpent": "PT0S", "updated": "2021-05-05T09:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Yeah, I agree this is weird UX. However, it is accurate that you need SSH only in order to \"swap\" your primary and replica. The rest of DR is configured with orchestrator, so there is no Bolt/SSH requirement. I will get that link fixed though. Thanks for the heads up. ", "created": "2021-04-26T13:22:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "The link is fixed now and should update with our next docs build.", "created": "2021-05-18T15:02:00.000000" } ], "components": [], "created": "2021-04-23T07:30:00.000000", "creator": "70121:2de59ed4-1225-45e2-bd5e-808f31392150", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4319ff53" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03lht:ibz" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Apr/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_280362146_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1906753969" } ], "description": "While on a customer engagement we had issues with configuring ssh bolt options:\n\n[https://puppet.com/docs/pe/2019.8/dr_configure.html#dr-provision-replica-using-failed-primary]\n\nThe link below from the section sends a 404 error\n\n[https://puppet.com/docs/bolt/latest/bolt_configuration_options.html#openssh-configuration-options]\n\nMy primary concern is that the document is very light on information and if the user was not a Unix / OS administrator they would have some difficulty with setting this up, but also this should be under the prerequisite / requirements section for setting up replication. That would avoid delays troubleshooting when you actually get to that part of the document in the middle of testing the failover and promoting a failed primary\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54948", "fixedVersions": [], "id": "54948", "issueType": "Bug", "key": "DOCUMENT-1218", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:2de59ed4-1225-45e2-bd5e-808f31392150", "resolution": "Fixed", "resolutionDate": "2021-05-18T15:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Link in document for configuring bolt ssh does not work", "timeSpent": "PT0S", "updated": "2021-05-18T15:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "5d9f43aac62f840db2b6ee35", "body": "End-user notes from #puppet-dev:\n I found a bug with\u00a0[puppet.com/docs|https://puppet.com/docs]\u00a0and tried to file a DOCUMENT bug but I\u2019m getting a very unhelpful error from Jira (see screenshot). Including the report here", "created": "2021-04-22T05:22:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Added section IDs to format_reports.dita.", "created": "2021-04-22T06:57:00.000000" } ], "components": [], "created": "2021-04-22T05:05:00.000000", "creator": "5d9f43aac62f840db2b6ee35", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e8a841a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o082fo:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1089653_*|*_3_*:*_1_*:*_5611092_*|*_6_*:*_1_*:*_0" } ], "description": "\u00a0Section IDs causing error because of special characters in the section title. Need to add section IDs in XML source to compensate.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54321", "fixedVersions": [], "id": "54321", "issueType": "Task", "key": "DOCUMENT-1217", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5d9f43aac62f840db2b6ee35", "resolution": "Fixed", "resolutionDate": "2021-04-22T06:57:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Section ID error on format_reports.html in osp-docs", "timeSpent": "PT0S", "updated": "2021-04-22T06:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "Website & IA" ], "created": "2021-04-20T19:41:00.000000", "creator": "557058:c2154e56-21a5-4fda-b7a3-3e069a5aac0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@27eb7c08" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cajs:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_17528667692_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nOn pages with headings that include \"::\", the generated section links show a blank page when clicked or loaded.\n\n*Example case:*\n # Scroll to the bottom of: [https://puppet.com/docs/puppet/7.5/format_report.html]\n # Note that the generated section link for \"Differences from report format 9\" works.\n # Scroll up and observe the section link for \"Puppet::Transaction::Event\".\nNote that the generated section link includes \"::\" with no escaping or substitution.\nNote that clicking on the link or loading it in a new tab results in a blank page.\n\n\u00a0I have verified this behavior on Safari\u00a014.0.3 (16610.4.3.1.7), and Chrome\u00a089.0.4389.128", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54918", "fixedVersions": [], "id": "54918", "issueType": "Bug", "key": "DOCUMENT-1216", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:c2154e56-21a5-4fda-b7a3-3e069a5aac0a", "resolution": "Duplicate", "resolutionDate": "2021-11-09T15:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Heading anchor links with :: result in blank page", "timeSpent": "PT0S", "updated": "2021-11-09T15:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Duplicate of https://puppet.atlassian.net/browse/DOCUMENT-1216.\u00a0", "created": "2021-11-09T07:40:00.000000" } ], "components": [ "Website & IA" ], "created": "2021-04-20T19:40:00.000000", "creator": "557058:c2154e56-21a5-4fda-b7a3-3e069a5aac0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3d5b39a7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cak0:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Nov/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_17499652219_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nOn pages with headings that include \"::\", the generated section links show a blank page when clicked or loaded.\n\n*Example case:*\n # Scroll to the bottom of: [https://puppet.com/docs/puppet/7.5/format_report.html]\n # Note that the generated section link for \"Differences from report format 9\" works.\n # Scroll up and click the section link for \"Puppet::Transaction::Event\".\nThe generated section link is: [https://puppet.com/docs/puppet/7.5/format_report.html#puppet::transaction::event]\nNote that clicking on this results in a blank page.\n\n\u00a0I have verified this behavior on Safari\u00a014.0.3 (16610.4.3.1.7), and Chrome\u00a089.0.4389.128", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54698", "fixedVersions": [], "id": "54698", "issueType": "Bug", "key": "DOCUMENT-1215", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:c2154e56-21a5-4fda-b7a3-3e069a5aac0a", "resolution": "Duplicate", "resolutionDate": "2021-11-09T07:40:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Heading anchor links with :: result in blank page", "timeSpent": "PT0S", "updated": "2021-11-09T07:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Fixed, update should appear shortly.", "created": "2021-04-15T11:42:00.000000" } ], "components": [], "created": "2021-04-14T19:59:00.000000", "creator": "5c4202e695e00f6a4ec2ab7f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4ed18397" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o07vys:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Apr/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_55778480_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_796103" } ], "description": "*Problem:*\n\nOn the page\u00a0\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\nUnder Uninstall *nix agents theres a typo\n\n*Suggested improvement:*\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\n_Current text :_\n On the agent node, run the uninstall script: run /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n_Suggested improvement:_\n\nRun should be removed, its redundant & doesn't lead to a good user experience of copy and pasting the italic.\n On the agent node, run the uninstall script: *run* /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54590", "fixedVersions": [], "id": "54590", "issueType": "Bug", "key": "DOCUMENT-1214", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c4202e695e00f6a4ec2ab7f", "resolution": "Fixed", "resolutionDate": "2021-04-15T11:42:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Copy and paste text for uninstall agent includes an extra word", "timeSpent": "PT0S", "updated": "2021-04-15T11:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "Website & IA" ], "created": "2021-04-14T19:58:00.000000", "creator": "5c4202e695e00f6a4ec2ab7f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a634502" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0capk:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18046078206_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nOn the page\u00a0\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\nUnder Uninstall *nix agents theres a typo\n\n*Suggested improvement:*\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\n_Current text :_\n On the agent node, run the uninstall script: run /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n_Suggested improvement:_\n\nRun should be removed, its redundant & doesn't lead to a good user experience of copy and pasting the italic.\n On the agent node, run the uninstall script: *run* /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54524", "fixedVersions": [], "id": "54524", "issueType": "Bug", "key": "DOCUMENT-1213", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c4202e695e00f6a4ec2ab7f", "resolution": "Duplicate", "resolutionDate": "2021-11-09T15:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in Adding and removing agent nodes", "timeSpent": "PT0S", "updated": "2021-11-09T15:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "Website & IA" ], "created": "2021-04-14T19:58:00.000000", "creator": "5c4202e695e00f6a4ec2ab7f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@70c13b38" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0caps:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18046100149_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nOn the page\u00a0\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\nUnder Uninstall *nix agens theres a typo\n\n*Suggested improvement:*\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\n_Current text :_\n On the agent node, run the uninstall script: run /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n_Suggested improvement:_\n\nRun should be removed, its redundant & doesn't lead to a good user experience of copy and pasting the italic.\n On the agent node, run the uninstall script: *run* /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54320", "fixedVersions": [], "id": "54320", "issueType": "Bug", "key": "DOCUMENT-1212", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c4202e695e00f6a4ec2ab7f", "resolution": "Duplicate", "resolutionDate": "2021-11-09T15:46:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in Adding and removing agent nodes", "timeSpent": "PT0S", "updated": "2021-11-09T15:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "Website & IA" ], "created": "2021-04-14T19:57:00.000000", "creator": "5c4202e695e00f6a4ec2ab7f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@89bbdc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0caq0:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18046219243_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nOn the page\u00a0\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\nUnder Uninstall *nix agens theres a typo\n\n*Suggested improvement:*\n\n[Adding and removing agent nodes|https://puppet.com/docs/pe/2019.8/adding_and_removing_nodes.html]\n\n_Current text :_\n On the agent node, run the uninstall script: run /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n_Suggested improvement:_\n\nRun should be removed, its redundant & doesn't lead to a good user experience of copy and pasting the italic.\n On the agent node, run the uninstall script: *run* /opt/puppetlabs/bin/puppet-enterprise-uninstaller\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54240", "fixedVersions": [], "id": "54240", "issueType": "Bug", "key": "DOCUMENT-1211", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c4202e695e00f6a4ec2ab7f", "resolution": "Duplicate", "resolutionDate": "2021-11-09T15:48:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in Adding and removing agent nodes", "timeSpent": "PT0S", "updated": "2021-11-09T15:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a48168d8b9c0068b7e260", "body": "please provide details of the duplicate ticket so I can see the bug fix and confirm the issue is resolved thanks.", "created": "2021-11-10T04:18:00.000000" }, { "author": "623a48168d8b9c0068b7e260", "body": "As all the other duplicates are now closed this is no longer a duplicate but a valid ticket so can it please now be left open and assigned as the issue is still a problem and needs resolving thankyou.", "created": "2021-11-17T15:20:00.000000" }, { "author": "623a48168d8b9c0068b7e260", "body": "Why do you keep closing this as duplicate ? As noted all other duplicated are now closed. This ticket is valid. Please provide either a solution or assign it to someone else who can. Your documentation is still incorrect and adding an alt-dns entry to the cert is an important task. Please do not keep closing this as duplicate without any comment whatsoever...if there is another open duplicate then you must at least reference it thanks.", "created": "2021-11-29T13:54:00.000000" } ], "components": [ "Puppet Server" ], "created": "2021-04-09T05:08:00.000000", "creator": "623a48168d8b9c0068b7e260", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a9f2ccf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cb6w:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_4_*:*_20854229351_*|*_6_*:*_4_*:*_74129497" } ], "description": "*Problem:*\n\n\u00a0\n\nThe steps in the following docs ( which are the same for 7x also ) do not work ( see below for details ) : [https://puppet.com/docs/puppet/6.21/ssl_regenerate_certificates.html#regenerate_agent_certs_and_add_dns_alt_names]\n\nso step 1 is fine...\n{code}# puppetserver ca clean --certname\nsl1-puppet.server.domain.com\nRevoked certificate for sl1-puppet.server.domain.com\nCleaned files related to sl1-puppet.server.domain.com\n{code}\nstep 2 then fails are you have now revoked the cert...\n{code}# puppet ssl clean\nError: Could not run: Failed to connect to the CA to determine if\ncertificate sl1-puppet.server.domain.com has been cleaned\nWrapped exception:\ncertificate verify failed [certificate revoked for\nCN=sl1-puppet.server.domain.com]\n{code}\nstep 3 is fine...\n{code}# puppet resource service puppetserver\nensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n provider => 'systemd',\n}\n{code}\nstep 4 fails as you have stopped the puppetserver ( to stop the CA service ) in the step above...\n{code}# puppetserver ca generate --certname\nsl1-puppet.server.domain.com --subject-alt-names\npuppet,ld4-puppet-lb.server.domain.com --ca-client\nFatal error when running action 'generate'\n Error: Failed connecting to\nhttps://sl1-puppet.server.domain.com:8140/status/v1/simple/ca\n Root cause: 503 \"Service Unavailable\"\n{code}\n*Suggested improvement:*\n\nthis just doesn't seem to make sense...you revoke a cert when it's needed in the next step and then you stop a service when it's needed in the next step. essentially it doesn't work and needs updating thanks.\n\n*Summary:*\n\nplease update the doc so the steps work.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54946", "fixedVersions": [], "id": "54946", "issueType": "Improvement", "key": "DOCUMENT-1210", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a48168d8b9c0068b7e260", "resolution": "Duplicate", "resolutionDate": "2021-12-07T09:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add dns alt names to puppetserver steps incorrect", "timeSpent": "PT0S", "updated": "2021-12-07T09:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a48168d8b9c0068b7e260", "body": "please provide details of the duplicate ticket so I can see the bug fix and confirm the issue is resolved thanks.", "created": "2021-11-10T04:13:00.000000" } ], "components": [], "created": "2021-04-09T05:05:00.000000", "creator": "623a48168d8b9c0068b7e260", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3bae1694" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cb74:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_19156063280_*|*_6_*:*_2_*:*_44634617" } ], "description": "*Problem:*\n\n\u00a0The steps in the following docs ( which are the same for 7x also ) do not work ( see below for details ) : [https://puppet.com/docs/puppet/6.21/ssl_regenerate_certificates.html#regenerate_agent_certs_and_add_dns_alt_names]\n\nso step 1 is fine...\n{code}\n# puppetserver ca clean --certname\nsl1-puppet.server.domain.com\nRevoked certificate for sl1-puppet.server.domain.com\nCleaned files related to sl1-puppet.server.domain.com\n{code}\nstep 2 then fails are you have now revoked the cert...\n{code}\n# puppet ssl clean\nError: Could not run: Failed to connect to the CA to determine if\ncertificate sl1-puppet.server.domain.com has been cleaned\nWrapped exception:\ncertificate verify failed [certificate revoked for\nCN=sl1-puppet.server.domain.com]\n{code}\nstep 3 is fine...\n{code}\n# puppet resource service puppetserver\nensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n provider => 'systemd',\n}\n{code}\nstep 4 fails as you have stopped the puppetserver ( to stop the CA service ) in the step above...\n{code}\n# puppetserver ca generate --certname\nsl1-puppet.server.domain.com --subject-alt-names\npuppet,ld4-puppet-lb.server.domain.com --ca-client\nFatal error when running action 'generate'\n Error: Failed connecting to\nhttps://sl1-puppet.server.domain.com:8140/status/v1/simple/ca\n Root cause: 503 \"Service Unavailable\"\n{code}\n\n*Suggested improvement:*\n\n__\n\n_Current text :_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54899", "fixedVersions": [], "id": "54899", "issueType": "Bug", "key": "DOCUMENT-1209", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a48168d8b9c0068b7e260", "resolution": "Duplicate", "resolutionDate": "2021-11-17T09:36:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add dns alt names to puppetserver steps incorrect", "timeSpent": "PT0S", "updated": "2021-11-17T09:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a48168d8b9c0068b7e260", "body": "please provide details of the duplicate ticket so I can see the bug fix and confirm the issue is resolved thanks.", "created": "2021-11-10T04:17:00.000000" } ], "components": [ "Puppet Server" ], "created": "2021-04-09T05:03:00.000000", "creator": "623a48168d8b9c0068b7e260", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e7e6a47" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0c53c:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_19155850584_*|*_6_*:*_2_*:*_44936224" } ], "description": "*Problem:*\n\nThe steps in the following docs ( which are the same for 7x also ) do not work ( see below for details ) : [https://puppet.com/docs/puppet/6.21/ssl_regenerate_certificates.html#regenerate_agent_certs_and_add_dns_alt_names]\n\nso step 1 is fine...\n{code}\n# puppetserver ca clean --certname\nsl1-puppet.server.domain.com\nRevoked certificate for sl1-puppet.server.domain.com\nCleaned files related to sl1-puppet.server.domain.com\n{code}\nstep 2 then fails are you have now revoked the cert...\n{code}\n# puppet ssl clean\nError: Could not run: Failed to connect to the CA to determine if\ncertificate sl1-puppet.server.domain.com has been cleaned\nWrapped exception:\ncertificate verify failed [certificate revoked for\nCN=sl1-puppet.server.domain.com]\n{code}\nstep 3 is fine...\n{code}\n# puppet resource service puppetserver\nensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n provider => 'systemd',\n}\n{code}\nstep 4 fails as you have stopped the puppetserver ( to stop the CA service ) in the step above...\n{code}\n# puppetserver ca generate --certname\nsl1-puppet.server.domain.com --subject-alt-names\npuppet,ld4-puppet-lb.server.domain.com --ca-client\nFatal error when running action 'generate'\n Error: Failed connecting to\nhttps://sl1-puppet.server.domain.com:8140/status/v1/simple/ca\n Root cause: 503 \"Service Unavailable\"\n{code}\n\n\n\n*Suggested improvement:*\n\nthis just doesn't seem to make sense...you revoke a cert when it's needed in the next step and then you stop a service when it's needed in the next step. essentially it doesn't work and needs updating thanks.\n\n*Summary:*\n\nplease update the doc so the steps work.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54917", "fixedVersions": [], "id": "54917", "issueType": "Bug", "key": "DOCUMENT-1208", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a48168d8b9c0068b7e260", "resolution": "Duplicate", "resolutionDate": "2021-11-17T09:36:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add dns alt names to puppetserver steps incorrect", "timeSpent": "PT0S", "updated": "2021-11-17T09:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "623a48168d8b9c0068b7e260", "body": "please provide details of the duplicate ticket so I can see the bug fix and confirm the issue is resolved thanks.", "created": "2021-11-10T04:17:00.000000" } ], "components": [ "Puppet Server" ], "created": "2021-04-09T05:03:00.000000", "creator": "623a48168d8b9c0068b7e260", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1137fd97" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0cb7c:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_19155935092_*|*_6_*:*_2_*:*_44903553" } ], "description": "*Problem:*\n\nThe steps in the following docs ( which are the same for 7x also ) do not work ( see below for details ) : [https://puppet.com/docs/puppet/6.21/ssl_regenerate_certificates.html#regenerate_agent_certs_and_add_dns_alt_names]\n\nso step 1 is fine...\n{code}\n# puppetserver ca clean --certname\nsl1-puppet.server.domain.com\nRevoked certificate for sl1-puppet.server.domain.com\nCleaned files related to sl1-puppet.server.domain.com\n{code}\nstep 2 then fails are you have now revoked the cert...\n{code}\n# puppet ssl clean\nError: Could not run: Failed to connect to the CA to determine if\ncertificate sl1-puppet.server.domain.com has been cleaned\nWrapped exception:\ncertificate verify failed [certificate revoked for\nCN=sl1-puppet.server.domain.com]\n{code}\nstep 3 is fine...\n{code}\n# puppet resource service puppetserver\nensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n provider => 'systemd',\n}\n{code}\nstep 4 fails as you have stopped the puppetserver ( to stop the CA service ) in the step above...\n{code}\n# puppetserver ca generate --certname\nsl1-puppet.server.domain.com --subject-alt-names\npuppet,ld4-puppet-lb.server.domain.com --ca-client\nFatal error when running action 'generate'\n Error: Failed connecting to\nhttps://sl1-puppet.server.domain.com:8140/status/v1/simple/ca\n Root cause: 503 \"Service Unavailable\"\n{code}\n\n\n\n*Suggested improvement:*\n\nthis just doesn't seem to make sense...you revoke a cert when it's needed in the next step and then you stop a service when it's needed in the next step. essentially it doesn't work and needs updating thanks.\n\n*Summary:*\n\nplease update the doc so the steps work.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54697", "fixedVersions": [], "id": "54697", "issueType": "Bug", "key": "DOCUMENT-1207", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a48168d8b9c0068b7e260", "resolution": "Duplicate", "resolutionDate": "2021-11-17T09:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add dns alt names to puppetserver steps incorrect", "timeSpent": "PT0S", "updated": "2021-11-17T09:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5fc46fd09592df0076141ac0", "attachments": [], "comments": [ { "author": "5fc46fd09592df0076141ac0", "body": "[~accountid:557058:0b2a0f29-3749-4fc3-9772-13ad025585de]\u00a0updated docs in applicable versions and instances:\u00a0\n\n[https://puppet.com/docs/pe/2019.8/code_manager_api.html#error-responses]\n\n\u00a0\n\n\u00a0", "created": "2021-03-25T12:39:00.000000" } ], "components": [], "created": "2021-03-24T13:12:00.000000", "creator": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3720783f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o07fqs:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_80837826_*|*_3_*:*_1_*:*_3565111_*|*_10009_*:*_1_*:*_86463461_*|*_5_*:*_1_*:*_0" } ], "description": "The [error response described in the puppet.com docs|https://puppet.com/docs/pe/2019.8/code_manager_api.html#error-responses] for Code Manager in PE 2019.8.5 says the \"details\" object has a field called \"corrected-env-name\". That was changed in 2019.8.2 to \"corrected-name\" ([https://github.com/puppetlabs/code-manager/commit/a2f653bd26e851c40e80e8c341261691577e4ef1])", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54523", "fixedVersions": [], "id": "54523", "issueType": "Task", "key": "DOCUMENT-1205", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "resolution": "Fixed", "resolutionDate": "2021-03-26T12:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Code manager error response page out-of-date", "timeSpent": "PT0S", "updated": "2021-03-26T12:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:72ecddca-2953-4a83-aa48-73f365fe3150", "created": "2021-03-23T10:49:00.000000", "name": "image002.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14266" } ], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This command was added in 2019.8.5: https://puppet.com/docs/pe/2019.8/release_notes_pe.html#clean-up-old-packages-after-upgrade\n\nAre you using an earlier version? FYI, you can access PDFs of superseded docs in our [GitHub docs archive|https://github.com/puppetlabs/docs-archive/tree/master/pe]. This might be helpful if you're sticking to a pre-2019.8.5 version. ", "created": "2021-03-23T10:34:00.000000" }, { "author": "557058:72ecddca-2953-4a83-aa48-73f365fe3150", "body": "\nHi Melissa,\n\nThanks for the clarity. I missed that in the release notes. We are on 2019.8.4, so will look forward to using command on next upgrade. Seems I could not add a comment to story. Feel free to close it out.\n\n-Kurt\n\n", "created": "2021-03-23T10:49:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks!", "created": "2021-03-23T11:11:00.000000" } ], "components": [ "Upgrader" ], "created": "2021-03-18T05:50:00.000000", "creator": "557058:72ecddca-2953-4a83-aa48-73f365fe3150", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1e9038df" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o078tg:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_447398611_*|*_6_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_3814299" } ], "description": "*Problem:*\n\nStep 7 under Upgrade PE references a command that does not work.\u00a0 See below snippet of the optional command that can be run.\n\n*Optional:*\u00a0Remove old\u00a0PE\u00a0packages from your infrastructure nodes:\u00a0{{puppet {color:#FF0000}infrastructure run remove_old_pe_packages pe_version=current{color}}}\nFor\u00a0{{pe_version}}, you can specify a SHA, a version number, or\u00a0{{current}}. All packages older than the specified version are removed.\n\u00a0\n\n*Suggested improvement:*\n\n__\n\n_Current text :_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54522", "fixedVersions": [], "id": "54522", "issueType": "Bug", "key": "DOCUMENT-1204", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:72ecddca-2953-4a83-aa48-73f365fe3150", "resolution": "Cannot Reproduce", "resolutionDate": "2021-03-23T11:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Remove old PE packages command not working", "timeSpent": "PT0S", "updated": "2021-03-23T11:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This seems pretty straightforward. [~accountid:5b64ddd7d1e8dc2d916c6289], can I just get your +1 on [~accountid:6220db7149c90000701fd082]'s suggested edits here?", "created": "2021-03-26T10:43:00.000000" }, { "author": "5b64ddd7d1e8dc2d916c6289", "body": "(y) Makes sense to me! You'll still want to do the puppet runs noted under Configure Compilers once you set the appropriate settings to point to the correct load balancer, though.", "created": "2021-03-26T11:13:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Here's where we ended up:\nhttps://puppet.com/docs/pe/2021.2/installing_compilers.html#multi-region-load-balancing\n\nI created SUP-2584 to document the Hiera config method in a KB.", "created": "2021-07-23T12:02:00.000000" } ], "components": [], "created": "2021-03-17T17:37:00.000000", "creator": "6220db7149c90000701fd082", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2fa0a27f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08t9d:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "43497" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_491428044_*|*_10009_*:*_1_*:*_153714809_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_2893853_*|*_10006_*:*_1_*:*_10129798357_*|*_10016_*:*_1_*:*_261314597" } ], "description": "*Problem:*\n\nIn our compiler installation docs, we mention multi-region/multi-data-center setups in a few subsections. If you follow these instructions to a tee, you'll end up with all your agent nodes connecting to a single compiler/load balancer (bar the install script) instead of each region's compiler/load balancer. This defeats the purpose of even setting up compilers local to each data-center.\n\n*Suggested improvement:*\n\n__\n [https://puppet.com/docs/pe/2019.8/installing_compilers.html]\n [https://puppet.com/docs/pe/2021.0/installing_compilers.html]\n\n_Current text :_\n\nUnder \"Load balancing for geodiverse locations\":\n{quote}If you have load balancers in multiple data centers, set the pe_repo::compile_master_pool_address in Hiera at the point of locational demarcation. With multiple data locations, specify this value at the lowest point in your hierarchy that still accurately provides appropriate values for each location. For example[...]\n{quote}\nUnder \"Configure compilers\":\n{quote}Important: If you have load balancers in multiple data centers, you must configure compile_master_pool_address using Hiera, instead of using configuration data in the console, as described in this step. Using either of these methods updates the agent install script URL displayed in the console.\n{quote}\n_Suggested improvement:_\n\nIn the \"Load balancing for geodiverse locations\" section, we should include instructions on configuring the {{puppet_enterprise::profile::agent}} class's {{manage_puppet_conf}}, {{pcp_broker_list}}, {{master_uris}}, {{server_list}} parameters per-region in hieradata.\n\nIn the first \"Important\" notice box under \"Configure compilers\", mention the above parameters in addition to {{compile_master_pool_address}}, and recommend skipping the entire \"Configure compilers\" section's steps.\n\n*Summary:*\n\nIn multi-region scenarios, the steps we provide will configure agent nodes to connect to a single load balancer/compiler (bar grabbing the install script). This needs to be changed, else we're negating the purpose of multi-region compilers/load balancers.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54319", "fixedVersions": [], "id": "54319", "issueType": "Improvement", "key": "DOCUMENT-1203", "labels": [ "jira_escalated", "medium", "melissa", "pe", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "resolution": "Fixed", "resolutionDate": "2021-07-23T12:03:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Missing Parameters in Multi-Region Compiler Install Steps", "timeSpent": "PT0S", "updated": "2021-07-23T12:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [ { "attacher": "5e83be09467ac20c1d7fda2a", "created": "2021-04-07T08:22:00.000000", "name": "Screen Shot 2021-04-07 at 9.21.07 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14267" } ], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:5e83be09467ac20c1d7fda2a] Would it be acceptable/preferable if only the endpoint itself (e.g., POST /command/task) was listed in the page table-of-contents, and was clickable/linkable? Or do you want to be able to link specifically to e.g., POST /command/task request format?\n\nI ask because we have two options for fixing this:\n1. Add XML section IDs to each duplicate heading on this page. \n2. Make each H3 a bolded

        , thereby simplifying the page TOC", "created": "2021-03-15T15:49:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Oh, I just re-read the ticket description, and saw that this was noted by a user, so maybe you don't have a preference [~accountid:5e83be09467ac20c1d7fda2a]. If not, we'll make a call based on consistency and maintainability.", "created": "2021-03-15T15:53:00.000000" }, { "author": "5e83be09467ac20c1d7fda2a", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] I have no preference, other than whatever links that are in our docs take us to the correct place.\n\nIf you're on the community slack, I'd be happy to bring you into the thread with the reporting user to get their direct feedback.", "created": "2021-03-15T16:00:00.000000" }, { "author": "5e83be09467ac20c1d7fda2a", "body": "Huh. That reads a bit snarky in retrospect. Wasn't intended that way. Have no preference, am sure whatever ya'all choose will be fine, and the offer to connect you back to \"tommy\" is still open.", "created": "2021-03-15T16:09:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "I didn't take it as snarky", "created": "2021-03-15T16:15:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64], let's go with option 1.", "created": "2021-03-15T17:43:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:5e83be09467ac20c1d7fda2a]\u00a0I fixed the subsection links in the command endpoint. [https://puppet.com/docs/pe/2019.8/orchestrator_api_commands_endpoint.html]\u00a0\n\n\u00a0\n\nLet me know if this looks good to go from your end.", "created": "2021-04-06T10:53:00.000000" }, { "author": "5e83be09467ac20c1d7fda2a", "body": "Opened the link and spot checked, and looks like they work. The_ POST /command/task_target_ heading shows up in the left column, where all of it's sub-headings is in the right column, when I view it with brave browser on my mac. Saw the same formatting issue on the 2021 site. Also the 2021 version still has the broken links. We do have a few customers on 2021, so would be good to get those updated as well. Attached a screen shot to show the odd column alignment.", "created": "2021-04-07T08:24:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:5e83be09467ac20c1d7fda2a]\u00a0I've bumped the changes to 2021.0 as well, so those should be viewable within the next hour.\u00a0\n\nThe issue with the TOC columns breaking up sections is a web issue", "created": "2021-04-07T10:21:00.000000" } ], "components": [], "created": "2021-03-15T09:49:00.000000", "creator": "5e83be09467ac20c1d7fda2a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@593c1b7f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzi6nw:y" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_21620612_*|*_3_*:*_1_*:*_100140657_*|*_10009_*:*_1_*:*_159032533_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_6807916_*|*_10006_*:*_1_*:*_1786022726" } ], "description": "User \"tommy\" on the puppet community slack posted this :\n\n\"Minor doc bug: the links to sub-sections (request-format, response-format)) can only reach the first section on: https://puppet.com/docs/pe/2019.8/orchestrator_api_commands_endpoint.html\n... not really critical, not sure where to fix that\n\nWhen I click on something like \"Request format\" under POST /command/task, it takes me to the request format for /comand/deploy (the first one)\"\n\nUsing Vivaldi on Mac OS X. I verified the same behavior on Brave, Safari, and Firefox on OSX.\n\nSame behavior on the 2021 version of the docs (https://puppet.com/docs/pe/2021.0/orchestrator_api_commands_endpoint.html)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54413", "fixedVersions": [], "id": "54413", "issueType": "Bug", "key": "DOCUMENT-1201", "labels": [ "logan", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5e83be09467ac20c1d7fda2a", "resolution": "Fixed", "resolutionDate": "2021-04-08T09:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Sub-Section Links working incorrectly", "timeSpent": "PT0S", "updated": "2021-04-08T09:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5f35c4af8d89e300463337a9", "body": "We aren't actively supporting the release 6 docs anymore. Closing this issue.", "created": "2023-07-18T07:02:00.000000" } ], "components": [], "created": "2021-03-15T05:23:00.000000", "creator": "623c106c1c7f6a007049e7a8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2e35f73" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o075yc:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Jul/23" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_79417657_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_68530524298_*|*_10005_*:*_1_*:*_5267993614" } ], "description": "https://puppet.com/docs/puppet/6.21/install_agents.htm\n\nPuppet 6 Agent install documentation has had it language changed, the property for Windows MSIEXEC install that controls the hostname of the puppet server is\u00a0PUPPET_SERVER in the documentation, but in the Puppet 6 installer it is actually still PUPPET_MASTER_SERVER", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55140", "fixedVersions": [], "id": "55140", "issueType": "Bug", "key": "DOCUMENT-1200", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c106c1c7f6a007049e7a8", "resolution": "Won't Do", "resolutionDate": "2023-07-18T07:02:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "18/Jul/23 7:02 AM", "summary": "Puppet 6 Agent Windows MSIEXEC install property problem ", "timeSpent": "PT0S", "updated": "2023-07-18T07:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "5d9f43aac62f840db2b6ee35", "body": "Fixed link", "created": "2021-03-16T03:33:00.000000" } ], "components": [], "created": "2021-03-09T06:39:00.000000", "creator": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4b0efaa2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o072a0:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_12472956_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_577571798" } ], "description": "*Problem:*\n\n\u00a0In clicking to obtain the Mac client from the documentation, the URL is malformed.\n\nPage found:\n\nhttps://puppet.com/docs/puppet/7.4/install_agents.html#install_mac_agents\n\nAnchor section:\n\n[https://puppet.com/docs/puppet/7.4/install_agents.html#install-macos-agents-from-the-command-line-osp]\n\n\u00a0\n\n\"Download\" link:\n\nlink content: \u00a0http://http//downloads.puppet.com/mac/puppet7//mac/puppet6/\n\n*Suggested improvement:*\n\n_Unknown the actual URL_\n\n\u00a0\n\n_Current text :_\n\n_It's a 404..._\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary:*\n\n\u00a0\n\n*Point to the appropriate location*\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54103", "fixedVersions": [], "id": "54103", "issueType": "Bug", "key": "DOCUMENT-1198", "labels": [ "link", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "resolution": "Fixed", "resolutionDate": "2021-03-16T03:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Download link for Mac agent broken", "timeSpent": "PT0S", "updated": "2021-03-16T03:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5fc46fd09592df0076141ac0", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks [~accountid:5e83be09467ac20c1d7fda2a].\n\nMarking this need info:\n* What are these 3 ports used for? Seems like 22 is SSH, 443 is HTTP (to the console?), and 80 is HTTPS (again, to the console?)(We already document 443 for console traffic", "created": "2021-03-12T12:40:00.000000" }, { "author": "5e83be09467ac20c1d7fda2a", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] 443 is https and 80 is http. This is not console or CLI access from users, but puppetserver code deploys. This is for code manager pulling down code from git, and it will be one of the three, not all of the three, with 80 - unsecured http - being a really bad idea and hopefully somebody nobody ever does but technically something that will work and be supported. The linked slack conversation covers the need.\n", "created": "2021-03-12T12:53:00.000000" }, { "author": "5e83be09467ac20c1d7fda2a", "body": "We want to make sure it's documented so users have all of the information they need for firewall/network configuration supporting the puppet enterprise infrastructure.", "created": "2021-03-12T12:54:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Let's combine this with graphics updates for DOCUMENT-1193 when you're ready [~accountid:5fc46fd09592df0076141ac0].", "created": "2021-04-19T14:01:00.000000" }, { "author": "5fc46fd09592df0076141ac0", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] - Blocked because of the questions I have in this doc (can clarify in tmr's PE sync if preferred):\u00a0[https://docs.google.com/document/d/1uNc6qDJavUws_vBX55n_uSZ2edHrYYo8cjkNw4C7XuI/edit?usp=sharing]\n\n\u00a0", "created": "2021-05-24T20:03:00.000000" }, { "author": "5fc46fd09592df0076141ac0", "body": "[~accountid:557058:c241032a-c552-4408-9a96-dcd5a643ff69]\u00a0- Can you review my questions about r10k's ports on page 2 of this google doc? This ticket might require additional new docs depending on your answers:\u00a0\n\n[https://docs.google.com/document/d/1uNc6qDJavUws_vBX55n_uSZ2edHrYYo8cjkNw4C7XuI/edit?usp=sharing]\n\n\u00a0", "created": "2021-06-03T14:42:00.000000" } ], "components": [], "created": "2021-03-08T10:57:00.000000", "creator": "5e83be09467ac20c1d7fda2a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@34c62993" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzi6nw:y9" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Mar/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_82073054_*|*_3_*:*_5_*:*_3038156101_*|*_10009_*:*_1_*:*_288022099_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_4_*:*_1618619244_*|*_10006_*:*_2_*:*_3185868285_*|*_10016_*:*_1_*:*_269704792" } ], "description": "Puppet Enterprise requires access from the Primary Server to Git on port 22 OR 443 OR 80 (in that order of preference) to sync code from git to the Primary PE Server. The documentation for PE for both 2021 and 2019.8.5 only list port 8170 traffic from Git to the Primary Server. All architectures will require that connectivity.\n\nhttps://puppet.com/docs/pe/2021.0/system_configuration.html\nhttps://puppet.com/docs/pe/2019.8/system_configuration.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54945", "fixedVersions": [], "id": "54945", "issueType": "Bug", "key": "DOCUMENT-1197", "labels": [ "christine", "graphics", "medium", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5e83be09467ac20c1d7fda2a", "resolution": "Fixed", "resolutionDate": "2021-06-14T16:11:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppetserver requires 22|443|80 connectivity to git", "timeSpent": "PT0S", "updated": "2021-06-23T11:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64], would you mind fixing this one? Likely applies to latest too. ", "created": "2021-02-26T12:24:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I updated \"primary server\" to \"main\" in 2021 an 2019.8. Changes will be live shortly.\u00a0", "created": "2021-02-26T14:04:00.000000" } ], "components": [ "PE" ], "created": "2021-02-26T10:16:00.000000", "creator": "557058:1d4e4cdc-2682-4316-8679-3265082b7fc5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@550acc57" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o06udc:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_7748789_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5889464" } ], "description": "There appears to be a typo in [https://puppet.com/docs/pe/2019.8/known_issues_pe.html#known_issues_pe]\n\nIt looks like someone did a search and replace of master for primary server. I think the items highlighted in red should still say master.\nh3. Code Manager and r10k do not identify the default branch for module repositories\n\nWhen you use Code Manager or r10k to deploy modules from a Git source, the default branch of the source repository is always assumed to be {color:#FF0000}primary server.{color} If the module repository uses a default branch that is _not_ {color:#FF0000}primary server{color}, an error occurs. To work around this issue, specify the default branch with the {{ref:}} key in your Puppetfile.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54589", "fixedVersions": [], "id": "54589", "issueType": "Bug", "key": "DOCUMENT-1195", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1d4e4cdc-2682-4316-8679-3265082b7fc5", "resolution": "Fixed", "resolutionDate": "2021-02-26T14:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in PE known issues page", "timeSpent": "PT0S", "updated": "2021-06-29T12:44:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "created": "2021-03-26T10:38:00.000000", "name": "firewall_large.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14203" }, { "attacher": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "created": "2021-03-26T10:38:00.000000", "name": "firewall_xl.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14219" } ], "comments": [ { "author": "5b64ddd7d1e8dc2d916c6289", "body": "Agree with everything Jarret said. -Additionally, I'm not entirely sure about all of the arrows that are unidirectional. Some may need to be bidirectional.- Nevermind, I think they are okay. Although 8143 is bidirectional on XL and unidirectional on Large.", "created": "2021-04-12T16:11:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "The graphics were updated a while ago. I just updated the DR firewall requirements to state that your replica must comply with the same port requirements as your primary to ensure that the replica can act as the primary during a failover. \n\nThe only remaining work on this ticket is to update the DR classification per [this spreadsheet|https://docs.google.com/spreadsheets/d/1xikBaHAZ4t7yhGPHilL452B_SQtTXXiZBiQYz87kqL8/edit?usp=sharing].", "created": "2021-08-06T16:17:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:5b64ddd7d1e8dc2d916c6289] Here's a draft of the updated DR parameter table:\nhttps://puppet-docs-preview.netlify.app/docs/pe/latest-preview/dr_overview.html#dr-classification-changes\n\nI don't like how this displays on a small screen, so I'm going to change the format. But, if you have a biggie monitor, you might tackle a tech review in the meantime?", "created": "2021-08-09T13:17:00.000000" }, { "author": "5b64ddd7d1e8dc2d916c6289", "body": "Looks great! Possibly consider removing {{agent-server-urls}} from the parameter name since it's not a real parameter name, but I see the note on the right column noting what it means.", "created": "2021-08-09T13:34:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is done and merged to 2019.8 and 2021.", "created": "2021-08-10T15:50:00.000000" } ], "components": [], "created": "2021-02-17T11:07:00.000000", "creator": "623e78d38d8b9c0068b9f43e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@46caf481" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08t9c:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "42925" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_515383820_*|*_10007_*:*_1_*:*_90621671_*|*_3_*:*_1_*:*_13606906_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_2956425235_*|*_10006_*:*_2_*:*_11459694091_*|*_10016_*:*_1_*:*_11271830" } ], "description": "When deploying a replica, the `puppet infrastructure provision replica` command runs `reinitialize_replica` on the replica, which queries node groups from the classifier. This is done over port 4433.\n\nPort 4433 needs to be shown on the charts for Large and Extra Large installations between the primary and replica on the following page: https://puppet.com/docs/pe/2019.8/system_configuration.html\n\nPorts 8081, 8170, and 4433 also need to be listed in the \"firewall\" subsection of the \"System requirements\" section of the following page: https://puppet.com/docs/pe/2019.8/dr_overview.html\n\nWithin that subsection, the bulleted descriptions for those port requirements can largely be pulled from the System Configuration docs page.\n\n~* Please see Zendesk Support tab for further comments and attachments.~", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54411", "fixedVersions": [], "id": "54411", "issueType": "Bug", "key": "DOCUMENT-1193", "labels": [ "graphics", "jira_escalated", "medium", "melissa", "pe", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "resolution": "Fixed", "resolutionDate": "2021-08-10T15:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Verify DR requirements and classification", "timeSpent": "PT0S", "updated": "2021-08-10T15:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "This should be fixed now. Sorry about that! ", "created": "2021-02-10T17:10:00.000000" } ], "components": [], "created": "2021-02-10T12:01:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50ed75fb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o06i54:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_18587192_*|*_5_*:*_1_*:*_0" } ], "description": "Today almost all of my google searches have had many broken links. For exaple the following search: https://www.google.co.uk/search?q=puppet+external+facts\n\nGives me this as the top result: https://puppet.com/docs/puppet/7.3/external_facts.html which is broken", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54943", "fixedVersions": [], "id": "54943", "issueType": "Bug", "key": "DOCUMENT-1192", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Fixed", "resolutionDate": "2021-02-10T17:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Almost all google links are broken", "timeSpent": "PT0S", "updated": "2021-02-10T17:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:63d40628f6e1b543161789a7]\u00a0Which type was replaced by cron?\n\nI didn't think\u00a0core types included\u00a0supported types, is that right? Thanks!", "created": "2021-02-17T07:57:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "{quote}core types included supported types, is that right{quote}\n\nThat's my understand based on what we have on the website. Core types are those in the puppet repo:\u00a0[https://puppet.com/docs/puppet/7.4/types/index.html#list-of-resource-types]\n\nSupported types include things like cron, etc\u00a0[https://puppet.com/docs/puppet/7.4/types/index.html#supported-type-modules-in-puppet-agent]\n\nBut it seems confusing to me to say cron isn't a core type, because it has core in the name: [https://forge.puppet.com/modules/puppetlabs/cron_core]\n\nIt might be clear to refer to \"builtin\" vs \"core\" types. Builtin types are things in the puppet repo (what we're calling core now). And core types are things that exist in the puppet-agent package.", "created": "2021-02-26T10:44:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I've removed cron and renamed the 'core' types in the Puppet repo to 'built-in': [https://puppet.com/docs/puppet/7.6/cheatsheet_core_types.html.]\u00a0", "created": "2021-04-28T02:38:00.000000" } ], "components": [], "created": "2021-02-10T03:17:00.000000", "creator": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@31cae914" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzi6nw:w" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_538299219_*|*_10007_*:*_1_*:*_83273824_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_4917439173_*|*_10005_*:*_2_*:*_1107843763" } ], "description": "As of puppet 6.0.0 the cron type as well as other built in types where [removed from puppet|https://github.com/puppetlabs/puppet/commit/0baf9ba68d3192655136f91078542109665f6fba] and and migrated to [puppet forge modules|https://forge.puppet.com/modules/puppetlabs/cron_core]. however the core-type cheat sheet still [references cron as a core type|https://puppet.com/docs/puppet/7.4/cheatsheet_core_types.html#cron].\n\nThis seems like a bug in the documentation and cron here should be replaced with a one of the types [located in the core Puppet code base. | https://github.com/puppetlabs/puppet/tree/main/lib/puppet/type].\n\nI have made an assumption here that core types is suppose to refer to the types available in the puppet core code base as is suggested [on the types page|https://puppet.com/docs/puppet/7.4/types/index.html#puppet-core-types]. however the types page dose not explicitly list the core types (i can raise a seperate bug for this if desired). \n\nI would like to explicitly clarify that the definition of a *core types* refers to types defined in the [puppet source code|https://github.com/puppetlabs/puppet] and *dose not* include [supported types |https://puppet.com/docs/puppet/6.0/type.html#supported-type-modules-in-puppet-agent] i.e. those *not* available in the puppet core code but vendored by the puppetlabs `puppet-agent` package.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54101", "fixedVersions": [], "id": "54101", "issueType": "Bug", "key": "DOCUMENT-1191", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "resolution": "Fixed", "resolutionDate": "2021-04-28T02:38:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "cron type refrences as a core type", "timeSpent": "PT0S", "updated": "2021-04-28T02:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] Docs recommend setting {{mcollective}} to {{absent}} _before_ upgrading to 2019.x (i.e., while you're still on 2018.1.z), so I don't see the conflict? If you've somehow managed to upgrade to 2019.x without removing MCo and heeding warnings in the installer, then I think the existing KB is the right place for remediation steps. ", "created": "2021-02-08T09:18:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0that is not clear from the instructions on the docs page: [https://puppet.com/docs/pe/2019.8/upgrading_pe.html#removing_mco]\n\nIt indicates the customer has to do something to complete the MCollective removal after upgrading to 2019.8 (as the docs are for 2019.8), but the procedure is only valid for 2018.1. And it omits the procedure for removing the pe-mcollective-metadata cron job that remains on upgraded nodes.", "created": "2021-02-08T09:34:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Yeah, fair point. The topic you linked to above was meant to be understood in the context of the previous topic, MCollective removal in PE 2019.0, which provided more context and linked to the Removing MCo steps. I agree that's a bit much to ask of readers, so I just incorporated the steps for removing MCo into the main topic, and added some more version-specific signposting. Please see if [this revision|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#mcollective-removal] makes things clearer. \n\nRegarding the cron job, I think this falls in the category of stuff-that-gets-removed-only-after-upgrading-to-2019.y?\n{quote}\nYou must complete the upgrade to 2019.0 or later to completely remove MCollective from agents.\n{quote}", "created": "2021-02-09T11:10:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0thanks that looks a lot clearer. The cron job doesn't get removed from existing agents that had MCollective on them before, so there is this cleanup step the customer needs to do.\n\nPersonally I think it would be better if we ask product to add this cleanup into the next PE update, as it's something we should take care of anyway.", "created": "2021-02-10T05:39:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Cool, I'm going to mark this resolved and let you file a PE ticket about cleaning up the cron job if you like, [~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c]. Thanks for your help polishing this section. ", "created": "2021-02-11T12:22:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "I've created\u00a0PE-31165 for the cleanup of the cron job", "created": "2021-02-12T06:18:00.000000" } ], "components": [ "MCollective" ], "created": "2021-02-05T10:58:00.000000", "creator": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@734c13fc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0568u:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_253161114_*|*_10009_*:*_1_*:*_177093393_*|*_5_*:*_1_*:*_0_*|*_10016_*:*_1_*:*_93175948" } ], "description": "The 2019.x docs still have the same \"Removing MCollective\" procedure as the 2018.x docs. However that procedure is no longer valid in 2019.x, as the mentioned Hiera parameter has been removed.\n\nInstead there is a [KB article|https://support.puppet.com/hc/en-us/articles/115004858473-Disable-the-scheduled-refresh-mcollective-metadata-task-on-agent-nodes-in-Puppet-Enterprise] that lists a cleanup action that should be performed on nodes that were previously upgraded from 5.x. So it would be useful to replace the old info with the piece from the KB article.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54941", "fixedVersions": [], "id": "54941", "issueType": "Bug", "key": "DOCUMENT-1190", "labels": [ "pe", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "resolution": "Fixed", "resolutionDate": "2021-02-11T12:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Correct MCollective cleanup information for PE 2019.x and above", "timeSpent": "PT0S", "updated": "2021-02-12T06:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Hi Twizzy, sorry for the confusion. We've incorporated the server docs into the Puppet platform docs. You can find the release notes at https://puppet.com/docs/puppet/6.20/server/release_notes.html \n\nThe docs at https://puppet.com/docs/puppetserver/6.12.2/release_notes.html shouldn't be showing up at all. I'll get those removed and put a redirect in place", "created": "2021-02-04T15:21:00.000000" }, { "author": "623c11f9a2f6400069eb7b1e", "body": "Hi Heston,\n\nthanks for getting back :) I guess I'm also a bit to blame here, as I simply cloned an internal ticket at our JIRA and replaced the version number based on the github tag in the URL. Based on your feedback, I assume that those should've thrown a 404 or a redirect to the URL you linked to.\n\nThanks for clearing up the confusion!\n\nHave a nice day & keep up your head during all this mess of a pandemic!\nThomas", "created": "2021-02-04T15:52:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "I've removed the old version of puppetserver and redirected to the new location. Thanks for letting us know about this one and stay safe out there! ", "created": "2021-02-05T10:31:00.000000" } ], "components": [], "created": "2021-02-01T12:11:00.000000", "creator": "623c11f9a2f6400069eb7b1e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@817ef33" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o06aig:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_78989859_*|*_3_*:*_1_*:*_68948195_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_191564498_*|*_10005_*:*_1_*:*_106956" } ], "description": "Hi folks,\n\nI was wondering whether the generation of changelogs is automated, the reason being that as of now:\n\n* the changelogs for the [6.15.0 Puppetserver|https://puppet.com/docs/puppetserver/6.12.2/release_notes.html] are at *6.12.2* and the packages for *6.15.0* are already available since roughly Januar 20th\n\nAlready had a similar issue before, with puppetdb, though: DOCUMENT-1129\n\nHope this can be solved.\n\nCheers & Thanks in advance\nThomas", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55139", "fixedVersions": [], "id": "55139", "issueType": "Bug", "key": "DOCUMENT-1189", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c11f9a2f6400069eb7b1e", "resolution": "Fixed", "resolutionDate": "2021-02-05T10:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Release notes not always on par with available packages", "timeSpent": "PT0S", "updated": "2021-02-05T10:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8] can you confirm whether port 8143 is used in standard architectures with all infra components installed on the primary server? ", "created": "2021-02-01T12:15:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Per the Slack convo [here|https://puppet.slack.com/archives/CGJ0GTF4Y/p1614117425224200], port 8143 is not needed in standard installations, where all the infrastructure components are installed on the primary server. In that configuration, the PCP-8143 comms all happen internally on the primary. The only case where you'd need 8143 is if you're using PE client tools from a node other than the primary, and that port requirement is documented [here|https://puppet.com/docs/pe/2019.8/installing_pe_client_tools.html#install_pe_client_tools_on_an_unmanaged_nix_workstation]. Closing this ticket. ", "created": "2021-02-23T15:53:00.000000" } ], "components": [], "created": "2021-01-29T08:55:00.000000", "creator": "5b29440b088822535508e534", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6e7339a0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03lht:ii" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_271192867_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1913879456" } ], "description": "Hi,\n\nThe \"Standard\" Firewall configuration is missing port 8143, which is present in the firewall configurations for \"Large\" and \"Extra Large\".\u00a0\n\nhttps://puppet.com/docs/pe/2019.8/system_configuration.html\n|8143| * Orchestrator uses this port to accept connections from\u00a0Puppet Communications Protocol\u00a0brokers to relay communications. The orchestrator client also uses this port to communicate with the orchestration services running on the primary server. If you install the orchestrator client on a workstation, port 8143 on the primary server must be accessible from the workstation.\n * Classifier group:\u00a0PE Orchestrator|\n\nPlease add this port definition in the \"Standard\" firewall table.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54939", "fixedVersions": [], "id": "54939", "issueType": "Bug", "key": "DOCUMENT-1186", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b29440b088822535508e534", "resolution": "Won't Do", "resolutionDate": "2021-02-23T15:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Port 8143 requirement missing from \"Standard\" Architecture Firewall configuration", "timeSpent": "PT0S", "updated": "2021-02-23T15:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [ { "attacher": "5b29440b088822535508e534", "created": "2021-03-01T15:19:00.000000", "name": "env_group.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14228" }, { "attacher": "5b29440b088822535508e534", "created": "2021-03-01T15:17:00.000000", "name": "one_env_group.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14218" } ], "comments": [ { "author": "5b29440b088822535508e534", "body": "I want to add this extra Group related best practices that I just found in an old PSE report:\n * Environment group should not have any classes defined in it. all the code that a node gets is in the source code i.e the GIT-branch mapped to the environment has all the code for that node.\n * Classification groups\u00a0keep the following principles in mind:\n ** Each node should belong to one classification group only\n ** Each classification group should set at most one class, a role\n ** Classification group rules should be based primarily on the pp_role trusted fact\n ** The total number of classification groups used should be kept to a minimum\n ** Use a root group to hold all classification groups and structure its children based on team\n ** or purpose\n ** Avoid using abbreviations and acronyms in group names\n\n\u00a0\n\n\u00a0", "created": "2021-02-02T11:49:00.000000" }, { "author": "5b29440b088822535508e534", "body": "yes, there is some conflicting advice that I have received.\u00a0 We can simplify it for now:\n # A node can belong to only one Puppet-Environment group. !one_env_group.png!\n # Now we need to be clear at the beginning of the help page that you create an \"Environment Group\"\u00a0\u00a0when you create a new Node Group &\u00a0 you need to check the check box. Note that you create an \"Environment Group\", +only when there is a GIT branch with same name+. For example, we have a \"Production\" env group because there is a GIT branch called 'production'.\u00a0\u00a0 !env_group.png!\n # We need to add a link to the KB Article I posted about the \"Classification Error\". It is very very common issue that newbies get.\n\nWhat I mention here is not related to 'pp_role'. that is a different topic.\n\n\u00a0\n\n\u00a0\n\n\u00a0\n\n\u00a0\n\n\u00a0", "created": "2021-03-01T15:24:00.000000" }, { "author": "5b29440b088822535508e534", "body": "Looks good Logan! Please close this ticket.\n\nBTW, I am doing some more experiments on the node classification and will file another doc ticket if I have something useful to share. \n\nThanks!\n", "created": "2021-04-19T19:38:00.000000" } ], "components": [], "created": "2021-01-28T12:17:00.000000", "creator": "5b29440b088822535508e534", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@51bd327" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03lht:ib" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_345588765_*|*_3_*:*_2_*:*_272753157_*|*_10009_*:*_1_*:*_1018403261_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_2222917956_*|*_10006_*:*_2_*:*_3205467240_*|*_10005_*:*_1_*:*_3112994" } ], "description": "Hi,\n\nPE Customers, esp new users, need to understand this section really well:\n\n[https://puppet.com/docs/pe/2019.8/grouping_and_classifying_nodes.html#creating_node_groups]\n\nThe policy around node groups that any node can belong to is the following:\n\n---\n \"A node can be part of many node groups, a mix of [environment and classification node groups|https://puppet.com/docs/pe/2019.8/grouping_and_classifying_nodes.html#creating_node_groups].\n\nHowever, among those node groups, there can be only one (puppet-)environment group, which declares the (puppet-)environment a node checks into.\n\nA \"Puppet-Environment Group\" is mapped directly to a git branch of the Control repo (i.e: a preprod environment group matches the preprod branch of the control repo). In the case of a node being assigned to more than 1 environment group, would result in a \"Classfication Conflict\" Error message during the Puppet agent run.\n\nYou can find KB articles that discuss this issue here: \"https://support.puppet.com/hc/en-us/search?utf8=%E2%9C%93&query=classification+conflict\"\n----\n\u00a0\n\nThanks!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55138", "fixedVersions": [], "id": "55138", "issueType": "Improvement", "key": "DOCUMENT-1185", "labels": [ "logan", "medium", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b29440b088822535508e534", "resolution": "Done", "resolutionDate": "2021-04-20T08:41:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "More info about a node can belong to only one Puppet-Environment Group ", "timeSpent": "PT0S", "updated": "2021-04-20T08:41:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "Puppet strings can either be barewords, single or double quoted, or heredocs. https://puppet.com/docs/puppet/7.3/lang_data_string.html\n\nResource parameter values are often shown as bare words, such as ensuring a service is running, https://puppet.com/docs/puppet/7.3/lang_data_string.html#lang_data_string_bare_words\n\nA bare word has several restrictions (must begin with a lower case letter, can't be reserved, can only contain A-Z, a-z, 0-9, '-', _'). \n\nSo I would suggest only using barewords in cases where the type's parameter supports an enumerated list of allowed values, which are all valid bare words.\n\nAlso some resource types like the file {{owner}} accept either a string \"0\" or integer 0. In that case either work.\n\nOtherwise quote the value.", "created": "2021-02-04T13:25:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "The information requested here - as Josh shows in his comment - is all in the docs. The problem is that the {{ensure}} attribute takes different value string types depending on the values permitted in the resource type it is used with.\n\nThe values for the {{ensure}} attribute in examples on the page posted by the reporter are not inconsistent. They are correct for the resource types used. The issue here is I suppose is that in order to understand the examples in the style guide, the user already has to be familiar with each resource type, its attributes and their permitted values.\n\nI think it would be difficult, and probably even more confusing, to try and compare/contrast permitted values for attributes like {{ensure}} that are shared by different resource types.", "created": "2021-03-03T02:33:00.000000" } ], "components": [ "Style Guide & Usage" ], "created": "2021-01-27T02:57:00.000000", "creator": "557058:caae9c58-399c-4716-be37-c404839c368a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c6010d0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o06wam:r" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14475488_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_2249969096_*|*_10005_*:*_1_*:*_758116540" } ], "description": "The Style Guide is inconsistent in whether or not the value for the ensure param is quoted. It has some examples showing it non quoted and some showing it in single quotes.\n\nThere is also no statement about whether or not this should be quoted.\n\n\u00a0\n\nThe specific page is\u00a0https://puppet.com/docs/puppet/7.3/style_guide.html#style_guide_resources", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54696", "fixedVersions": [], "id": "54696", "issueType": "Bug", "key": "DOCUMENT-1183", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:caae9c58-399c-4716-be37-c404839c368a", "resolution": "Won't Fix", "resolutionDate": "2021-03-03T02:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Quoting of ensure value inconsistent in style guide.", "timeSpent": "PT0S", "updated": "2021-03-03T02:33:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "623c1489a1d81f0069d8e30a", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1]\u00a0I looked over the Facter docs pages and updated all examples.\n\n\u00a0\n\nThe new syntax that is preferred for Ruby 1.9 + is\n{code}confine fact_name: 'fact_value'\n{code}\nthe old syntax was\n{code}confine :fact_name => 'fact_value'\n{code}\n\u00a0\n\n[https://puppet.com/docs/puppet/7.3/custom_facts.html#confining-facts]\n\nOLD\n{code}Facter.add(:powerstates) do\n confine :kernel => 'Linux'\n setcode do\n Facter::Core::Execution.execute('cat /sys/power/states')\n end\nend\n{code}\nNEW\n{code}Facter.add(:powerstates) do\n confine kernel: 'Linux'\n setcode do\n Facter::Core::Execution.execute('cat /sys/power/states')\n end\nend\n{code}\n\u00a0\n\nThe example does not work (it does not work on Facter 3 or Facter 4), should be removed\n{code}confine Facter.value(:os)['family'] => 'RedHat'\n{code}\n\u00a0\n\n[https://puppet.com/docs/puppet/7.3/fact_overview.html]\n\nOLD\n{code}Good:\n\nFacter.add('phi') do\n confine :owner => \"BTO\"\n confine :kernel do |value|\n value == \"Linux\"\n end\n \n setcode do\n bar=Facter.value('theta')\n bar + 1\n end\nend\n{code}\nNEW\n{code}Good:\n\nFacter.add('phi') do\n confine owner: \"BTO\"\n confine :kernel do |value|\n value == \"Linux\"\n end\n \n setcode do\n bar=Facter.value('theta')\n bar + 1\n end\nend\n{code}\nOLD\n{code}Bad:\n\nFacter.add('phi') do\n confine :owner => \"BTO\"\n confine :kernel do |value|\n value == \"Linux\"\n end\n \n bar = Facter.value('theta')\n \n setcode do\n bar + 1\n end\nend\n{code}\nNEW\n{code}Bad:\nFacter.add('phi') do\n confine owner: \"BTO\"\n confine :kernel do |value|\n value == \"Linux\"\n end\n \n bar = Facter.value('theta')\n \n setcode do\n bar + 1\n end\nend\n{code}\nOLD\n{code}Facter.add(:rubypath) do\n confine :osfamily => \"Windows\"\n # Windows uses 'where' instead of 'which'\n setcode 'where ruby'\nend\n{code}\nNEW\n{code}Facter.add(:rubypath) do\n confine osfamily: \"Windows\"\n # Windows uses 'where' instead of 'which'\n setcode 'where ruby'\nend\n{code}", "created": "2021-01-28T06:19:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Updated code sampels implemented.", "created": "2021-01-28T09:59:00.000000" } ], "components": [], "created": "2021-01-25T09:29:00.000000", "creator": "557058:1b20a5d2-cb4e-4afc-acf2-fe8bdb8c7919", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2e21d771" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o064iw:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_88505044_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_11239260_*|*_10005_*:*_1_*:*_161248232" } ], "description": "On various pages for facter that give ruby examples for custom facts and confining to specific OS.\u00a0 The Ruby syntax is old and will conflict with PDK\n\nExample here:\u00a0https://puppet.com/docs/puppet/7.3/custom_facts.html#confining-facts due to the fact that the default rubocop set prefers Ruby 1.9+ hash syntax.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55038", "fixedVersions": [], "id": "55038", "issueType": "Bug", "key": "DOCUMENT-1182", "labels": [ "facter", "puppet", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1b20a5d2-cb4e-4afc-acf2-fe8bdb8c7919", "resolution": "Done", "resolutionDate": "2021-01-28T09:59:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update custom ruby fact examples for confinement - example conflicts with current PDK", "timeSpent": "PT0S", "updated": "2021-01-28T09:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "The first instance of \"master\" on this page represents a variable and should indeed be changed to .\n\nThe second and third instances refer to the {{master}} section of the {{puppet.conf}} file, which hasn't changed. ", "created": "2021-01-13T15:41:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "This has been fixed in the appropriate place.\u00a0 We will update the puppet.conf section when/if the name changes in the future.", "created": "2021-01-21T10:53:00.000000" } ], "components": [], "created": "2021-01-12T21:32:00.000000", "creator": "5b29440b088822535508e534", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@27918002" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05bny:r" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_65322169_*|*_3_*:*_1_*:*_73423154_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_600491847" } ], "description": "Hi,\n\nPlease search for the keyword 'master'. It is present in several places in the doc below:\n\n[https://puppet.com/docs/pe/2019.8/troubleshooting_communications_between_components.html]\n\n\u00a0\n\nThanks\u00a0\n\nRajesh", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54896", "fixedVersions": [], "id": "54896", "issueType": "Bug", "key": "DOCUMENT-1181", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b29440b088822535508e534", "resolution": "Fixed", "resolutionDate": "2021-01-21T10:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The word 'master' is still there in latest PE documentation ", "timeSpent": "PT0S", "updated": "2021-01-21T10:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Note added to the docs. Thanks for the feedback!\u00a0", "created": "2021-01-22T06:37:00.000000" } ], "components": [ "Puppet Language" ], "created": "2021-01-12T12:35:00.000000", "creator": "5b8c99d59e23562b1db3ebcb", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@167c8617" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05ugo:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_66224715_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_776252895_*|*_10005_*:*_1_*:*_19760" } ], "description": "The documentation for the notify resource in Puppet 5.5 is missing a statement in the description that is present in the version 7.1 documentation notify resource description.\n\n\u00a0\n\nVersion 5.5 link:\n\n[https://puppet.com/docs/puppet/5.5/types/notify.html]\nh2. Description\n\nSends an arbitrary message to the agent run-time log.\n\n\u00a0\n\n\u00a0\n\nVersion 7.1 link which has additional info missing from the 5.5 docs:\n\n[https://puppet.com/docs/puppet/7.1/types/notify.html]\nh2. Description\n\nSends an arbitrary message, specified as a string, to the agent run-time log. {color:#de350b}It\u2019s important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.{color}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54233", "fixedVersions": [], "id": "54233", "issueType": "Bug", "key": "DOCUMENT-1180", "labels": [ "core", "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b8c99d59e23562b1db3ebcb", "resolution": "Fixed", "resolutionDate": "2021-01-22T06:37:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "missing note related to idempotence in version 5.5 documents", "timeSpent": "PT0S", "updated": "2021-01-22T06:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:63d40628f6e1b543161789a7]\u00a0Should I add a note that this is deprecated in the 6 and 7 docs? Or remove mention of it all together? Thanks!\u00a0", "created": "2021-01-22T06:07:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "The current plan is to add a new value \"mode\" to the \"source_permissions\" parameter. The values \"ignore\" and \"mode\" will not cause a deprecation warning.\nThe values \"use\" and \"use_when_creating\" will be continue to issue a deprecation warning.\n\nThere is more discussion in https://puppet.atlassian.net/browse/PUP-10253\n\nFor puppet 6 & 7 docs, I would just say that \"use\" and \"use_when_creating\" are deprecated. Maybe mention that \"ignore\" will be undeprecated and \"mode\" will be added once PUP-10253 lands in 6.x & 7.x?", "created": "2021-02-04T13:31:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Added deprecation note in file.md to both latest and 6.y\u00a0", "created": "2021-02-23T06:54:00.000000" } ], "components": [], "created": "2021-01-12T09:07:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7240f125" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05bo4:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4052458_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_2949197486_*|*_10005_*:*_1_*:*_667573306" } ], "description": "The source_permissions attribute of the File resource has been deprecated since Puppet 5. Users who make use of that attribute in their code are only informed of this after the fact, by warnings in their Puppet runs and logs. However, neither the Puppet 6 nor the Puppet 7 docs mention this, and detail the source_permissions attribute as if it is normal. The docs should ideally express this to users.\n\nThe deprecation occurred in https://puppet.atlassian.net/browse/PUP-5921\n\nmeanwhile as of 7.x, there is still no documented notification on this deprecation: https://puppet.com/docs/puppet/7.1/types/file.html#file-attribute-source_permissions", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55137", "fixedVersions": [], "id": "55137", "issueType": "Task", "key": "DOCUMENT-1178", "labels": [ "generated-docs", "puppet", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2021-02-23T06:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Docs do not detail that source_permissions is deprecated", "timeSpent": "PT0S", "updated": "2021-02-23T06:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The diff command isn't wrong. We have two different processes for generating types documentation. The older one outputs to /types/, and the newer, using Strings, outputs to /types_strings/. We should definitely be using the {{types_strings}}. But the types_strings still has some gaps, which we need to resolve. That's why we have to run the manual diff in the first place.\n\nWhat we need to know now is: is the problem with the attributes in Strings, or is it in our puppet-docs tooling? In checking whether the puppet-docs output is correct, check in {{references_output/puppet/types_strings/exec.md}}, not in {{/types/exec.md}}.\n\nIf that reference output does NOT have the attributes, then we need to check whether the attributes are in Strings's JSON output by running Strings _without_ the puppet-docs tooling. In the past, I've been able to muddle through the commands on https://puppet.com/docs/puppet/7.3/puppet_strings.html to invoke Strings on specific files or directories.\n\nI know this is a lot of stuff. [~accountid:5b0340d43eafdb09dee5bc3a], now that I've dusted my brain off a bit, I'm happy to work with you on this if needed. \n", "created": "2021-01-22T09:45:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "This is fixed in latest", "created": "2021-02-25T16:22:00.000000" } ], "components": [], "created": "2021-01-12T07:37:00.000000", "creator": "6243b7b74fe01d006ba5c73e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1de8658f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05bo6:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9597942_*|*_3_*:*_1_*:*_196107506_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_3627373506" } ], "description": "If you look at the documentation for the 'exec' resource in 7.1, it is missing parameters compared to 6.19 (specifically things like 'onlyif' and 'unless', etc)\n\n[https://puppet.com/docs/puppet/7.1/types/exec.html#exec-attributes]\n\n[https://puppet.com/docs/puppet/6.19/types/exec.html#exec-attributes]\n\n\u00a0\n\n\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54409", "fixedVersions": [], "id": "54409", "issueType": "Bug", "key": "DOCUMENT-1177", "labels": [ "core", "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243b7b74fe01d006ba5c73e", "resolution": "Fixed", "resolutionDate": "2021-02-25T16:21:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet 7.x docs for 'exec' resource are missing parameters", "timeSpent": "PT0S", "updated": "2021-02-25T16:22:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for your feedback! We don't have any file size check/rotation in place for\u00a0{{--logdest }}\u00a0 option. I'll add a note to the docs page to make that clearer.\u00a0", "created": "2020-12-16T04:12:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Added note to 6.19 and 7.1 docs.", "created": "2020-12-16T08:19:00.000000" } ], "components": [ "Configuration Management" ], "created": "2020-12-16T00:20:00.000000", "creator": "6243983e5f63fd0069b192b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@626b2454" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05ix4:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Dec/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9453616_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_17809910_*|*_10005_*:*_1_*:*_1436738" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/6.17/services_agent_windows.html#logging-for-puppet-agent-on-windows-systems\n\n_Current text :_\n\nThere is no information about size of agent event log and options on agent log is full.\n\n_Suggested improvement:_\n\nAre there any options to set a maximum size for agent event log?\n\nAre there any options available once agent log is full on the agent?\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55037", "fixedVersions": [], "id": "55037", "issueType": "Bug", "key": "DOCUMENT-1173", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Blocker", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243983e5f63fd0069b192b7", "resolution": "Fixed", "resolutionDate": "2020-12-16T08:19:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add information on agent event log ", "timeSpent": "PT0S", "updated": "2020-12-16T08:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I have updated the 5.5 page to say\u00a0January 2021. Thanks for alerting us to this mistake!\u00a0", "created": "2020-12-14T07:31:00.000000" } ], "components": [ "Puppet Client/Agent", "Puppet Server" ], "created": "2020-12-11T09:01:00.000000", "creator": "623c126d562ab90069f8b30c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@68a4abe0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05gqo:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Dec/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_234616388_*|*_10007_*:*_1_*:*_9606195_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9753580" } ], "description": "*Problem:*\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/5.5/about_agent.html]\n\n[https://puppet.com/docs/puppet/7.0/about_agent.html]\n\nThe EOL date for Puppet 5 is different on these two pages.\u00a0\n\n_Current text :_\n\n5.5 page: November 2020\n\n7.0 page:\u00a0 January 2021\n\n_Suggested improvement:_\n\nI assume both should say *January 2021.*\n\n*Summary:*\n\n**It is confusing to have conflicting EOL dates, or to not have a master EOL page instead of one per Puppet version which in turn list other Puppet versions.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54915", "fixedVersions": [], "id": "54915", "issueType": "Bug", "key": "DOCUMENT-1171", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c126d562ab90069f8b30c", "resolution": "Fixed", "resolutionDate": "2020-12-14T07:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Conflicting Puppet 5 EOL dates", "timeSpent": "PT0S", "updated": "2020-12-14T07:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I'll add an example to the end of here: [https://puppet.com/docs/puppet/7.0/resources_service.html#service_windows]\n\nDoes the following sound okay?\n\nPuppet 7 adds support for\u00a0managing the logon user and password to the Windows service provider. For example:\n{code:java}service { 'name-of-service':\n ensure => 'running',\n enable => 'true', \n logonaccount => 'domain\\\\user', \n logonpassword => $password,\n}\n{code}\nNote that the logonpassword is a sensitive variable.", "created": "2020-12-04T09:15:00.000000" }, { "author": "5a6067ef7b4e6b6c2a81b790", "body": "Hi Claire,\n\nThe change was added into Puppet 6.17, so please can the notes reflect this? I have it working in Puppet 6.19.\n\nPlease can you also detail that logonpassword is a sensitive variable.\n\nThanks,\n\nDarren", "created": "2020-12-07T07:32:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thank Darren, will do!\n\n[~accountid:63d40628f6e1b543161789a7]\u00a0Do you know what the ticket for this change is? So I can add to the release notes. Thanks!\u00a0", "created": "2020-12-09T04:26:00.000000" }, { "author": "623c12ff94742a00683e41fd", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] PUP-1289", "created": "2020-12-10T02:54:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks [~accountid:623c12ff94742a00683e41fd]!", "created": "2020-12-10T10:02:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I've added the example to the service page: [https://puppet.com/docs/puppet/7.1/resources_service.html#service_windows]\n\nAnd a release note for 6.17: [https://puppet.com/docs/puppet/6.19/release_notes_puppet.html#release_notes_puppet_x-17-0]\n\n\u00a0", "created": "2020-12-16T04:04:00.000000" } ], "components": [], "created": "2020-12-03T10:34:00.000000", "creator": "557058:91233464-4152-4228-81dd-172d43a52a03", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@75d65790" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05bw8:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Dec/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_78577176_*|*_10009_*:*_1_*:*_585947936_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_432128828_*|*_10005_*:*_2_*:*_3110359" } ], "description": "We added support for managing the logon user and password to the windows service provider, but it's not reflected in the documentation for the provider. We should add an example to the description: https://github.com/puppetlabs/puppet/blob/96029b003cfbb5303426cbc110f350a0d4b6af06/lib/puppet/provider/service/windows.rb#L5-L12\n\n{code:puppet}\nservice { 'name-of-service':\n ensure => 'running',\n enable => 'true', \n logonaccount => 'domain\\\\user', \n logonpassword => $password,\n}\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54100", "fixedVersions": [], "id": "54100", "issueType": "Task", "key": "DOCUMENT-1170", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:91233464-4152-4228-81dd-172d43a52a03", "resolution": "Fixed", "resolutionDate": "2020-12-16T04:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add logonaccount and logonpassword to windows service provider example", "timeSpent": "PT0S", "updated": "2020-12-16T04:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks for the feedback. I reviewed the Support ticket and discussed with [~accountid:5b64ddd7d1e8dc2d916c6289]. It seems that the issue here was that the customer's RBAC token didn't have appropriate permissions: \n\n{code:java}\n/opt/puppetlabs/server/data/environments/enterprise/modules/pe_manager/lib/puppet_x/util/orchestrator/connection.rb:78:in `check_orch_response': An error has occurred while running orchestrated job. The orchestration service returned an error response. See the orchestration services log file for more details. (status 403: { (PuppetX::Util::OrchestratorResponseError)\n\"msg\" : \"User does not have permission to use orchestrator\",\n\"kind\" : \"puppetlabs.orchestrator/not-permitted\",\n\"details\" : {\n\"permission\" : \"orchestrator:view:*\"\n} \n{code}\n\nWe should add that the RBAC token used for upgrade *from 2018.1 only* must be generated by a user who has *Job orchestrator* and *Node group* view permissions. RBAC requirements are documented as prerequisites -- not standalone steps -- across the PE docs, so we won't at this time incorporate token generation into the steps. I'll keep my eye on this issue, though, and see whether the token prereq is frequently missed. ", "created": "2020-12-03T10:55:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Note to writer: This prereq is a conref. Before updating it, check whether any changes you're making apply in _all_ instances of the conref across the PE docs. \n\nAlso, draft-comment that this token permission caveat applies only to upgrades from 2018.1, and can be expired when enough customers are off that version.", "created": "2020-12-03T10:56:00.000000" }, { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "That all seems reasonable to me, thanks for your help on this [~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64]", "created": "2021-01-14T05:35:00.000000" } ], "components": [], "created": "2020-12-03T03:37:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e3a4a84" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05bns:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "42222" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Dec/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_26334843_*|*_3_*:*_1_*:*_84803374_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_3538750401" } ], "description": "Taken from the large Puppet upgrade steps: (https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade_large)\n\nFrom the before you begin section: \"Ensure you have a valid admin RBAC token in order to upgrade compilers or a replica.\"\n\nFollowed by these steps in 5 and 6:\n\npuppet infrastructure upgrade compiler --token-file \n\npuppet infrastructure upgrade replica --token-file \n\nWe were failing on Step 4. Which to us did not seem to marry up that we hadn\u2019t done a step because there was no prompt in 4 to provide a Token path.\n\nI think your documentation would be clearer if you made it an explicit instruction before step 4.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54895", "fixedVersions": [], "id": "54895", "issueType": "Improvement", "key": "DOCUMENT-1169", "labels": [ "jira_escalated", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Done", "resolutionDate": "2021-01-14T09:29:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Upgrade large installation docs, valid token generation ", "timeSpent": "PT0S", "updated": "2021-01-14T09:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68] Sorry your previous ticket, PDB-4627, hasn't gotten a response. I'm going to follow up in that ticket, and close this one as a duplicate. (The PDB docs are owned and maintained by the PDB developer team, so the PDB project is actually the best place for a ticket about this.)", "created": "2020-11-23T09:42:00.000000" } ], "components": [], "created": "2020-11-22T05:42:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73c4b413" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o057iw:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Nov/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_100807948_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nIt's a bit unclear which Postgres/java version is support and recommended for PuppetDB 6/7. I raised this already months ago at https://puppet.atlassian.net/browse/PDB-4627\n\u00a0\n\n*Suggested improvement:*\n\n__ https://puppet.com/docs/puppetdb/latest/install_from_packages.html / https://puppet.com/docs/puppetdb/latest/index.html\n\nI cannot really make suggestions for improvements because I don't know which versions should be listed there :(\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54520", "fixedVersions": [], "id": "54520", "issueType": "Task", "key": "DOCUMENT-1168", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Duplicate", "resolutionDate": "2020-11-23T09:42:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PuppetDB: Docs are unclear about supported postgres/java versions", "timeSpent": "PT0S", "updated": "2020-11-23T09:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:623c0a1a761efb0069ce016b]\u00a0I want to make sure I understand the request. Are you asking for more documentation about what specific permissions are required to run a plan?\u00a0", "created": "2020-11-04T12:44:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Yes Logan Mantyla, The document should be more specific.\u00a0\n\n\u00a0\n\nI am not sure why plans are not visible under plans section. Am i lack of permission, if so what are permission are required ? or any other steps i have to perform to\u00a0 make visible those.\u00a0", "created": "2020-11-04T21:06:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "And Logan Mantyla, it should be good if you provide any example to call the plan from console.\u00a0", "created": "2020-11-05T04:18:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:623c0a1a761efb0069ce016b]\u00a0an administrator can grant you the Plans permission and, if applicable, decide which plans to grant you access to within that permission from the Access Control section. Because administrators usually have various custom roles, permissions, and constraints within those permissions in their RBAC infrastructure, it is difficult to be specific about what to change since it may be different for each PE infrastructure. The Operators and Administrators role have plan run permissions by default, but I'm not sure if your administrator uses the role.\n\nI've added some verbiage to the prereq that you must specifically have the Plan permission, which will appear on the live site shortly:\n\n\"Make sure you have the Plans permission to run the plans on the nodes.\"\n\nHere is some general guidance about building RBAC permissions and Roles:\n\n\u00a0[https://puppet.com/docs/pe/2019.8/rbac_permissions_intro.html]\u00a0", "created": "2020-11-06T14:15:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Closing this ticket, but reopen if there are any additional concerns around plan permission documentation.\u00a0\n\n\u00a0\n\nThanks", "created": "2020-11-10T09:02:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Hi Logan,\n\nYou may close the ticket as its permissions issue.", "created": "2020-11-10T09:08:00.000000" } ], "components": [], "created": "2020-11-04T08:27:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5defbef0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04wb4:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Nov/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_11110426_*|*_3_*:*_1_*:*_326282455_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1794538_*|*_10016_*:*_1_*:*_181291213" } ], "description": "*Problem:*\u00a0\n\n*Running plans from the console is not accurate.*\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/running_plans_from_the_console_.html]\n\n_Current text :_\n\nHow to choose the plan and what are the required permissions to make visible the plans.\n\n_Suggested improvement:_\n\nRequested to *provide the permission details.*\u00a0 Plans are available that can able to see in tasks. But same are not visible in plans section.\n\n*Summary:*\n\nRunning plans from the console:\u00a0\nplans (.pp) are able to visible under the tasks section. But the same are not visible under the PLANS section.\n\nIf its permissions issue, document is not much clear how to get the permissions and what are the permissions are required.\u00a0\n\nAnd do we have any additional steps are required to visible the plans which are available\u00a0under tasks.\u00a0\n\n\u00a0\n\nVersion: PE: 2019.8.1\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54692", "fixedVersions": [], "id": "54692", "issueType": "Improvement", "key": "DOCUMENT-1167", "labels": [ "medium", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Done", "resolutionDate": "2020-11-10T09:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Running plans from the console is not accurate.", "timeSpent": "PT0S", "updated": "2020-11-10T09:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "[~accountid:557058:6710b319-779a-49c9-b66f-f584a24dab53] [~accountid:623c0c6f94742a00683e3e63]\u00a0Please see above. Any thoughts or additional info to add?\u00a0", "created": "2020-11-03T13:34:00.000000" }, { "author": "557058:6710b319-779a-49c9-b66f-f584a24dab53", "body": "This looks good to me", "created": "2020-11-03T13:42:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "New section added, included in 4.2.3 release:\u00a0https://puppet.com/docs/continuous-delivery/4.x/cd_system_requirements.html#antivirus-considerations", "created": "2020-11-17T12:28:00.000000" }, { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "I can't see this in the CD4PE documents anymore, any idea why this was removed? ", "created": "2021-09-28T05:41:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Hi [~accountid:557058:1134d60c-31df-407a-b573-e0cfaef8865e]\u00a0This content was moved into the Puppet Application Manager (PAM) documentation, as these requirements are tied to the Replicated platform, not CD4PE itself. The doc is now here: [https://puppet.com/docs/continuous-delivery/4.x/pam/pam-sysreqs.html#pam-sysreqs-pam-antivirus]\n\n\u00a0", "created": "2021-09-28T08:55:00.000000" }, { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "Ah I see, thanks for this Mindy! I had searched the cd4pe docs but it didn't flag anything up for anti-virus or anti-malware, my apologies!", "created": "2021-09-28T09:58:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "No worries, [~accountid:557058:1134d60c-31df-407a-b573-e0cfaef8865e]\u00a0! The PAM change is a big one, and we're still working on improving the docs site's search.\u00a0", "created": "2021-09-28T10:42:00.000000" } ], "components": [ "requirements" ], "created": "2020-11-01T20:59:00.000000", "creator": "5a6f8ab837c0e2522976d769", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@57684d35" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04u08:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Nov/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_145948292_*|*_10007_*:*_1_*:*_68017506_*|*_3_*:*_1_*:*_1060712716_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_77051090" } ], "description": "*Problem:*\n\nCustomer with Trend Anti-Virus experienced an extreme impact on the operation of CD4PE.\u00a0 It was bad enough that the service became unreachable.\u00a0 We need to provide guidance on directories to exclude from such scan tools.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/continuous-delivery/4.x/cd_system_requirements.html\n\n_Current text :_\n\nThere is no current text for directory exclusions.\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\nh2. Anti-Virus and Anti-Malware considerations\n\nAnti-virus and anti-malware software can have an impact on the functioning of Continuous Delivery for PE in a way which inhibits or prevents proper function.\u00a0 The following directories are recommended to be excluded from anti-virus\u00a0 and anti-malware tools which do scanning of disk write operations:\n\n/opt/replicated/rook\n/var/lib/docker\n/var/lib/kubelet\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54691", "fixedVersions": [], "id": "54691", "issueType": "Improvement", "key": "DOCUMENT-1165", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a6f8ab837c0e2522976d769", "resolution": "Done", "resolutionDate": "2020-11-17T12:28:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] CD4PE directories to exclude from anti-virus", "timeSpent": "PT0S", "updated": "2021-09-28T10:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Added to 2019.8+. This will appear with our next docs build.", "created": "2020-11-12T14:39:00.000000" } ], "components": [ "PE" ], "created": "2020-11-01T20:51:00.000000", "creator": "5a6f8ab837c0e2522976d769", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7fe381bc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04cyr:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Nov/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_224615023_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_700604680_*|*_10005_*:*_1_*:*_2851973" } ], "description": "*Problem:*\n\nCustomer using Trend Anti-Virus experienced extreme performance issues related to the virus scanner.\u00a0 PE code deployments were extremely slow and timed out frequently.\u00a0 CD4PE would stop functioning altogether.\u00a0\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/pe/2019.8/system_configuration.html\n\n_Current text :_\n\nThere is no text regarding anti-virus considerations.\n\n_Suggested improvement:_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\nh2. Anti-Virus and Anti-Malware considerations\n\nAnti-virus and anti-malware software can have an impact on the functioning of Puppet Enterprise in a way which inhibits or prevents proper function.\u00a0 The following directories are recommended to be excluded from anti-virus\u00a0 and anti-malware tools which do scanning of disk write operations:\n\n/etc/puppetlabs\n/opt/puppetlabs\n\n\u00a0\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54587", "fixedVersions": [], "id": "54587", "issueType": "Improvement", "key": "DOCUMENT-1164", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a6f8ab837c0e2522976d769", "resolution": "Fixed", "resolutionDate": "2020-11-12T14:39:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] PE Directories to exclude from anti-virus scanning", "timeSpent": "PT0S", "updated": "2020-11-12T14:39:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [ { "attacher": "5fda5d57f7ea2a0107e9f42c", "created": "2020-10-23T16:45:00.000000", "name": "image-2020-10-23-15-45-18-233.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14250" } ], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:5fda5d57f7ea2a0107e9f42c]! Thanks for the ticket. Can you tell me more specifically what the issue is? I'm not seeing a problem in any of the formatting, but maybe I'm missing it because it's Friday afternoon. :)", "created": "2020-10-23T16:40:00.000000" }, { "author": "5fda5d57f7ea2a0107e9f42c", "body": "Hi [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] ,\n\n\u00a0\n\nIt's a bit down the page, but looks like someone tried putting some code blocks on something and it breaks the rest of the page. See attached screenshot (note the ```shell line). Not sure if this also breaks the file resource page that google links to, but that seems broken as well.\n\n\u00a0\n\n!image-2020-10-23-15-45-18-233.png!", "created": "2020-10-23T16:46:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Ah, perfect, [~accountid:5fda5d57f7ea2a0107e9f42c], that's very helpful. \n\nDocs Todo: fix this in the existing docs and the docs string in the Puppet code base. And maybe fix \"puppet master server\" while there (should be either just \"master\" in current usage or \"primary server\" for terminology change).", "created": "2020-10-23T17:04:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This is fixed in 6.19.1 and 7.1:\u00a0\n\n[https://puppet.com/docs/puppet/7.1/type.html#file]\n\n[https://puppet.com/docs/puppet/6.19/type.html#file]\n\nThanks for letting us know!\u00a0\n\n\u00a0", "created": "2020-12-16T02:57:00.000000" } ], "components": [], "created": "2020-10-23T16:01:00.000000", "creator": "5fda5d57f7ea2a0107e9f42c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@306f1264" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04p6o:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_327335684_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4294767369" } ], "description": "*Problem:*\n\n\u00a0Formatting broken on https://puppet.com/docs/puppet/6.17/type.html#file\n\n*Summary:***\n\n[https://puppet.com/docs/puppet/6.17/type.html#file]\n\n\u00a0\n\nLooks like someone broke formatting at the file type.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54225", "fixedVersions": [], "id": "54225", "issueType": "Bug", "key": "DOCUMENT-1163", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Low (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5fda5d57f7ea2a0107e9f42c", "resolution": "Fixed", "resolutionDate": "2020-12-16T02:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "formatting issue on `file` type docs", "timeSpent": "PT0S", "updated": "2020-12-16T02:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623c0e44866b810069e435c6", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "To clarify, based on Slack convo with [~accountid:623c0e44866b810069e435c6], the retro mentioned here was specifically about an upgrade where the customer was on a retired master platform, so the gist of this feedback is that the steps documented [here|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#retired_platforms] aren't adequate. \n\n[~accountid:623c0e44866b810069e435c6], this is really helpful to know. The process as documented was tested internally (see PE-29467), but I believe there were several unknowns at the time based on architecture. If you could provide a draft of what you think is needed for upgrading PE when a master OS upgrade is required, that would be helpful. I'd like to continue to position the instructions that way, rather than distinguishing between upgrading and migrating. I believe upgrade vs. migration introduces a rhetorical distinction that's not useful to the majority of customers, and it complicates upgrade where we've worked hard to simplify it. \n\nI did recently split up the upgrade tasks so that there are specific instructions for each installation type. I believe this takes care of item 2 on your list. https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade_pe\n\ncc: [~accountid:5b50a69a2726b92cd5368cb3] for visibility.", "created": "2020-10-21T15:55:00.000000" }, { "author": "5b50a69a2726b92cd5368cb3", "body": "re: step 3. Ajay and I chatted a little on this earlier today. While it may work to skip step 3 for some, it will fail for others. It is better to have people do this step, even if redundant for a handful, so that we don't cause others to fail with this step missing.\u00a0", "created": "2020-10-27T14:10:00.000000" }, { "author": "557058:b0098632-f6a5-4120-9a61-70f8cf89e31f", "body": "[~accountid:557058:d4350b75-5c6c-418b-a920-e3e7999ca9d7]\u00a0and [~accountid:623c0e44866b810069e435c6]\u00a0might this be a good opportunity to enter into a white paper if you want to present this information from a different perspective from what we publish in docs? I've heard other SE have done this to help explain and encourage customers to adopt, etc.\u00a0\n\nTo be clear, are you identifying a specific technical inaccuracy in the docs? That would be where we need that itemized for the tech pubs team.\u00a0 Thanks!\u00a0", "created": "2020-10-29T12:57:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Closing this for now on the following grounds:\n\n* The request to provide separate instructions for each installation type is complete.\n* Per PM direction, we won't publicly document migration at this time. \n* The current instructions for migrating from a retired master OS are accurate for certain scenarios, even if they include an extraneous non-breaking step for others. \n* Lack of concrete suggestions for reformatting or reorganizing the page.\n\nFeel free to reopen with more details if needed.", "created": "2020-11-04T11:37:00.000000" } ], "components": [ "PE" ], "created": "2020-10-20T07:54:00.000000", "creator": "623c0e44866b810069e435c6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@10d732a7" }, { "fieldName": "CS Affected Frequency", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "1 - Monthly or less" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Major" }, { "fieldName": "CS Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "4 - Major" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04l6w:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8581021_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1197718834_*|*_10005_*:*_1_*:*_106721779" } ], "description": "*Problem:*\u00a0There are several inconsistencies in our current upgrade documentation and the approach suggested to upgrade PE.\n\nCS team engaged\u00a0 upgrading PE and the upgrade did not go very smoothly. This ticket is was created out of a retrospective we did as a CS team.\n\nHere is a list of issues identified with our Public upgrade docs\n # The [doc itself|https://puppet.com/docs/pe/2019.8/upgrading_pe.html]\u00a0**\u00a0is not presented in a very consumable fashion and we need to revisit how the information is laid out. My suggestion would be to split out the upgrade paths. There are 2 potential upgrade paths for Puppet. We need break out the single document into two documents.\n ## An upgrade -> when going from version x to version y\n ## A migration -> where the underlying O/S and infrastructure needs to be recreated and a new Puppet deployment has to be done\n # Additionally, the upgrade cautions are contextual - they don't apply to all the versions of Puppet. We should re-structure it so that customers can clearly identify if the caution is applicable for their Puppet version\n # The documented upgrade process itself needs to be revisited as we found a few discrepancies:\u00a0\n ## Under the steps for [retired platform|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#retired_platforms]\u00a0we ask customers to\u00a0_Install your current\u00a0PE\u00a0version on the new node_\u00a0but this step is actually not required. In a large environment, doing prep for this step actually takes 1-2 day\n ## Running the backup/restore as documented is not feasible in very large Puppet deployments - support asked us to use their KB and do dump/restore of selective tables instead\n ## We need more detailed steps when doing a migration\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/upgrading_pe.html]\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54586", "fixedVersions": [], "id": "54586", "issueType": "Improvement", "key": "DOCUMENT-1162", "labels": [ "medium", "pe", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0e44866b810069e435c6", "resolution": "Incomplete", "resolutionDate": "2020-11-04T11:37:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve PE upgrade documentation for retired master platforms", "timeSpent": "PT0S", "updated": "2020-11-04T11:37:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "All references to PE console UI text in the CD4PE docs have been checked and corrected to reflect current status (with notes specifying older terms for users who may still be on an older version of PE).\u00a0\n\nThese changes will ship in the docs for CD4PE 4.2.0, scheduled for the first week of November.\u00a0\n\nThanks!\u00a0", "created": "2020-10-28T16:23:00.000000" } ], "components": [], "created": "2020-10-16T02:02:00.000000", "creator": "5e870aab467ac20c1d94c86d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1ed6b331" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03rnn:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_375503200_*|*_3_*:*_1_*:*_533732423_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_179250814" } ], "description": "[https://puppet.com/docs/continuous-delivery/4.x/integrate_with_puppet_enterprise.html#cd_environment_node_groups]\n\nThis line\n # In the\u00a0PE\u00a0console, click\u00a0Classification.\n\nShould read\n # In the\u00a0PE\u00a0console, click Node Groups.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54221", "fixedVersions": [], "id": "54221", "issueType": "Improvement", "key": "DOCUMENT-1157", "labels": [ "cd4pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5e870aab467ac20c1d94c86d", "resolution": "Fixed", "resolutionDate": "2020-10-28T16:23:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The name for Classification in the PE console has changed to Node Groups", "timeSpent": "PT0S", "updated": "2020-10-28T16:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:afa80a20-2814-4f2f-bbdd-ad5db4190123] The packaged delete reports command is documented in the first step of the [upgrade topic|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade_pe], as linked in the PuppetDB migration discussion. ", "created": "2020-10-19T11:59:00.000000" }, { "author": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "body": "Oh yeah I see that. But in the section I'm referring to is a long way before the command itself is ever mentioned. So I think people would be likely to read that instruction, then go looking for the command. But even doing CTRL+F for \"delete reports\" doesn't show anything up in that page since it's referred to initially as the \"packaged delete reports command\" then later as \"cleaning up PuppetDB reports\" so it's very hard for someone to go through and find what command they are supposed to be running. I suspect most people won't read that whole page from start to finish before beginning anything.\n\nThe command itself could be documented which would allow us to just link to the reference docs in both locations, or we could just mention the exact command twice, but I don't think we should be giving users an instruction as specific as this without giving them some easy way follow it, i.e. by copy pasting a command or reading another page in the docs", "created": "2020-10-20T03:19:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Okay, fair point. I added the actual command to https://puppet.com/docs/pe/2019.8/upgrading_pe.html#puppetdb-migrations-in-pe-2019.1-2019.3-and-2019.7\n\nIt will update with the next docs build.", "created": "2020-10-20T11:40:00.000000" } ], "components": [], "created": "2020-10-14T06:37:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4f5c07d0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04iqg:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_531823528_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4796133" } ], "description": "On this page: https://puppet.com/docs/pe/2019.8/upgrading_pe.html#puppetdb-migrations-in-pe-2019.1-2019.3-and-2019.7\n\nIt references \"the packaged delete reports command\", but there is no long to this command and I can't fins any mention of it. Can we add a link to this command? I think it's referring to this: https://puppet.com/docs/pe/2019.7/release_notes_pe.html#easier-and-more-reliable-upgrades\n\nBut ideally we would just tell people exactly what to run", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54218", "fixedVersions": [], "id": "54218", "issueType": "Improvement", "key": "DOCUMENT-1156", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Fixed", "resolutionDate": "2020-10-20T11:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "packaged delete reports command is not documented", "timeSpent": "PT0S", "updated": "2020-10-20T11:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] These requirements are based on internal testing, so I'll route this ticket through the Installer team to make sure we're all on the same page. But first, a couple of points of clarification...\n\nYou're requesting that we:\n# Update the existing tables as shown in the ticket description.\n# Add a note about calculating hardware requirements on virtual nodes with hyperthreading enabled.\n\nYes/no\n\nFor table updates, you're suggesting adding several lines for standard installs. Am I correct in assuming that the requirements for {{/opt/}}, {{/var/}}, AWS EC2, and Azure should remain the same with respect to the current node volumes? For example, your new 101-500 node count bracket should have the settings for what is currently \"Up to 2,000\" nodes?\nYes/no ", "created": "2020-10-13T12:58:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0Yes I'm asking that the existing tables are updated and that we add a note about the reqs on virtual nodes with hyperthreading enabled.\n\nGood catch on the storage requirements, these indeed don't match the new node counts and may need some slight adjustment. I'm sure the installer team can tweak those to align with the new node amounts.", "created": "2020-10-13T13:20:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95], what's your take on updating the PE [hardware requirements|https://puppet.com/docs/pe/2019.8/hardware_requirements.html] as [~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] describes above? My understanding is that the requirements are based on testing...\n\nIf you're on board, would you be able to flesh out the standard installation requirements table for the additional node counts he's added?\n||Node volume||Cores||RAM||/opt/||/var/||AWS EC2||Azure||\n|Trial use (up to 10)|4|8 GB|\u00a0|\u00a0|\u00a0|\u00a0|\n|11-100|6|10 GB|\u00a0|\u00a0|\u00a0|\u00a0|\n|101-500|8|12 GB|\u00a0|\u00a0|\u00a0|\u00a0|\n|501-1000|10|16 GB|\u00a0|\u00a0|\u00a0|\u00a0|\n|1001-2500|12|24 GB|\u00a0|\u00a0|\u00a0|\u00a0|", "created": "2020-10-13T13:35:00.000000" }, { "author": "557058:79f2fdd6-baee-43c4-91af-c7e647173c95", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] about the only feedback I'm qualified to give is what is the hardware requirements are for what we test in CI, which is the 'trial use' scenario, and that is only around the RAM requirements since PE will fail to install if we reach the limit. The 8 GB we have there is what we currently have in CI on our master platforms, so that is validated.\n\nThe CPU count is something we really can't validate since our CI is only really running PE for short stretches and isn't designed to do any kind of performance analysis.\nI'd trust our Support team in whatever they suggest should be the suggested requirement. \n\nAs for the /opt /var directory sizes much like CPU count that is something our CI doesn't really come close to touching, so I'd have to lean on our Support team for their suggestion. The same for AWS/Azure, and the various node volume. ", "created": "2020-10-20T16:25:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:b0098632-f6a5-4120-9a61-70f8cf89e31f], [~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c] suggests refining the PE hardware requirements as described in this ticket. The specificity of these changes goes beyond what Engineering currently tests, so [~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95] recommended getting Support buy-in as well as help fleshing out the table in my previous comment. \n\nCan you recommend someone to review and help with this effort?", "created": "2020-10-26T14:02:00.000000" }, { "author": "557058:b0098632-f6a5-4120-9a61-70f8cf89e31f", "body": "somewhat related, the hardware install specs for CD4PE were also recently doubled\n\nFrom talking to the support team, at first glance the recommended changes make sense but it appears RAM should be higher. Overall we feel we can make best guesses but any recommendations should be tested and validated by Engineering. [~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95]\u00a0would you and your team own the testing and validation?", "created": "2020-10-30T09:20:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:b0098632-f6a5-4120-9a61-70f8cf89e31f] Per [~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95]'s previous comment, it sounds like Engineering is equipped/resourced to test only RAM and only up to 10 nodes. The other requirements and node tiers are beyond their testing capabilities. \n\nFeel free to correct me if I'm wrong [~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95]. \n\n[~accountid:557058:b0098632-f6a5-4120-9a61-70f8cf89e31f], maybe a reasonable next step would be for Support to provide best guesses for the rest of the table, and we can take it to our POs for approval? I would also probably add to that docs page that hardware requirements are based on a combination of internal testing _and Support field experience_. ", "created": "2020-11-04T11:46:00.000000" }, { "author": "557058:b0098632-f6a5-4120-9a61-70f8cf89e31f", "body": "Feedback from the most senior support engineers is that this is ill-advised. We believe publishing customer spec recommendations based on untested best guesses would lead to additional problems and liability. Anything we publish for hardware requirements should be tested and validated by engineering.\u00a0\n\nWe might align on next steps faster if we had a quick call with you, Christopher Thorn, a principal support engineer, and Kevin?", "created": "2020-11-04T13:10:00.000000" }, { "author": "557058:b0098632-f6a5-4120-9a61-70f8cf89e31f", "body": "[~accountid:5a53f75b9738751fb351948b] it appears we are encountering some limits to what we can test to make the right recommendations to customers.\u00a0 Could you help us identify what resources are available and who we can work with to move this forward?\n\n\u00a0\n\n\u00a0", "created": "2020-11-12T16:37:00.000000" }, { "author": "557058:b0098632-f6a5-4120-9a61-70f8cf89e31f", "body": "[~accountid:557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c]\u00a0the other option is to add language to this page that hardware requirements are based on Proof of Concept testing and not production instances? Let us know your thoughts please based on what is tested?\u00a0 I know you opened this ticket so trying to see what we can do to move it along", "created": "2020-11-12T16:38:00.000000" }, { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:557058:79f2fdd6-baee-43c4-91af-c7e647173c95] does this mean the current hardware specs on the Docs site are also not based on real testing?\n If we haven\u2019t actually done real scale testing, I would recommend we look at real customer environments and abstract workable hardware specs from those. I bet they\u2019ll be significantly higher than our current specs.", "created": "2020-11-12T16:44:00.000000" }, { "author": "5a53f75b9738751fb351948b", "body": "[~accountid:557058:b0098632-f6a5-4120-9a61-70f8cf89e31f], scale testing hasn't been done in a while. There is an effort to kick this off again", "created": "2020-11-13T09:36:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Closing this ticket, as it's been stalled out for 2+ months. \n\nIf this is still a priority, I suggest opening a PE ticket instead to settle on hardware recommendations. ", "created": "2021-02-01T11:07:00.000000" } ], "components": [], "created": "2020-10-09T10:41:00.000000", "creator": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50d0167a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o05890:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_343695248_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_9587317507_*|*_10016_*:*_1_*:*_10159789" } ], "description": "As a customer I want to have accurate hardware requirements for my architecture & node count of Puppet Enterprise. Right now, some of the recommendations are too low.\n\nThe main issue is that we specify too low specs for Standard installations, which don't take into account that multiple processes are battling for resources on the same box.\n Another, smaller, issue is that on virtualized nodes a vCPU typically only equates to about 55% of a \"real\" CPU core if hyperthreading is enabled. This can cause our recommended specs to be off by almost 50%.\n\nI would recommend the following new spec tables (for CPU/RAM, storage looks OK):\n\nWhen using virtual CPUs on a hypervisor that is running on hardware with hyper-threading enabled, add 40% extra vCPUs to the physical CPU core count recommendations below.\n\nStandard monolithic installs:\n * Trail use {color:#FF0000}(up to 10){color} => 4 CPU, 8GB RAM\n {color:#FF0000}* Up to 100 => 6 CPU, 10GB RAM\n * Up to 500 => 8 CPU, 12GB RAM\n * Up to 1000 => 10 CPU, 16GB RAM\n * Up to 2500 => 12 CPU, 24GB RAM\n * Above 2500 => switch to large install architecture{color}\n\nLarge installs:\n * {color:#FF0000}2500{color} to 20.000 => 16 CPU, 32GB RAM for the PE Primary\n * each compiler (1500-3000 nodes) => {color:#FF0000}6 CPU, 12GB RAM{color}\n\nExtra Large installs:\n * 20.000+ => 16 CPU, 32GB RAM for the PE Primary\n * each compiler (1500-3000 nodes) => {color:#FF0000}6 CPU, 12GB RAM{color}\n * PE-PostgreSQL node => 16 CPU, 128GB RAM", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54585", "fixedVersions": [], "id": "54585", "issueType": "Improvement", "key": "DOCUMENT-1155", "labels": [ "pe", "small", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "resolution": "Incomplete", "resolutionDate": "2021-02-01T11:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update hardware recommendations", "timeSpent": "PT0S", "updated": "2021-02-01T23:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:70121:e83e1a27-3346-490e-9e8f-a84f75436063] I'm asking our JIRA administrator about this issue, so I'm just putting this ticket in \"needs information\" until I hear something back. Thank you!", "created": "2020-10-09T16:11:00.000000" }, { "author": "557058:7e524d50-cfa9-44c1-9d72-f30ab841ddf9", "body": "I've added permissions to view the Development Tools panel when non-puppet users have an account and are logged in.\u00a0", "created": "2020-10-12T12:31:00.000000" }, { "author": "557058:7e524d50-cfa9-44c1-9d72-f30ab841ddf9", "body": "PUP-10689 is an example where you can see this panel in the right column towards the bottom.\u00a0", "created": "2020-10-12T12:32:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Great, thank you so much [~accountid:557058:7e524d50-cfa9-44c1-9d72-f30ab841ddf9]! [~accountid:70121:e83e1a27-3346-490e-9e8f-a84f75436063], can you verify that the PR link is now visible to you?", "created": "2020-10-12T16:34:00.000000" }, { "author": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "body": "[~accountid:557058:7e524d50-cfa9-44c1-9d72-f30ab841ddf9]\u00a0i can confirm that i can see the development panel on both PUP-10689 and\u00a0PUP-9372* (from the original post).\u00a0 Thanks for adding this it will make looking for things a lot quicker\n\n\u00a0*PUP-9372 seems to link to the wrong commit but thats a different problem :)", "created": "2020-10-13T03:13:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Looks like this was done a while ago, closing.\u00a0", "created": "2022-01-27T14:13:00.000000" } ], "components": [], "created": "2020-10-09T06:28:00.000000", "creator": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@44f14726" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04g94:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_34915730_*|*_10009_*:*_1_*:*_38375811_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_260647464_*|*_10005_*:*_1_*:*_40737553709" } ], "description": "I have been informed that internally tickets.puppetlabs.com tracks links to the github PR request and it seems apparent from some comments that theses links are available to some people.\u00a0 for instance the following bug references a PR\n\n[\u00a0 \"The PR has a few examples\"| https://puppet.atlassian.net/browse/PUP-9372?focusedCommentId=616572&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-616572]\n\nhowever there is no link available to me in this interface.\u00a0 Can we please make the public github PR links also public on [https://tickets.puppetlabs.com/.|https://tickets.puppetlabs.com/]\u00a0 I think this will have a direct impact on community contributions", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54894", "fixedVersions": [], "id": "54894", "issueType": "Improvement", "key": "DOCUMENT-1154", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "resolution": "Done", "resolutionDate": "2022-01-27T14:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Please make PR links on https://tickets.puppetlabs.com/ public", "timeSpent": "PT0S", "updated": "2022-01-27T14:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "attachments": [], "comments": [ { "author": "5d9f43aac62f840db2b6ee35", "body": "[~accountid:557058:1bbab747-be1c-4a23-9779-b947371491ba] \nDoes this general section in the Puppet Application Manager\u00a0\u00a0[https://puppet.com/docs/continuous-delivery/4.x/pam/pam-sysreqs.html#pam-sysreqs-pam-port-reqs]\u00a0cover what you need or do you require CE4PE specific content in the CD4PE docs?", "created": "2021-05-13T02:07:00.000000" }, { "author": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "body": "I think what you linked is sufficient.\u00a0 Thanks!", "created": "2021-05-21T05:20:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "PAM docs content sufficient for this ticket. Reviewed by Jessykah B.", "created": "2021-05-21T05:26:00.000000" } ], "components": [], "created": "2020-09-23T14:57:00.000000", "creator": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@cfaac12" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o046xk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/May/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_179873670_*|*_10009_*:*_1_*:*_659434708_*|*_5_*:*_1_*:*_225401_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_19862216816" } ], "description": "*Problem:*\n\n\u00a0Port requirements change when additional configuration settings are set such as webhook.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/continuous-delivery/4.x/cd_system_requirements.html\n\n_Current text :_\nh3. Open port requirements\nContinuous Delivery for PE\u00a0uses the following ports:\n|\u00a0|\n||Port||Protocol||Purpose||Source||Destination||\n|_Continuous Delivery for PE\u00a0ports_|\n|443|TCP|Web UI|Browser|Continuous Delivery for PE|\n|8000|TCP|Webhook service|Source control|Continuous Delivery for PE|\n\n_Suggested improvement:_\nh3. Open port requirements\nContinuous Delivery for PE\u00a0uses the following ports:\n|\u00a0|\n||Port||Protocol||Purpose||Source||Destination||\n|_Continuous Delivery for PE\u00a0ports_|\n|443|TCP|Web UI|Browser|Continuous Delivery for PE|\n|8000*/443*|TCP|Webhook service|Source control|Continuous Delivery for PE*, port 8000 is used for default webhook, while 443 uses SNI to route traffic through kubernetes.*|\n\n\u00a0\n\n*Other ports that change should be updated similarly.*", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54584", "fixedVersions": [], "id": "54584", "issueType": "Improvement", "key": "DOCUMENT-1153", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "resolution": "Fixed", "resolutionDate": "2021-05-21T05:22:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Detail CD4PE port requirements better.", "timeSpent": "PT0S", "updated": "2021-05-21T05:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "New section added to the 4.x docs: [https://puppet.com/docs/continuous-delivery/4.x/cd_system_requirements.html#web-url-requirements-for-firewalls]\n\nPlease let me know if any further changes are needed. Thanks!\u00a0", "created": "2021-02-03T14:46:00.000000" } ], "components": [], "created": "2020-09-23T14:54:00.000000", "creator": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@64a95475" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o046xc:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Feb/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_180069228_*|*_3_*:*_1_*:*_85669902_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_11228593197" } ], "description": "*Problem:\u00a0 Unlike Puppet Enterprise, all the outbound connections and sites required to download and get CD4PE up and running are not listed.*\n\n\u00a0\n\n*Suggested improvement:*\n\n_[https://puppet.com/docs/continuous-delivery/4.x/cd_system_requirements.html]_\n\n_Current text :_\n\nCurrently no section discusses external sites required for an online installation.\n\n_Suggested improvement:_\n\nPlease add a section listing sites such as\u00a0*replicated.app* and\u00a0*docker.io* in order to allow secure access for those who allow internet but keep a restricted firewall.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54519", "fixedVersions": [], "id": "54519", "issueType": "Improvement", "key": "DOCUMENT-1152", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1bbab747-be1c-4a23-9779-b947371491ba", "resolution": "Fixed", "resolutionDate": "2021-02-03T14:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE documentation lacking outbound sites", "timeSpent": "PT0S", "updated": "2021-02-03T14:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [ { "attacher": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "created": "2020-09-23T05:27:00.000000", "name": "Screenshot 2020-09-23 at 12.27.16.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14265" } ], "comments": [], "components": [], "created": "2020-09-23T05:27:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@631dcd57" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o046fs:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_534929233_*|*_3_*:*_1_*:*_75514947_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_12394516" } ], "description": "On the following docs page: https://puppet.com/docs/pe/2019.8/running_puppet_on_demand_from_the_cli.html\n\nAre we missing the links to the complete reference for both puppet job and puppet app commands?\n\nscreenshot of the particular section attached", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54215", "fixedVersions": [], "id": "54215", "issueType": "Task", "key": "DOCUMENT-1151", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Fixed", "resolutionDate": "2020-09-30T10:28:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Job and Puppet App, complete reference links missing?", "timeSpent": "PT0S", "updated": "2020-09-30T10:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "5d9f43aac62f840db2b6ee35", "body": "Added note on mapped_paths", "created": "2021-01-19T03:44:00.000000" } ], "components": [], "created": "2020-09-15T09:49:00.000000", "creator": "70121:13e9ba64-d0e3-4303-948b-08ee1e68f2de", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60ac82ec" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o04114:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "2.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2613408_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_72778387_*|*_10005_*:*_1_*:*_10792671520" } ], "description": "On [https://puppet.com/docs/puppet/5.5/hiera_config_yaml_5.html]\n\n\u00a0\n\nit is unclear if use of `mapped_paths` will support glob expansion.\u00a0 Given that it doesn't specify, the expectation is 'no it does not'; however, it would be good to be explicit here.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55036", "fixedVersions": [], "id": "55036", "issueType": "Improvement", "key": "DOCUMENT-1150", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:13e9ba64-d0e3-4303-948b-08ee1e68f2de", "resolution": "Done", "resolutionDate": "2021-01-19T03:44:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Hiera mapped_paths should specify if it permits glob expansion", "timeSpent": "PT0S", "updated": "2021-01-19T03:44:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Docs TODO: verify whether the description key is accurate and fix. IAC team can tell you about module metadata.", "created": "2020-09-08T10:09:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Hi [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02], could you please verify this? Thanks!", "created": "2020-09-16T01:58:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "As far as I know, the canonical schema for module metadata is at https://github.com/puppetlabs/puppet-forge-api/blob/master/app/static/schemas/module.json and that does NOT list a \"description\" key.\n\nThe PDK does not generate a description in the default metadata.json\n\nOnly a handful of IAC modules have a description field in their module metadata.", "created": "2020-09-16T02:34:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02]! I'll remove this line from the example.\u00a0", "created": "2020-09-16T04:20:00.000000" } ], "components": [], "created": "2020-09-04T19:43:00.000000", "creator": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1575d48b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03xlk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_311172320_*|*_10007_*:*_1_*:*_15680862_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_661865700_*|*_10005_*:*_1_*:*_8745618" } ], "description": "*Problem:*\n\nThe {{metadata.json}} example at https://puppet.com/docs/puppet/6.17/modules_metadata.html#modules_metadata includes this line:\n\n{noformat}\n \"description\": \"NTP Module for Debian, Ubuntu, CentOS, RHEL, OEL, Fedora, FreeBSD, ArchLinux, Amazon Linux and Gentoo.\"\n{noformat}\n\nThere is no {{\"description\"}} key documented in https://puppet.com/docs/puppet/6.17/modules_metadata.html#modules_metadata_json_keys. It seems redundant with {{\"summary\"}}.\n\n*Suggested improvement:*\n\n_https://puppet.com/docs/puppet/6.17/modules_metadata.html#modules_metadata_\n\n_Current text :_\n\n{noformat}\n \"description\": \"NTP Module for Debian, Ubuntu, CentOS, RHEL, OEL, Fedora, FreeBSD, ArchLinux, Amazon Linux and Gentoo.\"\n{noformat}\n\n_Suggested improvement:_\n\n{noformat}\n{noformat}\n\n\n*Summary:*\n\nRemove the spurious {{\"description\"}} key from the metadata.json example (or document it if it is legitimate).\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54914", "fixedVersions": [], "id": "54914", "issueType": "Bug", "key": "DOCUMENT-1148", "labels": [ "doc-hack", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "resolution": "Fixed", "resolutionDate": "2020-09-16T08:47:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Module metadata example includes undocumented/non-existent key", "timeSpent": "PT0S", "updated": "2020-09-16T08:47:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This was already fixed in DOC-4677.", "created": "2020-09-01T11:58:00.000000" } ], "components": [], "created": "2020-08-26T17:23:00.000000", "creator": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6b3007cb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03srs:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_492005112_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_6928385" } ], "description": "On this page:\n\n[https://puppet.com/docs/pe/2019.8/analytics_overview.html]\n\nAt the bottom of the page, under the heading \"Opt out after installing\", the class listed that needs editing is:\n\n{\\{puppet_enterprise::profile::master\u00a0 }}\n\nWhere it should be listed as:\n\n{{puppet_enterprise}}\n\nThis is due to \\{{puppet_enterprise::profile::console }} also using this parameter value.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54096", "fixedVersions": [], "id": "54096", "issueType": "Bug", "key": "DOCUMENT-1147", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "resolution": "Duplicate", "resolutionDate": "2020-09-01T11:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Opt out of analytics instructions partially incorrect", "timeSpent": "PT0S", "updated": "2020-09-01T11:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [ { "attacher": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "created": "2020-08-26T08:59:00.000000", "name": "image-2020-08-26-10-59-50-556.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14202" } ], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Update: It was intentional that these pages had a recommendation to file a ticket instead of the feedback form. That said, things have changed since then, and current Puppet Server docs once again have a feedback form. \n\nTodo: replace the commands with the updated ones listed above, and replace foobar with ", "created": "2020-10-26T10:29:00.000000" } ], "components": [], "created": "2020-08-26T09:00:00.000000", "creator": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2a915c2b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03rnk:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Oct/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_522247672_*|*_3_*:*_1_*:*_4481121829_*|*_10009_*:*_1_*:*_1280882841_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_2201787774_*|*_10017_*:*_1_*:*_37774" } ], "description": "*Problem:*\n\nsome of the commands on the following puppet documentation page should probably be updated:\nhttps://puppet.com/docs/puppetserver/latest/gems.html\nthe --no-ri and --no-rdoc are deprecated https://www.ruby-lang.org/en/news/2018/12/25/ruby-2-6-0-released/\nand should be replace with --no-document\n\nalso of note there is no standard comments box at the bottom of the page\n !image-2020-08-26-10-59-50-556.png|thumbnail! \n\n*Suggested improvement:*\n\n__ : https://puppet.com/docs/puppetserver/latest/gems.html\n\n_Current text :_\nsudo puppetserver gem install foobar --no-ri --no-rdoc\n\n\n_Suggested improvement:_\n\nsudo puppetserver gem install foobar *--no-document*\n\n\n*Summary:*\n\n\u00a0post ruby 2.5 the --no-ri --no-rdoc command options were deprecated and removed. the puppet documentation of versions of puppet that use ruby later than 2.5 should reflect the change in command options", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54518", "fixedVersions": [], "id": "54518", "issueType": "Bug", "key": "DOCUMENT-1146", "labels": [ "puppetserver", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "resolution": "Done", "resolutionDate": "2020-12-02T13:14:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "ruby commands reference old parameters", "timeSpent": "PT0S", "updated": "2020-12-02T13:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Add a new topic to the PE [system configuration page|https://puppet.com/docs/pe/2019.8/system_configuration.html], after the web URL topic, in 2019.8 and later.", "created": "2020-09-21T10:02:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:623c129850bb2b0070b6b35d]\u00a0this topic is ready for review: [https://puppet-docs-preview.netlify.app/docs/pe/2019.8.z/system_configuration.html#antivirus-considerations]\u00a0\n\n\u00a0\n\npuppet | fork.left.extra\n\n\u00a0\n\ncc\u00a0[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]", "created": "2020-11-19T12:49:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Reviewed and published to 2019.8.z, 2019.8, and latest-preview. Will be live shortly.\u00a0", "created": "2020-11-30T14:27:00.000000" } ], "components": [], "created": "2020-08-18T13:50:00.000000", "creator": "623c129850bb2b0070b6b35d", "customFieldValues": [ { "fieldName": "CI Pipeline/s", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "value": "puppet-enterprise" }, { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@664a1920" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03nrc:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "5.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_591341274_*|*_3_*:*_1_*:*_81877790_*|*_10009_*:*_1_*:*_956218500_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_7361998151" } ], "description": "figure for antivirus / security scanners.\u00a0 We don't maintain an exclusion list as we haven't found a general need to configure a consistent set of exclusions.\u00a0 Below is the text that was provided by support to an EMEA customer in regards to this and is the suggested stance to include in the docs.\u00a0 I believe this is new text and not a modification to existing text.\n\n*Suggested improvement:*\n\n_<_\n * Our company doesn't have an official stance on antivirus products.\n * Third-party virus and security software are known to utilize system processing power. Resource allocations should be increased and scaled to accommodate.\u00a0\n * Some antivirus software wants to use port 8081, which is the same port used by puppetDB. Not everyone encounters this issue, but it should be considered when installing software.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54913", "fixedVersions": [], "id": "54913", "issueType": "CI Blocker", "key": "DOCUMENT-1144", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c129850bb2b0070b6b35d", "resolution": "Done", "resolutionDate": "2020-11-30T14:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Provide Puppet stance on providing antivirus exclusion list", "timeSpent": "PT0S", "updated": "2020-11-30T14:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Whoops, I think I got wires crossed on this one. I removed the post-req for running {{puppet infra tune}} from the configure compilers topic, and kept it only on the convert topic. Thanks for the correction [~accountid:5c2ff333c5484b691dd2c43a]. Docs will update with next build.", "created": "2020-08-18T11:02:00.000000" }, { "author": "5c2ff333c5484b691dd2c43a", "body": "Perfect thanks [~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0!!", "created": "2020-08-19T02:09:00.000000" } ], "components": [], "created": "2020-08-18T07:17:00.000000", "creator": "5c2ff333c5484b691dd2c43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4cd1a620" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03nb4:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "41985" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10104227_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3365499" } ], "description": "*Problem:*\n\nDocumentation for 2019.8 is incorrect when it comes to running puppet infra tune as this is not taken into consideration by the tune script.\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/installing_compilers.html]\n\n_Current text :_\u00a0\n{noformat}What to do next:\nRun\u00a0puppet infrastructure tune\u00a0on your master and adjust tuning for compilers as needed.{noformat}\n\u00a0\n\n_Suggested improvement: This should be removed, as compilers should autotune. The exception here is the legacy compilers which you would manually tune._\u00a0\n{code:java}# This version of Puppet Enterprise optimizes tuning settings for PE Compilers (Compilers with Puppet Server and PuppetDB) by default\n# Remove any tuning settings for PE Compilers defined in Hiera and/or the Classifier (Console) to use default tuning settings.\n{code}\n\u00a0\n\n*Summary:*\u00a0\n\nRemove reference to puppet infra tune when configuring compilers on 2019.8\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54912", "fixedVersions": [], "id": "54912", "issueType": "Bug", "key": "DOCUMENT-1143", "labels": [ "jira_escalated", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c2ff333c5484b691dd2c43a", "resolution": "Fixed", "resolutionDate": "2020-08-18T11:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "remove puppet infra tune in compiler recommendations", "timeSpent": "PT0S", "updated": "2020-12-23T19:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Good catch! This is fixed and should update with our next automated docs build.", "created": "2020-08-17T09:57:00.000000" } ], "components": [], "created": "2020-08-14T21:52:00.000000", "creator": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@48eee6b4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03lns:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_216348997_*|*_5_*:*_1_*:*_0" } ], "description": "Most of the examples of curl commands on this page: [https://puppet.com/docs/pe/2019.8/value-dashboard.html]\u00a0 are all missing a slash after https.\n\n\u00a0\n\ni.e. it says https:/\u00a0\u00a0 where it should say https://", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54517", "fixedVersions": [], "id": "54517", "issueType": "Bug", "key": "DOCUMENT-1142", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:81aad93f-ebcc-41dc-bcb2-0fd3d2ca52e3", "resolution": "Fixed", "resolutionDate": "2020-08-17T09:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Fix the URI in value analytics page", "timeSpent": "PT0S", "updated": "2020-09-01T11:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Hi [~accountid:557058:4c3e0433-b7ac-41b0-aa58-a3b8f117a449], I'm working on getting a redirect up for this. That doc has been moved to the module's repo: https://github.com/puppetlabs/puppetlabs-bolt_shim/blob/master/docs/connect_bolt_pe.md", "created": "2020-08-07T09:41:00.000000" }, { "author": "557058:4c3e0433-b7ac-41b0-aa58-a3b8f117a449", "body": "Thanks for the link [~accountid:5b0340d43eafdb09dee5bc3a]!", "created": "2020-08-07T10:09:00.000000" } ], "components": [ "bolt" ], "created": "2020-08-07T08:35:00.000000", "creator": "557058:4c3e0433-b7ac-41b0-aa58-a3b8f117a449", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ed8eb53" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03htk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_3361254_*|*_3_*:*_1_*:*_292585965_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\n\u00a0On the \"Connecting Bolt to PE\" docs, the primary link for additional info leads to a 404.\n\npage: [https://puppet.com/docs/bolt/latest/bolt_configure_orchestrator.html]\n\nlink location: [https://puppet.com/docs/pe/latest/bolt_configure_orchestrator.html]\n\n\u00a0\n\n*Suggested improvement:*\n\n_[https://puppet.com/docs/bolt/latest/bolt_configure_orchestrator.html]_\n\n\u00a0\n\n_Current text :_ \n\nFor information on connecting Bolt to PE, see [Connecting Bolt to PE|https://puppet.com/docs/pe/latest/bolt_configure_orchestrator.html].\n\n\u00a0\n\n_Suggested improvement:_ \n\n*Fix the link*, if a valid destination exists? I'm not finding anything of interest in the docs where the destination used to reside.\n\nMaybe [https://puppet.com/docs/pe/2019.8/configuring_puppet_orchestrator.html] ?\n\n\u00a0\n\n*Summary:*\n\n\u00a0Following the docs for getting all published information on getting Bolt connected with PE results in finding a broken link.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54690", "fixedVersions": [], "id": "54690", "issueType": "Bug", "key": "DOCUMENT-1141", "labels": [ "bolt", "orchestrator", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:4c3e0433-b7ac-41b0-aa58-a3b8f117a449", "resolution": "Fixed", "resolutionDate": "2020-08-10T18:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken link in Bolt documentation", "timeSpent": "PT0S", "updated": "2020-08-10T18:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Thanks Jerald! The web team is investigating", "created": "2020-08-07T10:00:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The web team is still trying to determine the issue with why certain words freeze the search. We've filed a web ticket for it, and I'm linking that to this ticket. The web project is internal (as you mentioned), so you won't be able to see that ticket, [~accountid:557058:0d7973c8-5a21-4b72-9668-d3d17b0febda], but we're working on it. I'm marking this ticket as blocked in the meantime. And thank you for filing this issue!", "created": "2020-08-19T16:50:00.000000" } ], "components": [], "created": "2020-08-05T13:42:00.000000", "creator": "557058:0d7973c8-5a21-4b72-9668-d3d17b0febda", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3009226d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03gko:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_159593043_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_13567804630" } ], "description": "*Problem:*\n\n\u00a0This is a problem with the website itself. The WEB category is not visible publicly. I was instructed by an employee to open it here so it can be recategorized to WEB. \u00a0Please forgive.\n\n\u00a0\n\nThe search component of the documents section of the Puppet website has a rather harsh bug that will hard-lock a browser. \u00a0This works on Safari, Chrome, and Firefox. If navigating to the Puppet documentation ([https://puppet.com/docs/puppet/6.17/puppet_index.html|https://puppet.con/docs/puppet/6.17/puppet_index.html]\u00a0and entering on the \"Search tool\" at the top of the page the letters: \u00a0\"csrgen\" (without quotes), the search bar hangs the browser hard such that you need to \"force quit\" the browser. \u00a0Also, the CPU on the machine takes off and begins to push CPU and start the fans if you do not kill the browser.\n\nI want to for \"csrgen.rb\" because this is a script that is used when generating a certificate signing request in the intermediate cert process. \u00a0\n\nThis is the Mac OSX platform.\n\n*Suggested improvement:*\n\n_Make it not die?_\n\n\u00a0\n\n*Summary:* \u00a0 Search bar freaks out at certain search terms and hangs hard.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55136", "fixedVersions": [], "id": "55136", "issueType": "Bug", "key": "DOCUMENT-1139", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0d7973c8-5a21-4b72-9668-d3d17b0febda", "resolution": "Fixed", "resolutionDate": "2021-01-11T09:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "web: docs search freeze issue", "timeSpent": "PT0S", "updated": "2021-01-11T09:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "5c13fcdd55c77c50912350c8", "created": "2020-08-20T17:41:00.000000", "name": "Firewall configuration for XL installations with compilers and standalone PE-PostgreSQL.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14217" } ], "comments": [ { "author": "5c13fcdd55c77c50912350c8", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0The updated diagram is attached to this ticket.", "created": "2020-08-20T17:41:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is fixed in 2019.8+. Should update with our next automated docs build.", "created": "2020-08-21T10:00:00.000000" } ], "components": [], "created": "2020-07-29T15:29:00.000000", "creator": "6220db7149c90000701fd082", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@295d2d05" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03cio:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "40219" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_500522223_*|*_5_*:*_1_*:*_0_*|*_10010_*:*_1_*:*_234366160_*|*_10004_*:*_1_*:*_1050501059_*|*_10006_*:*_1_*:*_182097879_*|*_10005_*:*_1_*:*_23649" } ], "description": "*Problem:*\n\nThe diagram on the System Configuration page does not show any connections between compilers and the PostgreSQL node for XL installations. This can cause (and has caused) a client to mistakenly open up port 5432 between the compiler and master, expecting the legacy compiler conversion to work.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/system_configuration.html#firewall_xl]\n\n(this is also incorrect on 2019.7 docs)\n\n_Current -text- image:_\n\nNo arrow for port 5432 splitting off from \"Compilers\" to \"PE-PostgreSQL\"\n\n_Suggested improvement:_\n\n*An arrow for port 5432 splitting off from \"Compilers\" to \"PE-PostgreSQL\"*\n\n*Summary:*\n\nThe system configuration diagram for XL environments needs to show port 5432 opened between Compilers and the external PE-PostgreSQL node.\n\n\u00a0Related to DOCUMENT-1135", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54212", "fixedVersions": [], "id": "54212", "issueType": "Task", "key": "DOCUMENT-1136", "labels": [ "graphics", "jira_escalated", "pe", "small", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "resolution": "Fixed", "resolutionDate": "2020-08-21T10:01:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "System Configuration diagram doesn't show PSQL <-> Compiler port requirements", "timeSpent": "PT0S", "updated": "2020-08-21T10:01:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "6220db7149c90000701fd082", "body": "I see this has been set to \"Needs Information\". Is there anything in particular that's needed?", "created": "2020-08-04T11:14:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953], what do we need on this?", "created": "2020-08-06T12:20:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Confirmed with Engineering. Update in 2019.8 and 2019.8.z in these two topics:\n* https://puppet.com/docs/pe/2019.8/installing_compilers.html#convert-compiler\n* https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade_standard\n\n{quote}\nOpen port 5432 from compilers to the master or, in extra-large installations, the PE-PostgreSQL node. \n{quote}", "created": "2020-08-06T13:10:00.000000" }, { "author": "6220db7149c90000701fd082", "body": "Will this additionally be updated in our 2019.7 docs?", "created": "2020-08-06T13:16:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is fixed in 2019.8 and 2019.8.1, and will update with the next automated docs build. We don't make routine fixes like this to superseded docs versions, e.g., 2019.7.", "created": "2020-08-07T16:08:00.000000" } ], "components": [], "created": "2020-07-29T15:05:00.000000", "creator": "6220db7149c90000701fd082", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@18b5f0ca" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03ci0:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "40219" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_502053960_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_182244239_*|*_10006_*:*_2_*:*_97065853" } ], "description": "*Problem:*\n\n\u00a0Documentation for converting legacy compilers only specifies opening port 5432 from the compiler to the master. If the client uses an external PostgreSQL node, these instructions will not work.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.8/installing_compilers.html#convert-compiler]\n\n(this is also incorrect on 2019.7 docs)\n\n_Current text:_\n{quote}Open port 5432 from compilers to your master.\n{quote}\n_Suggested improvement:_\n{quote}Open port 5432 from compilers to *the node hosting Puppet\u2019s PostgreSQL, typically the master.*\n{quote}\n*Summary:*\n\nThe port required for converting legacy compilers needs to account for more than just standard installations.\n\nRelated to DOCUMENT-1136", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55035", "fixedVersions": [], "id": "55035", "issueType": "Task", "key": "DOCUMENT-1135", "labels": [ "jira_escalated", "pe", "small", "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db7149c90000701fd082", "resolution": "Fixed", "resolutionDate": "2020-08-07T16:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Compiler Conversion instructions only includes opening ports for Standard Installs", "timeSpent": "PT0S", "updated": "2020-08-07T16:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b5a27ad106ec32d95ea277d", "attachments": [], "comments": [ { "author": "5b5a27ad106ec32d95ea277d", "body": "Hi [~accountid:6220db724160640069c71347], this ticket looks to be a duplicate of one we're already working on, namely\u00a0https://puppet.atlassian.net/browse/DOC-4634. Are you able to confirm? Thank you!\n\n\u00a0", "created": "2020-07-28T10:09:00.000000" }, { "author": "6220db724160640069c71347", "body": "Hey [~accountid:5b5a27ad106ec32d95ea277d], I took a look at DOC-4643 and can confirm that this is a duplicate.", "created": "2020-07-28T10:34:00.000000" }, { "author": "5b5a27ad106ec32d95ea277d", "body": "Great, thank you [~accountid:6220db724160640069c71347]. I will close this ticket. I should have the other finished by today or tomorrow.\u00a0", "created": "2020-07-28T11:02:00.000000" } ], "components": [], "created": "2020-07-24T17:48:00.000000", "creator": "6220db724160640069c71347", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@62c53dab" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o03aag:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_317853958_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3448441" } ], "description": "*Problem:*\n\nLooks like there is some sort of formatting error in the \"_Puppet Server: Intermediate CA_\" doc, where the wrong portions are in code blocks for steps 6, 7 and 8.\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppetserver/latest/intermediate_ca.html#set-up-puppet-as-an-intermediate-ca-with-an-external-root\n\n_Current text :_\n\n6. Concatenate all of the certs into a PEM file, starting with the new Puppet CA cert and ending with your organization\u2019s root cert. The file should contain the PEM-encoded certs, like this: ``` \u2014\u2013BEGIN CERTIFICATE\u2014\u2013\n \u2014\u2013END CERTIFICATE\u2014\u2013 \u2014\u2013BEGIN CERTIFICATE\u2014\u2013 \u2014\u2013END CERTIFICATE\u2014\u2013 \u2014\u2013BEGIN CERTIFICATE\u2014\u2013 \u2014\u2013END CERTIFICATE\u2014\u2013\n\n7. Concatenate all of the CRLs into a PEM file, in the same order as the certificates. The file should contain the PEM-encoded CRLs, like this:\n\u2014\u2013BEGIN X509 CRL\u2014\u2013 \u2014\u2013END X509 CRL\u2014\u2013 \u2014\u2013BEGIN X509 CRL\u2014\u2013 \u2014\u2013END X509 CRL\u2014\u2013 \u2014\u2013BEGIN X509 CRL\u2014\u2013 \u2014\u2013END X509 CRL\u2014\u2013\n\n8. Use the `puppetserver ca import` command to trigger the rest of the CA setup:\npuppetserver ca import \u2013cert-bundle ca-bundle.pem \u2013crl-chain crls.pem \u2013private-key puppet_ca_key.pem ```\n\n_Suggested improvement:_\n\n*_The steps should be code blocked like this._*\n\n_6. Concatenate all of the certs into a PEM file, starting with the new Puppet CA cert and ending with your organization\u2019s root cert. The file should contain the PEM-encoded certs, like this:_\n{quote}\u2014\u2013BEGIN CERTIFICATE\u2014\u2013\n\n\n\u2014\u2013END CERTIFICATE\u2014\u2013\n\n\u2014\u2013BEGIN CERTIFICATE\u2014\u2013\n\n\n\n\u2014\u2013END CERTIFICATE\u2014\u2013\n\n\u2014\u2013BEGIN CERTIFICATE\u2014\u2013\n\n\n\n\u2014\u2013END CERTIFICATE\u2014\u2013\n{quote}\n7. Concatenate all of the CRLs into a PEM file, in the same order as the certificates. The file should contain the PEM-encoded CRLs, like this:\n{quote}\u2014\u2013BEGIN X509 CRL\u2014\u2013\n\n\n\n\u2014\u2013END X509 CRL\u2014\u2013\n\n\u2014\u2013BEGIN X509 CRL\u2014\u2013\n\n\n\n\u2014\u2013END X509 CRL\u2014\u2013\n\n\u2014\u2013BEGIN X509 CRL\u2014\u2013\n\n\n\n\u2014\u2013END X509 CRL\u2014\u2013\n{quote}\n8. Use the `puppetserver ca import` command to trigger the rest of the CA setup:\n{quote}{{puppetserver ca import \u2013cert-bundle ca-bundle.pem \u2013crl-chain crls.pem \u2013private-key puppet_ca_key.pem}}{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54407", "fixedVersions": [], "id": "54407", "issueType": "Improvement", "key": "DOCUMENT-1134", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6220db724160640069c71347", "resolution": "Duplicate", "resolutionDate": "2020-07-28T11:03:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Formatting errors in \"Puppet Server: Intermediate CA\" Doc", "timeSpent": "PT0S", "updated": "2020-07-28T11:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Discussing with the Installer team this week.", "created": "2020-09-08T10:14:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "From discussion with the PE installation/upgrade team, this is really more of a product issue than a docs issue. On the product side, PE 2019.8 added more robust pre-upgrade checking, essentially codifying the checks from [Puppet Support's pre-upgrade module|https://github.com/puppetlabs/preupgrade_check]. Additionally, FM-7628 has has been resolved. Given these recent fixes and improvements, I'm not able to pick out any actionable changes for docs specifically, so closing this as won't fix. \n\nWith regard to your pending issues:\nFor item 2, I honestly have no idea what the problem is here. I'll ping Engineering on this internally to see if anyone has suggestions.\nFor item 3, I would suggest commenting in FM-7628 if you still need a workaround. ", "created": "2020-09-08T17:18:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Followup re: item 2, the engineer I consulted suspected this is likely due to nginx not restarting after upgrade. They recommended reaching out to support for help diagnosing the issue. ", "created": "2020-09-09T09:57:00.000000" } ], "components": [], "created": "2020-07-24T01:00:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1f77a78c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o039k8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Sep/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_984789899_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3048368727" } ], "description": "*Problem:*\n\n\u00a0PE upgrade information is inadequate. Pre & Post check list is not clear. Referred the upgrade cautions but which is not given complete information.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.5/upgrading_pe.html]\n\n_Current text :_\n\n*Upgrade Cautions:* referred the upgrade cautions column but not given the complete information which we have to check before upgrade.\u00a0\n\n_Suggested improvement:_\n\nRequesting to provide the *PRE & POST Check List*\u00a0of PE upgrade. so that we can able to check what exactly broken and can refer the respective service/config files.\n\nMoreover would like to add those to *possible* errors in the doc.\u00a0\n\n*Summary:*\n\n\u00a0I am done the PE upgrade from 2019.1.0 to 2019.5.0 by referring :\u00a0[https://puppet.com/docs/pe/2019.5/upgrading_pe.html]\n\nAs we do not have any *Pre & Post check list* , landed into the below issues.\n # Puppet tasks are not running due to invalid/*old* token. Able to execute the tasks once i *generate the token*. Which not covered in the doc.\n # Getting Bad gateway 502 error while calling the Status API's for HTTP endpoint.\u00a0Post upgrade its override by https endpoint which we can able to access without any issue with the port 4433.\nBut not mentioned how to enable the HTTP endpoint (port:8123) back.\u00a0Post upgrade also console_services_plaintext_status_enabled value already *true.*\u00a0But still unable to access the Status API with HTTP endpoint. *(still issue is open)*\n # Puppet agents are not getting upgrade. As PXP-Agents are not getting shutdown with in 2 mins.\u00a0 mentioned in the module its a known issue :\u00a0\nhttps://puppet.atlassian.net/browse/FM-7628\u00a0but i am unable to view the content it.\u00a0*(still issue is open)*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54405", "fixedVersions": [], "id": "54405", "issueType": "Improvement", "key": "DOCUMENT-1133", "labels": [ "large", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Won't Do", "resolutionDate": "2020-09-08T17:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE upgrade information is inadequate", "timeSpent": "PT0S", "updated": "2020-09-09T09:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Fair point! I had to do some digging to turn up more relevant details. This bullet should be revised like so:\n\n* PE client tools - On unmanaged nodes only, you must re-install the version of client tools that matches the PE version you upgraded to. Client tools are automatically updated on infrastructure nodes and managed nodes** when you upgrade PE. \n\n...and add a (reltable) link to https://puppet.com/docs/pe/2019.8/installing_pe_client_tools.html#install_pe_client_tools_on_an_unmanaged_nix_workstation\n\n'** Need to confirm that managed nodes with the {{puppet_enterprise::profile::controller}} class applied are automatically updated.", "created": "2020-07-23T13:27:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Hi Melissa Amos,\u00a0\n\nThanks for your response, Here we are upgrading to 2019.5.0 where the info is inadequate.\u00a0\n\n[https://puppet.com/docs/pe/2019.5/upgrading_pe.html\n]\n\n*PE\u00a0client tools* \u2014 Install the appropriate version of client tools that matches the\u00a0PE\u00a0version you upgraded to.\n\nIt should be good to provide how to check what are client tools installed currently.\u00a0 And it should be good to provide the installation process of client tools & pre checks before installing the latest version.", "created": "2020-07-24T01:07:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:5abd613dd4cf3c56be24b70d] Can you please help with these questions about PE client tools?\n\n# Are managed nodes with the puppet_enterprise::profile::controller class automatically updated with the latest PE client tools package when you upgrade PE?\n# Is there a command to check what version of client tools you have installed?", "created": "2020-08-11T10:27:00.000000" }, { "author": "5abd613dd4cf3c56be24b70d", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\u00a0apologies for the late response.\n # Yes, the next puppet run on all the nods with\u00a0puppet_enterprise::profile::controller class will upgrade the\u00a0 pe-clien-tools to the version shipped with the upgraded PE.\n # the PE Client tools package is a package that contains multiple executables. The version of each individual executable can be checked using \\{client-tool-name} \u2013version. For example:\n\n{code:java}\n[root@scant-discredit ~]# puppet-code --version\npuppet-code version 3.0.2 {code}\nChecking of the version of the package that contains each client tool is OS specific, for instance, on redhat:\n\n\u00a0\n{code:java}\n[root@scant-discredit ~]# rpm -q pe-client-tools\npe-client-tools-19.8.2-1.el7.x86_64 {code}\nPlease note that we will release a new version of the pe-client-tools package even if only one of the client tools is updated.\n\n\u00a0\n\nHope this helps!\u00a0", "created": "2020-08-17T07:32:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "I updated the [upgrade|https://puppet.com/docs/pe/2019.8/upgrading_pe.html#upgrade_standard] instructions to specify that you have to manually update client tools only on unmanaged nodes. I also added similar instruction to the [PE client tools page|https://puppet.com/docs/pe/2019.8/installing_pe_client_tools.html], plus a new note about how to check the version of client tools.", "created": "2020-08-18T11:25:00.000000" } ], "components": [], "created": "2020-07-22T04:03:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3b34e7b4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o037y8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_119290521_*|*_3_*:*_1_*:*_4342472_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_2235680648" } ], "description": "*Problem:*\n\nDocument of PE upgrade 2019.5 standard installation is not clear.\n\nPE\u00a0client tools \u2014 Install the appropriate version of client tools that matches the\u00a0PE\u00a0version you upgraded to.\n\nwhat are the PE client tools and how to check which are installed ? information was missed.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.5/upgrading_pe.html#upgrade_standard]\n\n_Current text :_\n\nPE\u00a0client tools \u2014 Install the appropriate version of client tools that matches the\u00a0PE\u00a0version you upgraded to.\n\n_Suggested improvement:_\n\nNeed to inform what are the *PE client Tools,*\u00a0How to *check* which PE Client tools are synced with PE. *Up gradation/installation* process of PE client tools*.*\n\n*Summary:*\n\n\u00a0", "environment": "Developement and production", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54094", "fixedVersions": [], "id": "54094", "issueType": "Improvement", "key": "DOCUMENT-1132", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Fixed", "resolutionDate": "2020-08-18T11:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE client tools \u2014 Install the appropriate version of client tools that matches the PE version you upgraded to.", "timeSpent": "PT0S", "updated": "2020-08-18T11:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "HTTP is disabled by default, so that is why it is not working after an upgrade. Instructions for enabling it are at the bottom of the previous page for Authenticating the status API:\u00a0[https://puppet.com/docs/pe/2019.5/status_api_authenticating.html]\n\n_To use HTTP, locate the\u00a0*PE Console*\u00a0node group in the console, and in the\u00a0*puppet_enterprise::profile::console*\u00a0class, set\u00a0*console_services_plaintext_status_enabled*\u00a0to\u00a0*true*._\n\nFor clarity, I've added a link to the Authenticating page that will be available in the current and future versions of PE docs.\n\n\u00a0", "created": "2020-07-22T11:05:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Hi Logan,\n\n\u00a0\n\nThanks for your comment. Post upgrade also console_services_plaintext_status_enabled option was set as true.\n\nStill we are getting 502 badgateway error. As a part of troubleshooting i switched it as false and ran puppet and again switched back to true and ran the puppet.\n\n\u00a0\n\nStill no luck. As Https is default one, it's working as expected.\n\nDo we need to change Anywhere ?", "created": "2020-07-22T11:21:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I'm sorry about that vinay. This seems like it may be a product issue, so I am going to put this in \"needs information\" until there is an answer on\u00a0ENTERPRISE-1365\n\n\u00a0", "created": "2020-07-22T12:30:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Hi Logan,\n\n\nThanks for your update. Its still in open state\u00a0ENTERPRISE-1365\n\nI think HTTPS is overridden hence i am unable to access the status API with http endpoint.\u00a0\n\nKindly\u00a0assist me, do we need to check/modify any config files to enable the HTTP endpoint.\n\n\u00a0", "created": "2020-07-23T04:48:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:623c0a1a761efb0069ce016b], after speaking with [~accountid:557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca]\u00a0in support, there are no docs updates needed for this item. ENTERPRISE tickets in JIRA are generally for engineering to track bug fixes. To get help more quickly, I would recommend submitting a support request with the support team directly.\u00a0[https://support.puppet.com/hc/en-us]\u00a0", "created": "2020-07-23T09:07:00.000000" }, { "author": "623c0a1a761efb0069ce016b", "body": "Hi Logan,\n\nThanks for your response. Yeah , I will raise the support request.\n\nI suggest document should be update with more information regarding the enable of HTTP endpoint.\u00a0\n\n\u00a0", "created": "2020-07-23T23:29:00.000000" } ], "components": [], "created": "2020-07-20T04:59:00.000000", "creator": "623c0a1a761efb0069ce016b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2d1f5c8e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o035kg:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_107988448_*|*_5_*:*_1_*:*_1814305_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_74248790_*|*_10005_*:*_1_*:*_90055425" } ], "description": "*Problem:*\n\nIn the\u00a0 *Forming requests to the status API*\u00a0, its not clearly describing if not enabled HTTP.\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.5/status_api_forming_requests.html]\n\n_Current text :_\n\nIf enabled, the HTTP status endpoints are available on port 8123.\n\n_Suggested improvement:_\n\n*If enabled*, the HTTP status endpoints are available on port 8123. What it refers ?\u00a0\n\nIf its not enabled, need to explain how to enable the *HTTP.*\n\n*Summary:*\n\n\u00a0we have done with the upgradation from 2019.1.0 to 2019.5.0.\n\nbefore up grade we are able to access the status API.\u00a0\n\nPost upgrade we are unable to access the status API. Getting 502 bad gateway.\n\nDocument was unclear, and its not redirecting us to how to enable *HTTP*\u00a0on PE.\n\n\u00a0", "environment": "Development", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54208", "fixedVersions": [], "id": "54208", "issueType": "Improvement", "key": "DOCUMENT-1131", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a1a761efb0069ce016b", "resolution": "Done", "resolutionDate": "2020-07-23T09:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "HTTP endpoint status is not clear", "timeSpent": "PT0S", "updated": "2020-07-23T23:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks for the feedback [~accountid:618d797d5fe6c70069ed5ac7]. Yes, you should look for a clean Puppet run on all of your infrastructure nodes before upgrading. This seems like it should go without saying, but I'm open to further arguments to the contrary. For now, I'm closing this as won't fix, and I'll keep an eye on whether we get more feedback about it. ", "created": "2020-08-07T17:15:00.000000" } ], "components": [ "Upgrader" ], "created": "2020-07-15T21:52:00.000000", "creator": "618d797d5fe6c70069ed5ac7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4e418f20" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o033hk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_476025653_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1299090723_*|*_10005_*:*_1_*:*_195512556" } ], "description": "The Upgrade Guide and of course the puppet infrastructure cmd documentation should have the Hint or requirement for a clean Puppet Agent run ( return Code 0 or 2 ) bevor a Upgrade or modifing of the puppet infrastructure.\n\npuppet infrastructure upgrade compiler will fail if the puppet agent run on the Compiler has errors.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54090", "fixedVersions": [], "id": "54090", "issueType": "New Feature", "key": "DOCUMENT-1130", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "618d797d5fe6c70069ed5ac7", "resolution": "Won't Do", "resolutionDate": "2020-08-07T17:16:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Requirement of clean Puppet agent run", "timeSpent": "PT0S", "updated": "2020-08-07T17:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "623c11f9a2f6400069eb7b1e", "body": "FYI: After you self-assigned the issue, some things must have happened. The release notes for PuppetDB and Puppet Agent are up-to-date now.\n\nCheers\nThomas", "created": "2020-07-16T09:03:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you [~accountid:623c11f9a2f6400069eb7b1e]! I expect this was just the lag time between what happens on GitHub and the official release. The release notes aren't automated, and we don't publish them until everything for the release is ready and the announcement goes out. The packages in the repo are ready first, so you probably just got them while we were still prepping things for the release.", "created": "2020-07-20T10:22:00.000000" }, { "author": "623c11f9a2f6400069eb7b1e", "body": "So... to wrap this up, one could say: until there are no release notes (which are generated manually in your release process), a release does not count as \"officially released\".\n\nUnfortunately, this makes manual monitoring of the release notes page necessary. But OK. I can work with that. Thank you.\n\nCheers\nThomas", "created": "2020-07-20T10:40:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I wouldn't necessarily say that it's the release notes that make something \"officially released.\" It's a combination of coordinating all the component packages, final CI testing, updating web pages, releasing docs, and once all that is done, we sent out an email announcement. The parts generally don't align perfectly, so the release notes could potentially even go live a short time (~30m-1h) before the bits are released.\n\nWatching for the release announcement is probably the easiest and most reliable way to know whether all the bits are really in place. We send those announcements to:\n* pe-users@puppet.com\n* puppet-users@googlegroups.com\n* puppet-announce@googlegroups.com\n* puppet-security-announce@googlegroups.com\n\nI hope this helps!", "created": "2020-07-20T11:25:00.000000" } ], "components": [], "created": "2020-07-13T05:02:00.000000", "creator": "623c11f9a2f6400069eb7b1e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6f0ca700" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0300g:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_105050337_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_2_*:*_519078553" } ], "description": "Hi folks,\n\nI was wondering whether the generation of changelogs is automated, the reason being that as of now:\n\n* the changelogs for the [5.2.x PuppetDB|https://puppet.com/docs/puppetdb/5.2/release_notes.html] are at *5.2.14* while the packages for *5.2.15* are already available while [on Github|https://github.com/puppetlabs/puppetdb/releases] *5.2.16* is already listed as released\n* the same issue seems to apply to the puppet agent release notes\n\nSo: is there any reason for this? It is a bit of a nuisance to have new packages available while not being able to upgrade without knowing what the changes are.\n\nThanks for any information you can provide!\n\nCheers\nThomas", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54911", "fixedVersions": [], "id": "54911", "issueType": "Bug", "key": "DOCUMENT-1129", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c11f9a2f6400069eb7b1e", "resolution": "Fixed", "resolutionDate": "2020-07-20T10:24:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Release notes not always on par with available packages", "timeSpent": "PT0S", "updated": "2021-02-01T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for your suggestion! As this project is still considered in development, we won't add it to the main documentation yet. We will wait until it becomes supported.\u00a0", "created": "2020-07-21T03:57:00.000000" }, { "author": "5c083dd9ed26a5223c94f646", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] [~accountid:557058:31c596d1-7e27-4c91-bc18-1254edb3caab] [~accountid:623c135e1c7f6a007049e9ad] [~accountid:557058:55b23daa-f1aa-41fd-b10d-bf49a61932da] [~accountid:557058:fd17676f-b54f-4df6-b0e2-ce0f8a23c31e] [~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b] \n\nHey Team - could we please re-evaluate having official documentation for the Puppet Server Helm chart?", "created": "2021-05-03T04:31:00.000000" } ], "components": [ "Hiera", "installer", "Process", "PuppetDB", "Puppet Server" ], "created": "2020-07-05T08:01:00.000000", "creator": "5c083dd9ed26a5223c94f646", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@65410406" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-1" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Document the Availability and Core Usage of the Puppet Server Helm Chart" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_grey" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02ww8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_785662811_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_582090481" } ], "description": "*Problem:*\n\nThere's no documentation about the Puppet Server Helm chart and the general possibility to deploy Puppet Infrastructure in a Kubernetes cluster (bare-metal or cloud-based).\n\n\u00a0\n\n*Summary:*\n\nWe should document that possibility - it's a unique feature of Puppet across all Configuration Management software.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54258", "fixedVersions": [], "id": "54258", "issueType": "Epic", "key": "DOCUMENT-1128", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c083dd9ed26a5223c94f646", "resolution": "Won't Do", "resolutionDate": "2020-07-21T03:57:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Document Puppet Server Helm chart", "timeSpent": "PT0S", "updated": "2021-05-03T04:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is fixed in 2019.8, 2019.8.z, and latest-preview. Will update with next auto-build.", "created": "2020-07-02T16:51:00.000000" } ], "components": [ "PE" ], "created": "2020-06-30T12:05:00.000000", "creator": "557058:96b4f4c4-e16f-442c-a86e-c69864550276", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5dd6b61e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02u00:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1596859_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_188341898" } ], "description": "*Problem:*\n\nThe PE installation docs currently are accurate and work correctly, but they are a little confusing.\n\nOn [https://puppet.com/docs/pe/2019.8/installing_pe.html] there's a section called *Install PE*. Step 1 in that section says \"On your master, log in as root....\" and then the other steps explain the rest of the installation process. The problem is that it's easy to miss the \"log in as root\" part of the instructions.\n\nIf you do fail to log in as root, steps 1-3 work fine but steps 4 and 5 fail without giving any hints about what you did wrong, or that you need to redo the steps as root.\n\nThis problem is exacerbated by this command in step 3:\n{code}sudo ./puppet-enterprise-installer{code}\nThis is misleading because the *sudo* suggests that you're not root already. It's easy to spot this\u00a0*sudo*\u00a0in step 3 and think \"guess I don't need to be root for the other steps,\" which makes it even easier to overlook the part of step 1 that tells you to log in as root.\n \u00a0\n *Suggested improvement:*\n\nOption 1: just boldface the \"*log in as root*\"\u00a0text in step 1\n\nOption 2 (preferred): boldface the \"*log in as root*\" text in step 1 and also\u00a0add a command for switching to root if you're on a system that doesn't let you log in as root directly (such as Ubuntu). Finally, highlight the need to be root. Text that covers all of these suggestions could look like this:\n{quote}On your master, *log in as root*, either by logging in directly as root or by switching to the root user with this command:\n{code:java}sudo su - {code}\nThe rest of these steps require root permissions.\n{quote}\nRegardless of whether we do option 1 or option 2, we should also remove *sudo* from the command in step 3.\n\nCurrent text:\n{code:bash}sudo ./puppet-enterprise-installer\n{code}\nNew text:\n{code:bash}./puppet-enterprise-installer\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54910", "fixedVersions": [], "id": "54910", "issueType": "Improvement", "key": "DOCUMENT-1126", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:96b4f4c4-e16f-442c-a86e-c69864550276", "resolution": "Fixed", "resolutionDate": "2020-07-02T16:51:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE installation docs should highlight need to install as root", "timeSpent": "PT0S", "updated": "2020-07-08T12:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "5e3375e183d74c0e821851f3", "body": "[~accountid:5c2ff333c5484b691dd2c43a] we believe this was an intentional change. It does seem to leave out some information if the customers have previously configured these parameters. \n\n[~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100] Was this intentional?", "created": "2020-07-02T17:30:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Please review history on this change in PE-29096, and reopen this ticket if there are additional changes needed.", "created": "2020-07-07T16:24:00.000000" } ], "components": [], "created": "2020-06-24T06:57:00.000000", "creator": "5c2ff333c5484b691dd2c43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@673a61d2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02ow8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_454716382_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_702530360" } ], "description": "*Problem: Doc is missing a step to point\u00a0browser_ssl_cert and\u00a0browser_ssl_private_key to new keys when using your own ssl cert for the console.*\u00a0\n\n\u00a0\n\n*Suggested improvement: Add steps from 2019.5 to 2019.7 and 2019.8*\n\n[https://puppet.com/docs/pe/2019.8/use_a_custom_ssl_cert_for_the_console.html]\n\n_Current text : Only has 3 steps_\n\nInclude the text that should be corrected or improved here.\n\n_Suggested improvement: Add all 5 steps from\u00a0[https://puppet.com/docs/pe/2019.5/use_a_custom_ssl_cert_for_the_console.html]_\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary: This needs to include the changes you also make on the console for this to take effect otherwise the settings get ignored.*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54582", "fixedVersions": [], "id": "54582", "issueType": "Bug", "key": "DOCUMENT-1123", "labels": [ "support" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c2ff333c5484b691dd2c43a", "resolution": "Won't Fix", "resolutionDate": "2020-07-07T16:24:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Missing step", "timeSpent": "PT0S", "updated": "2021-11-30T06:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks for this feedback [~accountid:623a4d66d32a94006a63cac6]. I made some changes to the agent installation page that will hopefully better surface the download link when it's needed. \n\nSome specifics: there are lots of install methods documented on this page, and only some of them require you to manually download the agent tarball. (For example, you don't have to download the tarball if you install from the console or with PE package management.) I reviewed all the install methods and made sure that, if appropriate, they include the tarball-download prereq. \n\nThis fix is building now and should be published shortly.", "created": "2020-07-08T12:05:00.000000" }, { "author": "623a4d66d32a94006a63cac6", "body": "Sure thing [~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\n\nSounds like a good update to me! Thanks for making these changes.", "created": "2020-07-10T08:28:00.000000" } ], "components": [], "created": "2020-06-22T08:58:00.000000", "creator": "623a4d66d32a94006a63cac6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@25c0ca9a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02njk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_13987389_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1379662831" } ], "description": "The location to download the Puppet agent tarball for various Puppet Enterprise versions is a small link contained on the following resoruce: https://puppet.com/docs/pe/latest/installing_agents.html#install_nix_agents_with_your_own_package_management\n\nAs a user I would like this in a more accessible location, with a larger font that is easier for a person looking for this information to locate.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54909", "fixedVersions": [], "id": "54909", "issueType": "Improvement", "key": "DOCUMENT-1122", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Low (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4d66d32a94006a63cac6", "resolution": "Fixed", "resolutionDate": "2020-07-08T12:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE agent tarball download difficult to locate", "timeSpent": "PT0S", "updated": "2020-07-10T08:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "[~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64], here's the Orch API additions.", "created": "2020-06-18T16:31:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12]\u00a0these updates are in and ready to go for Marshall.\u00a0\n\n[https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_plan_jobs_endpoint.html]\n\n[https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_events.endpoint.html|https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_events.endpoint.html#event-types]", "created": "2020-06-22T11:38:00.000000" }, { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "[~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64], looks good. I wonder if we want to put {{include}} and {{exclude}} in the monospaced font in this line in emphasize that those are the acceptable param values?\n\n{quote}\nresults: whether to include or exclude the plan output for each plan in the list (default \"include\").\n{quote}", "created": "2020-06-22T11:43:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Ah yes, good catch. I've updated it and the change will build shortly.\u00a0", "created": "2020-06-22T13:08:00.000000" } ], "components": [], "created": "2020-06-18T16:25:00.000000", "creator": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5ddd83fd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02mso:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_324743967_*|*_3_*:*_1_*:*_1560_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3616257" } ], "description": "h2. [Puppet orchestrator API: plan jobs endpoint|https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_plan_jobs_endpoint.html#orchestrator_api_get_plan_jobs]\n\nAdd the results parameter to the GET /plan_jobs endpoint:\n\n- results: whether to include or exclude the plan output for each plan in the list (default \"include\").\n\nh2. [Puppet orchestrator API: events endpoint|https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_events.endpoint.html#event-types]\n\nAdd job_stopping and job_finished events\n\n- job_stopping: created when a stop request is received and the job is running.\n- job_finished: created when a job is no longer running. The details contain final state. This should always be the last event for a job.\n\nh2. [GET /plan_jobs/:job-id/events|https://puppet-docs-preview.netlify.app/docs/pe/latest-preview/orchestrator_api_events.endpoint.html#orchestrator_api_get_plan_jobs_job_id_events]\n\nAdd apply_prep_start to Event Types\n\n- apply_prep_start: created when an apply_prep is run as part of a plan is started\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54087", "fixedVersions": [], "id": "54087", "issueType": "Improvement", "key": "DOCUMENT-1120", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "resolution": "Fixed", "resolutionDate": "2020-06-22T11:38:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Updates to Orchestrator API docs", "timeSpent": "PT0S", "updated": "2020-06-22T13:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "This is fixed in master. Change will go live after the next release", "created": "2020-06-16T14:33:00.000000" } ], "components": [], "created": "2020-06-16T06:25:00.000000", "creator": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@73d40916" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02kc0:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9016298_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_20283067" } ], "description": "The given example for Bolt's puppetdb plugin ([https://puppet.com/docs/bolt/latest/using_plugins.html]) is documented as:\u00a0\n{code:java}targets:\n - _plugin: puppetdb\n query: \"inventory[certname] { facts.osfamily = 'RedHat' }\"\n target_mapping:\n alias: facts.hostname\n name: certname\n facts:\n custom_fact: facts.custom_fact\n features:\n - facts.custom_feature\n config:\n ssh:\n hostname: facts.networking.interfaces.en0.ipaddress\n vars:\n puppetversion: facts.puppetversion\n{code}\nHowever when a customer tested this, they were getting the error\n *Target does not have a host*\n\nIt turns out the key under *ssh:* should be named\u00a0*host* instead of *hostname*\n\nCorrect example:\n{code:java}targets:\n - _plugin: puppetdb\n query: \"inventory[certname] { facts.osfamily = 'RedHat' }\"\n target_mapping:\n alias: facts.hostname\n name: certname\n facts:\n custom_fact: facts.custom_fact\n features:\n - facts.custom_feature\n config:\n ssh:\n host: facts.networking.interfaces.en0.ipaddress\n vars:\n puppetversion: facts.puppetversion\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54257", "fixedVersions": [], "id": "54257", "issueType": "Bug", "key": "DOCUMENT-1119", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "resolution": "Fixed", "resolutionDate": "2020-06-16T14:33:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Bolt - target_mapping example is wrong for puppetdb plugin", "timeSpent": "PT0S", "updated": "2020-06-16T14:33:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "[https://github.com/puppetlabs/bolt/pull/1905]", "created": "2020-06-16T16:45:00.000000" } ], "components": [ "bolt" ], "created": "2020-06-10T07:27:00.000000", "creator": "5a028139c24efb3c4ed448c4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2a6c5880" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02ha0:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_527789103_*|*_3_*:*_1_*:*_758415289_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_24039547" } ], "description": "The last code example on the page is a PowerShell example for how to pass JSON parameters. The same example is printed twice.\n\n\u00a0\n\n[https://puppet.com/docs/bolt/latest/bolt_running_tasks.html]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54908", "fixedVersions": [], "id": "54908", "issueType": "Task", "key": "DOCUMENT-1116", "labels": [ "bolt", "docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a028139c24efb3c4ed448c4", "resolution": "Fixed", "resolutionDate": "2020-06-25T11:24:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PowerShell Example Duplicated", "timeSpent": "PT0S", "updated": "2020-06-25T11:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Fixed - the docs will update after our next automatic build", "created": "2020-06-09T11:48:00.000000" } ], "components": [ "bolt" ], "created": "2020-06-09T08:42:00.000000", "creator": "5a028139c24efb3c4ed448c4", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "All links on the page work." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6134d4d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o02gaw:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4897106_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_6258744" } ], "description": "The link to 'Tasks and plans' on the [Bolt documentation page for Bolt tasks is dead|https://puppet.com/docs/puppet/latest/bolt_tasks.html]. It appears to link to a combined page for writing tasks and plans (https://puppet.com/docs/bolt/latest/writing_tasks_and_plans.html) , but the current version of documentation has those two subjects split out so that writing tasks has its own page and writing plans is split into two more pages for writing plans in YAML vs Puppet language. See this page for those three links: https://puppet.com/docs/bolt/latest/bolt.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54123", "fixedVersions": [], "id": "54123", "issueType": "Task", "key": "DOCUMENT-1115", "labels": [ "bolt", "DOCS" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a028139c24efb3c4ed448c4", "resolution": "Fixed", "resolutionDate": "2020-06-09T11:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Dead Link in Bolt Documentation", "timeSpent": "PT0S", "updated": "2020-06-09T11:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for your feedback! I've updated the docs:\u00a0[https://puppet.com/docs/puppetserver/latest/config_file_webserver.html].", "created": "2020-06-03T00:32:00.000000" } ], "components": [ "Puppet Server" ], "created": "2020-06-02T04:31:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6209db43" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o027dc:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_14911233_*|*_10007_*:*_1_*:*_56776474_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_367505" } ], "description": "In the puppetserver webserver.conf documentation here: https://github.com/puppetlabs/puppetserver/blob/master/documentation/config_file_webserver.markdown#examples\n\nIt has the following comment:\n\n{quote}{{# Require a valid certificate from the client.}}{quote}\n\nBut then the next line has {{want}}, which does not require a valid client certificate. That would be {{need}}.\n\nAlso, the example configuration should replace the equal sign with colons; see SERVER-532.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54256", "fixedVersions": [], "id": "54256", "issueType": "Bug", "key": "DOCUMENT-1114", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2020-06-03T00:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "webserver.conf client-auth comment incorrect", "timeSpent": "PT0S", "updated": "2020-06-03T00:32:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for letting us know! This is now fixed.\u00a0", "created": "2020-06-04T01:29:00.000000" } ], "components": [], "created": "2020-05-31T22:08:00.000000", "creator": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@429e9f9e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o026sw:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_103681787_*|*_10007_*:*_1_*:*_147320663_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_20242109" } ], "description": "*Problem:\u00a0 On puppet style guide [https://puppet.com/docs/puppet/5.5/style_guide.html] , paragraph -> Array & Hashes has typo.*\n\n\u00a0\n\n*Suggested improvement:*\n\n_https://puppet.com/docs/puppet/5.5/style_guide.html_\n\n_Current text :Under Array & Hashes_\n\nEach element on its -on- own line.\n\n_Suggested improvement:_\n\nEach element on its *-on- own* line.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55135", "fixedVersions": [], "id": "55135", "issueType": "Bug", "key": "DOCUMENT-1113", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "resolution": "Fixed", "resolutionDate": "2020-06-04T01:29:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "fix typo in language style guide", "timeSpent": "PT0S", "updated": "2020-06-04T01:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I've updated the release notes for 5.5.20 to reference the correct CVE (CVE-2020-10663):\u00a0[https://puppet.com/docs/puppet/5.5/release_notes.html#resolved-issues]\n\nCVE2020-10933 was fixed in 6.15.0, and you can see it listed here:\u00a0[https://puppet.com/docs/puppet/latest/release_notes_puppet.html#puppet-resolved-issues-x.12.0].\n\nThanks for alerting up to these issues!\n\n\u00a0", "created": "2020-05-19T07:18:00.000000" } ], "components": [], "created": "2020-05-18T09:43:00.000000", "creator": "623a4d66d32a94006a63cac6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@691f71db" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o01xps:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/May/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_57251854_*|*_3_*:*_1_*:*_12023074_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_8406496" } ], "description": "CVE-2020-10933 listed as resolved in the 5.5.20 release notes appears to be a typo: https://puppet.com/docs/puppet/5.5/release_notes.html#resolved-issues\n\nwhat is actually fixed is CVE-2020-10663 per the DOCS tab in the Ruby version bump in ticket PA-3179: https://puppet.atlassian.net/browse/PA-3179\n\nGenerating this ticket to have CVE2020-10933 replaced with CVE-2020-10663 for the release notes.\n\nFor CVE2020-10933, this appears to have been resolved via the following, so another bullet point will have to be added: https://github.com/ruby/ruby/blob/v2_4_10/ext/json/json.gemspec#L7", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55034", "fixedVersions": [], "id": "55034", "issueType": "Task", "key": "DOCUMENT-1112", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4d66d32a94006a63cac6", "resolution": "Fixed", "resolutionDate": "2020-05-19T07:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CVE version discrepancy in Puppet 5.5.20 release notes", "timeSpent": "PT0S", "updated": "2020-05-19T07:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "\"Available\" versions can mean a lot of things, from the two versions of Puppet that we currently maintain to all versions of PE that have ever existed (since customers can literally still download PE 3)\n\nWhat we provide in the version switcher are the most recent versions of the two PE release tracks. Previous versions are listed and available on the docs archive page (https://puppet.com/docs/pe/latest/archived_pe_docs.html). This archive page is linked in both the sidebar navigation and in the version switcher.\n\nNumerous versions listed in the switcher is overwhelming for users. It also makes it unclear what the current supported versions are. Users and support still have access to the old docs, however.\n\nI know this is a change and will take a minute to adjust to, but we think that consistently adhering to this pattern improves user experience significantly.\n\nThe version switcher contains:\n* the current LTS (2018.1)\n* the current PE update (now 2019.7)\n* a link to \"Previous versions\" where customers can find all other previous versions of PE.\n\nTo give folks some time to update PE, we also should have the next most recent docs set in the switcher, so we're adding the previous PE update (2019.5) to the switcher as well.\n", "created": "2020-05-15T12:34:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Closing as won't fix--there is one more version we are adding to the switcher, but that work is already in progress.", "created": "2020-05-15T12:35:00.000000" }, { "author": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "body": "Who can we talk with to have an actual conversation about this? It feels like the people who made this decision are markedly disconnected from the actual needs of our customers.", "created": "2020-05-15T13:58:00.000000" } ], "components": [ "PE" ], "created": "2020-05-13T09:29:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@531523d9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o01utk:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/May/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_183950915_*|*_6_*:*_1_*:*_0" } ], "description": "The vanishing PE versions in the selector is a constant source of confusion and frustration for both our customers and our Support team. There is no actual indication what versions are available until you manually change them in the URL and hope that your changes actually work.\n\nWe have a significant percentage of our paying customers sill using PE versions that are not shown in that selector, and there are enough differences between them (and this isn't even including their relevant release notes and fixes) to warrant those customer needing specific versioned documents.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54402", "fixedVersions": [], "id": "54402", "issueType": "Task", "key": "DOCUMENT-1110", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Won't Fix", "resolutionDate": "2020-05-15T12:35:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Please restore all available PE versions to the Docs drop-down selector", "timeSpent": "PT0S", "updated": "2020-05-15T16:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [], "components": [ "Code Management" ], "created": "2020-04-27T05:26:00.000000", "creator": "5f0c180207efc4002805c9e2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@12ca2e0d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o01ki0:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_104117448_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1331351" } ], "description": "*Problem:*\n\nTypo at the code manager documentation.\u00a0\n\n*Suggested improvement:*\n\n__\u00a0[https://puppet.com/docs/pe/latest/code_mgr_config.html]_[|https://puppet.com/docs/pe/latest/code_mgr_config.html]_\n\n_Current text :_\n\nThe private key file must be located on the master, owned by the user, and located in a directory that the user has permission to view. We recommend\u00a0{color:#FF0000}{{/*ect*/puppetlabs/puppetserver/ssh/id-control_repo.rsa}}{color}\n\n_Suggested improvement:_\n\nThe private key file must be located on the master, owned by the user, and located in a directory that the user has permission to view. We recommend\u00a0{color:#FF0000}{{/*etc*/puppetlabs/puppetserver/ssh/id-control_repo.rsa}}{color}\n\n\u00a0\n\n*Summary:*\n\nDirectory typo needs to be fixed.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54893", "fixedVersions": [], "id": "54893", "issueType": "Bug", "key": "DOCUMENT-1103", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5f0c180207efc4002805c9e2", "resolution": "Fixed", "resolutionDate": "2020-04-28T10:43:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in the documentation", "timeSpent": "PT0S", "updated": "2020-04-28T10:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks [~accountid:623c09d6a2f6400069eb76ca]! I actually thought we'd fixed this issue, so I appreciate the ticket. We're looking into it further now.", "created": "2020-04-21T12:20:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I think we've got it fixed this time. Thanks again!", "created": "2020-04-22T18:35:00.000000" }, { "author": "623c09d6a2f6400069eb76ca", "body": "Thanks [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79]!", "created": "2020-04-22T19:06:00.000000" } ], "components": [], "created": "2020-04-17T08:01:00.000000", "creator": "623c09d6a2f6400069eb76ca", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56c31904" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o01ff4:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Apr/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_352987306_*|*_3_*:*_1_*:*_107578960_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_9442916" } ], "description": "In the Puppet Server documentation tree, using the 'latest' version, most of the links under 'HTTP API' are broken and yield a 404.\n\nThese links all work in the 'Open Source Puppet' documentation tree, but once you're in 'Puppet Server' already, they do not work.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54688", "fixedVersions": [], "id": "54688", "issueType": "Bug", "key": "DOCUMENT-1101", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c09d6a2f6400069eb76ca", "resolution": "Fixed", "resolutionDate": "2020-04-22T18:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "API documentation links broken in Puppet Server tree", "timeSpent": "PT0S", "updated": "2020-04-22T19:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Link fixed. Thanks for spotting!", "created": "2020-04-13T07:12:00.000000" } ], "components": [], "created": "2020-04-09T07:46:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@27899313" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o019ow:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Apr/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1446225_*|*_10007_*:*_1_*:*_341081862_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1015358" } ], "description": "the link from https://puppet.com/docs/puppet/latest/lang_functions.html#lang-functions__section_jm5_ggl_thb to https://puppet.com/docs/puppet/latest/functions.html \nis incorrect. \nthe page is https://puppet.com/docs/puppet/latest/function.html either the page name is wrong or the link is wrong\n\nit is broken in the 2 previous versions from a quick test, and possibly in multiple pages on the website\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54687", "fixedVersions": [], "id": "54687", "issueType": "Bug", "key": "DOCUMENT-1100", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Fixed", "resolutionDate": "2020-04-13T07:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "broken link https://puppet.com/docs/puppet/latest/functions.html ", "timeSpent": "PT0S", "updated": "2020-04-13T07:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "623c0a859b54ec0068b13f88", "body": "Sorry. I can't get the formatting of the code right.\u00a0 The indentation issue I'm trying to describe is that the \"}\" should be under the \"i\" in \"if\", but is actually under the \"f\".", "created": "2020-04-09T01:17:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for your suggestions!\n\nI've fixed the formatting errors, and changed the examples on the\u00a0Conditional statements and expressions page to follow the style guide.\n\n[https://puppet.com/docs/puppet/latest/style_guide.html#conditional-statement-alignment]\n\n[https://puppet.com/docs/puppet/latest/lang_conditional.html#examples]", "created": "2020-04-16T04:53:00.000000" } ], "components": [], "created": "2020-04-09T01:13:00.000000", "creator": "623c0a859b54ec0068b13f88", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4f393c5d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o019fs:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Apr/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_453920632_*|*_3_*:*_1_*:*_9592475_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_154526539" } ], "description": "[https://puppet.com/docs/puppet/latest/style_guide.html#parameter-indentation-and-alignment]\u00a0contains this text:\n\nWhen using if/else statements, align in the following way:\n\n{{{{if $someting}}}}\n \\{{ {}}\n{\\{\u00a0 \u00a0$var = 'hour'}}\n{{{{ }\u00a0}}{{elsif $something_else\u00a0}}{}}\n \\{{\u00a0 \u00a0$var = 'minute'}}\n{\\{ }\u00a0{{else\u00a0}}{}}\n \\{{\u00a0 \u00a0$var = 'second'}}\n{\\{ }}}\n\nFor more information...\n\nI have several issues with this:\n * The text is hidden under the \"Parameter indentation and alignment\" heading. It should have its own heading, or perhaps be moved to the \"Conditionals\" heading.\n * The indentation seems wrong. All the lines except the first \"if\" line seems to be indented one step too much.\n * The style guide argues that \"} else \\{\" should be written on a single line, but the code on the page you reach by following the link to \"Conditional statements and expressions\" write \"}\" on a line of its own, and \"else {\" on the next line. Perhaps the style guide should allow both styles. Otherwise, the examples on [https://puppet.com/docs/puppet/latest/lang_conditional.html] should be updated to follow the style guide.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54581", "fixedVersions": [], "id": "54581", "issueType": "Bug", "key": "DOCUMENT-1099", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a859b54ec0068b13f88", "resolution": "Fixed", "resolutionDate": "2020-04-16T04:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Style guide: indentation for if..elsif..else seems to be wrong", "timeSpent": "PT0S", "updated": "2020-04-16T04:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "example validation to test\n\n\n{code:java}\nmessage: \"This node is using common data\"\nmessage2: \"%{alias('message')}\"\n\n{code}\n", "created": "2020-04-08T04:50:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks [~accountid:557058:79a6b455-622c-4839-88ba-d3ee205f72b0]! I've updated the docs to include\u00a0integer.\u00a0", "created": "2020-04-08T09:40:00.000000" } ], "components": [], "created": "2020-04-03T06:54:00.000000", "creator": "623a4603761efb0069cd34da", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6094fb61" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpyy5:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Apr/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_358006481_*|*_3_*:*_1_*:*_4203054_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_79761328" } ], "description": "The Hiera documentation states for the alias() function:\n\n> The {{alias}} function lets you use reuse Hash, Array, or Boolean values.\n\n[https://puppet.com/docs/puppet/latest/hiera_merging.html#the-alias-function]\n\nThis is wrong, it also works for integer. [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] told me on Slack:\n\n> it returns the looked up value without any change", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54686", "fixedVersions": [], "id": "54686", "issueType": "Bug", "key": "DOCUMENT-1098", "labels": [ "hiera", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4603761efb0069cd34da", "resolution": "Fixed", "resolutionDate": "2020-04-08T09:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Fix Hiera alias() documentation regarding data types", "timeSpent": "PT0S", "updated": "2020-04-08T09:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Remove the link for the README .txt template and edit the copy to point to the correct README topic.", "created": "2020-03-24T10:15:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I redirected the link to\u00a0[https://github.com/puppetlabs/pdk-templates/blob/master/moduleroot_init/README.md.erb], as well as fixed a bad link to the \"Documenting modules\" docs.\u00a0", "created": "2020-03-25T15:30:00.000000" } ], "components": [], "created": "2020-03-23T09:25:00.000000", "creator": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5d0b6ae7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o00kx4:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Mar/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_89345916_*|*_3_*:*_1_*:*_1552821_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_104123758" } ], "description": "In the [README section of the Puppet language style guide|https://puppet.com/docs/puppet/latest/style_guide.html#readme], the link to the Puppet README template is broken:\n * The link currently points to [https://puppet.com/sites/default/files/assets/docs/puppet/5.3/READMEtemplate.txt]\n * Searching for \"README\", \"README template\", or \"Puppet README template\" from the 404 page do not yield relevant results.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55033", "fixedVersions": [], "id": "55033", "issueType": "Bug", "key": "DOCUMENT-1097", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b6a5143-cd16-434d-9c56-e1f3b642a830", "resolution": "Fixed", "resolutionDate": "2020-03-25T15:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken link to Puppet README template in Puppet language style guide", "timeSpent": "PT0S", "updated": "2020-03-25T15:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b5a27ad106ec32d95ea277d", "attachments": [], "comments": [], "components": [ "Code Management" ], "created": "2020-03-17T15:16:00.000000", "creator": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@540d2f5f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o00hag:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Mar/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_82019423_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1308472231" } ], "description": "*Problem:*\n\nThe document for customizing code manager using heira says \"to set up Code Manager to updated classes in the console after deploying code to your environments\" has a typo/grammatical error.\u00a0 It should be \"to update classes\" (no updated).\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/latest/code_mgr_customizing.html]\n\n_Current text :_\n\nFor example, to set up\u00a0Code Manager\u00a0to updated classes in the console after deploying code to your environments.\n\n_Suggested improvement:_\n\nFor example, to *enable*\u00a0Code Manager\u00a0to *update*\u00a0classes in the console after deploying code to your environments.\n\n*Summary:*\n\nEnable reads better than \"set up\", so I suggest changing that as well, but the real error is using \"updated\".", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54512", "fixedVersions": [], "id": "54512", "issueType": "Bug", "key": "DOCUMENT-1096", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "resolution": "Fixed", "resolutionDate": "2020-04-02T17:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue]: typo in code_mgr_customizing", "timeSpent": "PT0S", "updated": "2020-04-02T17:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs-hack to do:\n * Add the following note to the certname configuration docs:\u00a0 \"*Note:*\u00a0For full\u00a0functionality of the `*puppet config print`*\u00a0command and other dependent commands, include the certname\u00a0in the\u00a0main\u00a0section of the puppet.conf file.\"\n\n\u00a0", "created": "2020-07-15T03:10:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "PR for Puppet repo:\u00a0[https://github.com/puppetlabs/puppet/pull/8228]", "created": "2020-07-16T04:42:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Added note and committed change to puppet-docs master branch.", "created": "2020-07-16T05:01:00.000000" } ], "components": [], "created": "2020-03-16T10:22:00.000000", "creator": "623a4d66d32a94006a63cac6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@344df96" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o00eq0:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2800799_*|*_3_*:*_1_*:*_3858521_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_10514909179" } ], "description": "*Problem:*\n\n[https://puppet.com/docs/puppet/latest/configuration.html#certname]\n\nThe\u00a0*certname* section of the\u00a0docs does not mention the required section of the puppet.conf file the *certname* entry has to be included in:\u00a0*[main] or [agent].*\n\n\u00a0\n\n*Suggested improvement:*\n\nThe docs should explicitly mention that the\u00a0*certname* entry\u00a0has to be included in the [main] section of the puppet.conf file.\u00a0\n\nIf the\u00a0*certname*\u00a0entry is only in the\u00a0[agent] section this will break the\u00a0*puppet config print*\u00a0command and other dependent commands that require\u00a0**this to be fully functional.\n\nIt would be beneficial to have a note at the bottom of the\u00a0*certname*\u00a0section to clarify this detail - stating something similar to this:\n\n\"*Note:* The *certname* entry is required to be included in the [main] section of the puppet.conf file for full functionality of the *puppet config print* command and other dependent commands\"\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54255", "fixedVersions": [], "id": "54255", "issueType": "Improvement", "key": "DOCUMENT-1095", "labels": [ "docs-hack", "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4d66d32a94006a63cac6", "resolution": "Fixed", "resolutionDate": "2020-07-16T05:01:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "certname entry is required in [main] section for puppet.conf file", "timeSpent": "PT0S", "updated": "2020-07-16T05:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:6243990945ece00069c8eca3], I'm sorry it's taken so long for me to come back around to this ticket. We fixed the issue you discussed by way of another ticket for this issue, and you can see here that the parameters and example sections no longer show up in the table of contents: https://puppet.com/docs/puppet/latest/function.html\n\nIn looking at this today, though, I wonder if the `new` and `strftime` subheads still make the ToC more difficult to read. From your perspective, would it be better to leave those subheads in the table of contents, or remove them?", "created": "2020-06-12T15:53:00.000000" } ], "components": [], "created": "2020-03-12T10:56:00.000000", "creator": "6243990945ece00069c8eca3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e979914" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o00dao:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "12/Jun/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_346598030_*|*_10009_*:*_1_*:*_930645134_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_7618881639" } ], "description": "hi,\nIn the latest version of https://puppet.com/docs/puppet/latest/function.html notice, partition and regsubstr gained additional subsections. However the headlines for these sections appear to be as important as the main section and gained their own entry in the index list at the top of the page. \nIt now lists:\n\n* next\n* notice\n* Parameters\n* partition\n* Parameters\n* Examples\n* realize\n* reduce\n* regsubst\n* Parameters\n* Examples\n* Parameters\n* Examples\n\nMaybe those subsections could use the same system as new's subsections?\n ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54892", "fixedVersions": [], "id": "54892", "issueType": "Bug", "key": "DOCUMENT-1093", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243990945ece00069c8eca3", "resolution": "Fixed", "resolutionDate": "2020-06-23T10:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "built-in functions index is broken", "timeSpent": "PT0S", "updated": "2020-06-23T10:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "The suggested change has gone into the docs and will be fully viewable after the next build.\u00a0", "created": "2020-03-06T12:36:00.000000" } ], "components": [ "Code Management" ], "created": "2020-03-05T13:43:00.000000", "creator": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5236ddfa" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o009k8:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Mar/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4283896_*|*_3_*:*_1_*:*_6994697_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_71116272" } ], "description": "*Problem:*\n\nCode Manager configuration docs are not clear on the type of URL required for the r10k_remote parameter.\u00a0 Although the setup does require r10k_private_key to be an SSH private key, it is requested after the r10k_remote parameter is set, and so isn't obvious to new users that it relates to the r10k_remote URL.\n\n*Suggested improvement:*\n\n_http://puppet.com/docs/pe/2019.2/code_mgr_config.html_\n\n_Current text :_\n\n{{r10k_remote}}: This is the location of your control repository. Enter a string that is a valid URL for your\u00a0Git\u00a0control repository. For example:\u00a0\"git@:puppet/control.git\".\n\n_Suggested improvement:_\n\n{{r10k_remote}}: This is the location of your control repository, *as accessed by SSH*. Enter a string that is a valid *SSH*\u00a0URL for your\u00a0Git\u00a0control repository. For example:\u00a0\"git@:puppet/control.git\".\n\n*Summary:*\n\n\u00a0HTTPS based access to remote hosted control repos does not work.\u00a0 Using an HTTPS URL will result in failures that do not provide appropriate information for debugging (failed pe-bolt-server and pe-ace-server, failed concat, user/group/perm execs in the Events).\u00a0 Specifying SSH URL will stop users from putting in the wrong information to begin with.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54253", "fixedVersions": [], "id": "54253", "issueType": "Improvement", "key": "DOCUMENT-1092", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:fadb6590-cb09-4d40-97b6-1cd240ff4c04", "resolution": "Fixed", "resolutionDate": "2020-03-06T12:36:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve wording for Code Manager parameters", "timeSpent": "PT0S", "updated": "2020-03-06T12:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks, [~accountid:557058:8f1e0495-1d4a-4123-bbad-727b7f49f370]! I'll add this to our backlog, but I can't promise we'll get to it right away. We're happy to make generated docs changes, but devs should also feel free to do so", "created": "2020-03-02T14:13:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "In the description of notify, add the string requirement to the first sentence:\n\n{code}\nSends an arbitrary message, specified as a string, to the agent run-time log.\n{code}\n\nIn the message attribute, add that the value specified must be a string.", "created": "2020-03-02T14:21:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs updated. PR for Puppet repo:\u00a0[https://github.com/puppetlabs/puppet/pull/8229]", "created": "2020-07-16T06:45:00.000000" } ], "components": [], "created": "2020-03-02T12:23:00.000000", "creator": "557058:8f1e0495-1d4a-4123-bbad-727b7f49f370", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@15df7572" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0058g:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Mar/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_6856607_*|*_10007_*:*_1_*:*_5038285_*|*_3_*:*_1_*:*_686613_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_11719408809" } ], "description": "This resource: https://puppet.com/docs/puppet/latest/types/notify.html\nShould state that 'message' accepts a string. We're not explicitly stating what the acceptable values are, so folks are trying to pass in things like Hash or Array and getting weird results (See PUP-10321)\n\nThese are generated docs, so they'll need to be updated in the source.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54122", "fixedVersions": [], "id": "54122", "issueType": "Task", "key": "DOCUMENT-1091", "labels": [ "docs-hack", "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8f1e0495-1d4a-4123-bbad-727b7f49f370", "resolution": "Fixed", "resolutionDate": "2020-07-16T08:16:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "'notify' resource should have acceptable values for message", "timeSpent": "PT0S", "updated": "2020-07-16T08:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:557058:836ef76e-8051-48a3-8dc7-005f79695b0e]\u00a0it looks like there is another valid example in the latest version of the docs, but not in previous versions.\u00a0[https://puppet.com/docs/puppet/6.10/lang_data_number.html#converting-strings-to-numbers]\n\nIs this example OK to insert into the previous versions in place of the one we are deleting?\u00a0\n\n\u00a0\n{code:java}\n$integer_var = Integer('342')\n$float_var = Float('3.14159')\n$numeric_var = Numeric('5280')\n{code}\n\u00a0\n\n\u00a0", "created": "2020-03-04T15:16:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "[~accountid:557058:836ef76e-8051-48a3-8dc7-005f79695b0e]\u00a0just following up on the question above.\u00a0", "created": "2020-03-19T12:22:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "I don't particularly care, it's correct and fine to add it in older versions, it's fine to leave it out. The important part is to please remove the incorrect example from currently supported versions.", "created": "2020-03-19T18:15:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "This is complete and the most current example was moved to docs versions we will support after 6.0. Changes to those versions will build shortly.\u00a0", "created": "2020-03-20T12:39:00.000000" } ], "components": [], "created": "2020-02-21T16:52:00.000000", "creator": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Examples in the supported Puppet language docs should work, and broken examples should be removed." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2cbfa381" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o0015k:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Mar/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_322711472_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1213206278_*|*_10006_*:*_1_*:*_864524219" } ], "description": "*Problem statement*\n\nAn outdated string-to-integer conversion example in the Puppet language docs produces an error when used in supported versions of Puppet.\n\nThis was raised in DOCUMENT-817. At the time the outdated method was kept in the docs for compatibility purposes. Since at least Puppet 5 it should've been removed instead.\n\n*Suggested change*\n\nOn all supported Puppet versions of https://puppet.com/docs/puppet/latest/lang_data_number.html#converting-strings-to-numbers\n\nRemove this example:\n\n{quote}\nAnother technique to convert a string to a number is to add zero (0) to it. For example:\n\n{code}$mystring = \"85\"\n$mynum = 0 + $mystring # mynum is an integer with value 85{code}{quote}\n\nNo content needs to be added; a functional example of the supported method is already present above this passage.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54891", "fixedVersions": [], "id": "54891", "issueType": "Bug", "key": "DOCUMENT-1090", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "resolution": "Done", "resolutionDate": "2020-03-20T12:39:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Remove broken Puppet language string-to-integer conversion example", "timeSpent": "PT0S", "updated": "2020-03-20T12:39:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "created": "2020-02-14T09:58:00.000000", "name": "image-2020-02-14-08-58-46-077.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14227" }, { "attacher": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "created": "2020-02-14T09:59:00.000000", "name": "image-2020-02-14-08-59-04-149.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14216" } ], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Just pushed a fix. Thanks!", "created": "2020-02-18T10:34:00.000000" } ], "components": [ "PE" ], "created": "2020-02-14T09:59:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@134aa06e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|i004yf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_346750204_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1008066" } ], "description": "The current z is 2018.1.12. However main docs shows:\n\n\u00a0\n\n!image-2020-02-14-08-59-04-149.png!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54580", "fixedVersions": [], "id": "54580", "issueType": "Task", "key": "DOCUMENT-1088", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2020-02-18T10:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PE Docs main page for 2018.1.x shows wrong current z release", "timeSpent": "PT0S", "updated": "2020-02-18T10:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Change committed to the 2019.3 and 2019.z docs branches", "created": "2020-02-21T11:05:00.000000" } ], "components": [ "Code Management" ], "created": "2020-02-12T14:56:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2226e96e" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|i003vz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_501773191_*|*_3_*:*_1_*:*_1446808_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_260584451" } ], "description": "Referring to this page specifically: [https://puppet.com/docs/pe/2018.1/puppetfile.html#keep_repository_content_at_a_specific_version]\n\nWhere it says:\n\n>\u00a0Setting these options maintains the repository at that version and deploys any updates made to that particular version.\n\nWe should note that you shouldn't set multiple options here, and instead pick one. This should probably be updated to something along the lines of:\n\n>\u00a0Setting any one of these options maintains the repository at that version and deploys any updates made to that particular version.\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55032", "fixedVersions": [], "id": "55032", "issueType": "Task", "key": "DOCUMENT-1086", "labels": [ "code-mgmt", "docs-hack", "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2020-02-21T11:06:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Note in writing that combining Puppetfile repo version tags is a bad idea", "timeSpent": "PT0S", "updated": "2020-02-21T11:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Waiting for a fix from our UX team.", "created": "2020-02-13T16:00:00.000000" } ], "components": [], "created": "2020-02-12T14:43:00.000000", "creator": "557058:35060490-aa27-40a2-b587-eca7672140c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@29ce5f78" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|i003vb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_88381571_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_62768215_*|*_10005_*:*_1_*:*_2619758" } ], "description": "[https://puppet.com/docs/pe/2019.3/system_configuration.html#system_configuration]\n\n\u00a0\n\nThe second image, with the title \"Firewall configuration for large installations with compilers\"\n\nuses outdated terms: Master of Masters (instead of Master), Master Replica (instead of Replica), and Complile masters (instead of Compilers)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54685", "fixedVersions": [], "id": "54685", "issueType": "Improvement", "key": "DOCUMENT-1085", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:35060490-aa27-40a2-b587-eca7672140c8", "resolution": "Fixed", "resolutionDate": "2020-02-14T09:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Outdated graphic on 2019.3 site", "timeSpent": "PT0S", "updated": "2020-02-14T09:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:63d40628f6e1b543161789a7], can you tell us more about what change we should be making for this?", "created": "2020-02-18T10:21:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "Ah the 5.6.0 release ended up being puppet 6, so I'd change it to \"since Puppet 6.0\".", "created": "2020-04-01T12:14:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Ah, perfect, thanks [~accountid:63d40628f6e1b543161789a7]!", "created": "2020-04-01T14:51:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Updated in latest function docs and in the code source. Thank you [~accountid:623a4603761efb0069cd34da]!", "created": "2020-04-02T17:04:00.000000" } ], "components": [], "created": "2020-02-12T08:36:00.000000", "creator": "623a4603761efb0069cd34da", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6d68883f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|i00367:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_524635029_*|*_3_*:*_1_*:*_470113_*|*_10009_*:*_2_*:*_93032698_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3727917501_*|*_10006_*:*_1_*:*_830956" } ], "description": "From [https://puppet.com/docs/puppet/latest/function.html#call:]\n{noformat}\nDeferred values supported since Puppet 5.6.0{noformat}\nIf I got this right from Henrik on Slack, Deferred isn't really usable in Puppet 5. Also Puppet 5.6.0 got never released and I can't find any sign in the [https://puppet.atlassian.net/projects/PUP?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page&status=unreleased] that you're working on that :)\n\nThanks! :)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54579", "fixedVersions": [], "id": "54579", "issueType": "Bug", "key": "DOCUMENT-1084", "labels": [ "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4603761efb0069cd34da", "resolution": "Fixed", "resolutionDate": "2020-04-02T17:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "call() function referrers to Deferred in Puppet 5.6", "timeSpent": "PT0S", "updated": "2020-04-02T17:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Hey [~accountid:557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d], I removed some of the detailed instructions about environment-based testing when we changed preconfigured environment node groups circa 2018.1.7:\nhttps://puppet.com/docs/pe/2018.1/pe_enhancements.html#preconfigured-environment-node-groups-(2018.1.7)\n\nThis change meant that existing vs. new installs might have different default node groups, so explaining how to do environment-based testing became even more complicated. \n\nWe do have an existing ticket, DOC-4350, to improve this info. That ticket also has more detail about the reasoning behind the paring back, and suggestions for fixing it. I'm going to close this ticket as a duplicate. ", "created": "2020-02-11T10:28:00.000000" } ], "components": [ "PE" ], "created": "2020-02-05T16:08:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4976dfb6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzygn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_497107524_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_910541" } ], "description": "In versions PE 2017.3 and before, currently still on our website, there existed a much more detailed and comprehensive document on Environment-Based Testing. This document includes examples, instructions, and even a very helpful graphical chart which we in support still regularly link customers to on a regular basis.\n\nThis can be seen here: [https://puppet.com/docs/pe/2017.3/environment_based_testing.html]\n\nHowever, starting with PE 2018.1.x, that page was reduced to, well, this pale shadow of its former worth: [https://puppet.com/docs/pe/2018.1/environment_based_testing.html]\n\nWhole chunks of very useful instructions, reasonings, explanations, and examples were cut for reasons that aren't clear. The current page is thus vague and confusing to customers who are new to the concept, and mostly not useful to them given its lack of any functional examples.\n\nCan this old set of instructions be restored?\n\nIf not, can we get an explanation as to why, so that we may work to create something better that holds up to the former glory?\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54906", "fixedVersions": [], "id": "54906", "issueType": "Task", "key": "DOCUMENT-1083", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Duplicate", "resolutionDate": "2020-02-11T10:28:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Request to restore 2017.3 and prior version of PE Environment-Based Testing Docs", "timeSpent": "PT0S", "updated": "2020-02-11T10:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Submitted a PR to fix the CLA links:\u00a0[https://github.com/puppetlabs/.github/pull/11]\n\nI can't locate the current home of the Trivial Patch Policy, might need help from the Puppet Community team. Ping [~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b]\u00a0\n\nI checked all the other links on this page and they appear to be functioning correctly.\u00a0", "created": "2020-02-04T10:50:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b], we know you were away, but when you get a chance, do you know anything about this?", "created": "2020-02-11T10:37:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "Oh hai!\n\nThe web team will have to recover this from the archives.", "created": "2020-02-19T11:59:00.000000" }, { "author": "5fc92cb6f8b012006900c169", "body": "The Trivial patch exemption policy page is queued up and will go out with the next build (today).\n\u00a0", "created": "2020-02-19T12:14:00.000000" }, { "author": "5fc92cb6f8b012006900c169", "body": "[https://puppet.com/community/trivial-patch-exemption-policy/] is live.", "created": "2020-02-19T14:51:00.000000" }, { "author": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "body": "Thanks!", "created": "2020-02-19T15:09:00.000000" }, { "author": "623a4bed866b810069e36896", "body": "Hi,\n\nI discovered the link to Jira in the\u00a0 [Contributing|https://puppet.com/docs/puppet/latest/contributing.html] page links to https://jira.puppetlabs.com/browse/MODULES which is outdated and raises a ssl certificate error (should be https://puppet.atlassian.net/browse/MODULES).", "created": "2020-03-09T07:55:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Link to Jira MODULES project fixed.\u00a0", "created": "2020-03-24T16:48:00.000000" } ], "components": [ "Website & IA" ], "created": "2020-02-03T05:56:00.000000", "creator": "557058:3825c1a3-9d55-4d72-90e5-86ae288822a8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2647963b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzupj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_24271570_*|*_3_*:*_2_*:*_3029456348_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1301795089" } ], "description": "The recent website changes pretty much ignored existing static links in a few places, leading to a couple of very avoidable losses:\n\n* Link to the CLA: http://links.puppet.com/cla\n* Link to the 'trivial patch exemption policy': https://puppet.com/community/trivial-patch-exemption-policy\n\nProbably more, as well, I only coincidentally noticed this when submitting a PR for merge.\n\nFound in https://github.com/puppetlabs/.github/blob/master/CONTRIBUTING.md", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54252", "fixedVersions": [], "id": "54252", "issueType": "Bug", "key": "DOCUMENT-1082", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3825c1a3-9d55-4d72-90e5-86ae288822a8", "resolution": "Fixed", "resolutionDate": "2020-03-24T16:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken links on website", "timeSpent": "PT0S", "updated": "2020-03-24T16:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for alerting us to this! It's fixed now.\u00a0", "created": "2020-02-05T06:22:00.000000" } ], "components": [], "created": "2020-02-03T03:06:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7780bf69" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzunr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_113233203_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_71333006" } ], "description": "This document:\n\nhttps://puppet.com/docs/puppet/latest/lang_data_number.html#unique_39074728\n\nHas an example like this: {{Float[1.6, 3.501, 0]}} and that is an error since {{Float}} takes max 2 parameters. Simply drop the {{, 0}} part.\n\n(This was found by a community member).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54510", "fixedVersions": [], "id": "54510", "issueType": "Bug", "key": "DOCUMENT-1081", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "resolution": "Fixed", "resolutionDate": "2020-02-05T06:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Faulty Float data type example", "timeSpent": "PT0S", "updated": "2020-02-05T06:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks for the ticket [~accountid:6243990945ece00069c8eca3]! I've fixed that in the latest version, and the updated page should refresh shortly.", "created": "2020-01-31T16:23:00.000000" } ], "components": [], "created": "2020-01-30T05:03:00.000000", "creator": "6243990945ece00069c8eca3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a7e0435" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzs2n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_127233268_*|*_5_*:*_1_*:*_0" } ], "description": "hi,\nhttps://puppet.com/docs/puppet/latest/lang_data_hash.html lists under additional functions several stdlib functions that are already deprecated by puppet built-in functions.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54121", "fixedVersions": [], "id": "54121", "issueType": "Bug", "key": "DOCUMENT-1080", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243990945ece00069c8eca3", "resolution": "Fixed", "resolutionDate": "2020-01-31T16:23:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation links to deprecated stdlib functions", "timeSpent": "PT0S", "updated": "2020-01-31T16:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "created": "2020-01-24T14:58:00.000000", "name": "Screen Shot 2020-01-24 at 1.47.02 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14201" }, { "attacher": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "created": "2020-01-28T13:33:00.000000", "name": "Screen Shot 2020-01-28 at 12.32.01 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14264" } ], "comments": [ { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "This may change as our release strategy changes.", "created": "2020-01-24T14:54:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] This is a known shortcoming of our release strategy + limited Docs resources. We have documented this limitation -- see the note [here|https://puppet.com/docs/pe/2019.2/release_notes_pe_index.html]. This was also partly our motivation for reorganizing the PE release notes 2019.1+, so that you can see on [_one page_|https://puppet.com/docs/pe/2019.1/release_notes_pe.html] what was added in each Z. We do occasionally gets docs tickets from customers who try something documented in the latest Z while they're on an earlier product version. In my experience, they've all been very understanding when we've explained this limitation. \n\nWith our new versioning strategy of frequent Y \"updates,\" the expectation is that customers on that stream will be using the latest version, so there's no business case for maintaining docs for each individual Y. That said, our plan is to archive superseded Y versions in our [PE GitHub docs archive|https://github.com/puppetlabs/docs-archive/tree/master/pe]. \n\nMarking this closed/fixed because we have indeed documented this limitation.", "created": "2020-01-28T12:08:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "We also added the specific Z to the landing page for each PE version, and that version also appears in the sidebar.\n !Screen Shot 2020-01-28 at 12.32.01 PM.png|thumbnail! \n", "created": "2020-01-28T13:34:00.000000" } ], "components": [], "created": "2020-01-24T14:53:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Minimum: document this limitation\n\nMaximum: documentation trees specific to each release" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8afe8dc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzznzb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_330276529_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5412558" } ], "description": "PE documentation is only accurate for the latest z release, but is organized and is presented by y release, resulting in for example: a PE 2019.2.1 user reading about a command in the PE 2019.2 document tree with a parameter introduced in\u00a0PE 2019.2.2 but unavailable in\u00a0PE 2019.2.1.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54506", "fixedVersions": [], "id": "54506", "issueType": "Task", "key": "DOCUMENT-1079", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2020-01-28T12:08:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "pe documentation is only accurate for the latest z release", "timeSpent": "PT0S", "updated": "2020-01-30T12:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68],\n\nI believe these were merged late for some reason. They're up now though. Thank you!", "created": "2020-01-16T12:09:00.000000" } ], "components": [], "created": "2020-01-15T04:32:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1b28637d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzgx3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_113840714_*|*_6_*:*_1_*:*_0" } ], "description": "Hi people,\nI noticed that puppetserver 6.8 is available in the yum repo. However, https://puppet.com/docs/puppetserver/latest/release_notes.html lists only the release notes/ changelog for 6.7.2 and older.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54249", "fixedVersions": [], "id": "54249", "issueType": "Bug", "key": "DOCUMENT-1078", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2020-01-16T12:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppetserver 6.8 release notes are missing", "timeSpent": "PT0S", "updated": "2020-01-16T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is fixed and should update in our next docs build.", "created": "2020-01-14T11:13:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This change accidentally got reverted when we made another update to this diagram. Waiting for a fix from the UX team. ", "created": "2020-02-13T15:59:00.000000" } ], "components": [], "created": "2020-01-14T07:40:00.000000", "creator": "5c2ff333c5484b691dd2c43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4caf229a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzg5z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_8661401_*|*_4_*:*_1_*:*_2078936_*|*_5_*:*_2_*:*_2607087031_*|*_10004_*:*_1_*:*_62784177_*|*_10006_*:*_1_*:*_4139594" } ], "description": "*Problem: Diagram is not completely correct.*\n\n\u00a0\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.2/installing_compile_masters.html]\n\n_Current text : in the diagram, there is an arrow going from the compiler to master on TCP 8140 this arrow should be both ways not just to the master from the complier._\n\nThe correct version can be seen in the 2018.1.x documentation.\u00a0\n\n\u00a0\n\n_Suggested improvement: Update the diagram to have the TCP 8140 arrows on either ends pointing to both the master and compiler same as the 2018.1.x documentation_\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54401", "fixedVersions": [], "id": "54401", "issueType": "Bug", "key": "DOCUMENT-1077", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c2ff333c5484b691dd2c43a", "resolution": "Fixed", "resolutionDate": "2020-02-14T09:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Diagram", "timeSpent": "PT0S", "updated": "2020-02-14T09:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68]! Thanks for this ticket. 3.14 is a valid release and docs are available, but after Puppet 5.5, Facter docs are just part of Puppet docs---they no longer have their own docs set. \n\n3.14.x release notes are at: https://puppet.com/docs/puppet/latest/release_notes_facter.html\n\nHowever, that page doesn't yet have 3.14.6 release notes---I just realized last night that there had been a Facter release and notes were missing. I'll get those added in today. I'll also add a note to the older Facter docs to point to where they are now, so they won't be so difficult to find.", "created": "2020-01-14T10:47:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "OK, all recent Facter release notes have now been updated, including 3.14.6 and yesterday's release, 3.14.7. I've also added notes to the Facter index and release notes pages to help users find the more recent versions. Some of these changes are building right now, but should be live shortly. Thanks again for calling this out!", "created": "2020-01-15T12:02:00.000000" } ], "components": [], "created": "2020-01-11T05:25:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a8c0a59" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzevj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_275989390_*|*_3_*:*_1_*:*_90867200_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_2569005" } ], "description": "Hi,\nI was searching for the latest facter 3.14 documentation. I discovered https://puppet.com/docs/facter/3.11/index.html\n\n* I assumed that the version drop down menu offers a `latest` option and/or 3.14\n* I assumed that https://puppet.com/docs/facter/3.14/index.html doesn't redirect to github\n\nI checked https://github.com/puppetlabs/facter/releases to verify that 3.14 is a valid release. 3.14.6 got released at 2019-11-18.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54503", "fixedVersions": [], "id": "54503", "issueType": "Bug", "key": "DOCUMENT-1076", "labels": [ "facter", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2020-01-15T12:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "No facter 3.14 docs available", "timeSpent": "PT0S", "updated": "2020-01-15T12:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "We're hashing this over on the docs team, but I don't think there's an easy way to do this. I can create a redirect for this specific doc, but if we created a redirect rule, any page that isn't found would redirect to the index for that product/version. Maybe that's not a bad thing?", "created": "2020-01-07T17:05:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "I can see the trade-off there. Redirecting to the index of a version for *every* 404 could be annoying too.\n\nReally the best case would be to have specific redirects for documents missing in a specific version to the equivalent or adjacent document in the chosen version, so that switching brings the reader to somewhere that is actually helpful. I do understand that that might be a pain to maintain :-/\n\nIdea: have a version-specific 404 page to avoid the maintenance cost of full page-specific redirects and still provide more context (\"attention, typo!\" AND \"here's the version you were looking for\") than the generic 404. Would that be workable?", "created": "2020-01-08T01:50:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Closing as this is duplicated by a web ticket.", "created": "2020-02-21T12:04:00.000000" } ], "components": [], "created": "2020-01-06T03:46:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2700be19" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzzb5j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jan/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_110118294_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_3894178232" } ], "description": "When switching from a docs page of one version (e.g. [https://puppet.com/docs/puppet/6.10/intro_puppet_language_and_code.html)] to a version that does not have that document (e.g. 5.5 in this case) the user is shown a very unhelpful 404 page ([https://puppet.com/docs/404/|https://puppet.com/docs/404/])\n\nTo help users a bit more, dropping them into the selected version's main index page (e.g. https://puppet.com/docs/puppet/5.5/puppet_index.html in this case) would be an improvement.\n\nIf at all possible, finding a similar page in the other docs as a redirection target would be even better.\n\n[this issue was brought up on IRC]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54905", "fixedVersions": [], "id": "54905", "issueType": "Improvement", "key": "DOCUMENT-1075", "labels": [ "docs-web-redesign" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Duplicate", "resolutionDate": "2020-02-21T12:04:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Redirect 404 version switches to index for that version", "timeSpent": "PT0S", "updated": "2020-02-21T12:04:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [], "components": [ "PE" ], "created": "2019-12-31T08:50:00.000000", "creator": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@777444f6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzz9qv:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_12815783_*|*_3_*:*_1_*:*_685357300_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1134606" } ], "description": "This is the statement in question: \"Enabling cached catalogs on your agents *ensures Puppet does enforce* any catalog changes on your agents until you run an orchestrator job to enforce changes.\"\n\nI have bolded the specific error. The phrase \"does enforce\" should be \"does *not* enforce\" in this context.\n\nSource is this page: [https://puppet.com/docs/pe/2019.2/configuring_puppet_orchestrator.html#enable-cached-catalogs-for-use-with-the-orchestrator]\n\nMay apply to older versions as well, didn't confirm.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54890", "fixedVersions": [], "id": "54890", "issueType": "Task", "key": "DOCUMENT-1074", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ac3788df-2d4a-42ff-9dea-7c873aaf6e4d", "resolution": "Fixed", "resolutionDate": "2020-01-08T11:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Incorrect statement on Cached Catalog enforcement in Orch docs", "timeSpent": "PT0S", "updated": "2020-01-08T11:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I believe this was a web issue and it appears to have been fixed now.\u00a0", "created": "2019-12-19T13:48:00.000000" } ], "components": [], "created": "2019-12-18T13:24:00.000000", "creator": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:bbdbbd98-52c6-470c-bfa0-fea7525dd24d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@572dc8de" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzz5lb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Dec/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_87837159_*|*_6_*:*_1_*:*_0" } ], "description": "The landing page for PE docs, pe_user_guide.html, has a \"Get Certified\" link in the \"Learn PE and Puppet\" section. It currently points to https://puppet.com/support-services/certification which results in a 404. It should point to https://puppet.com/learning-training/certification/", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54578", "fixedVersions": [], "id": "54578", "issueType": "Bug", "key": "DOCUMENT-1073", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "qm:f7b4bc64-445a-440e-8354-a55854c39cee:bbdbbd98-52c6-470c-bfa0-fea7525dd24d", "resolution": "Done", "resolutionDate": "2019-12-19T13:48:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"Get certified\" link on pe_user_guide.html is broken", "timeSpent": "PT0S", "updated": "2019-12-19T13:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:6d9f4174-bf47-424d-a46a-6940b2255f29]! Thank you for reporting this issue. I think this broke after our recent website redesign, but it looks to me like it has been fixed now. Can you check and see whether you are still having this issue? I want to confirm before I escalate it to our web team. ", "created": "2019-12-05T08:45:00.000000" }, { "author": "557058:6d9f4174-bf47-424d-a46a-6940b2255f29", "body": "Hi [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79],\n\nYes, it does indeed look like it's been fixed. I've only looked at the link for the built-in function documentation, though, but I'd assume links would be broken on all pages or no pages.", "created": "2019-12-05T08:49:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks [~accountid:557058:6d9f4174-bf47-424d-a46a-6940b2255f29]. I'm not seeing the issue anywhere else now, so I'm closing this ticket as fixed. But thank you again for filing it! It's really helpful to hear about issues we might not have found yet.", "created": "2019-12-05T09:54:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Fixed by the web team.", "created": "2019-12-05T09:55:00.000000" } ], "components": [], "created": "2019-12-03T12:44:00.000000", "creator": "557058:6d9f4174-bf47-424d-a46a-6940b2255f29", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@47a8cf3b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzysuv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Dec/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_158490391_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_4156322" } ], "description": "It seems that there's something broken in the documentation generator; all sections look to have a blank attribute {{id=\"\"}}. This means that all links from the table of contents in the top of the documentation pages are broken.\n \u00a0\n Take [https://puppet.com/docs/puppet/latest/function.html#map] as an example. The link points to the {{map}} section, but the heading looks like this:\n\n{{

        map

        }}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55134", "fixedVersions": [], "id": "55134", "issueType": "Bug", "key": "DOCUMENT-1067", "labels": [ "docs-web-redesign", "generated-docs", "link" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:6d9f4174-bf47-424d-a46a-6940b2255f29", "resolution": "Fixed", "resolutionDate": "2019-12-05T09:55:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Section table of contents broken as sections have broken HTML id attributes", "timeSpent": "PT0S", "updated": "2019-12-05T09:55:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b5a27ad106ec32d95ea277d", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The explicit work here is to check for trailing whitespace after the first opening bracket of code examples on this page.", "created": "2020-02-18T10:31:00.000000" }, { "author": "5b5a27ad106ec32d95ea277d", "body": "I believe I got them all, but [~accountid:624394a25f63fd0069b18cb8] would you mind checking the changes when they go live? It may be a few days before the page updates. Check after 8/24/2020.", "created": "2020-02-21T14:48:00.000000" }, { "author": "624394a25f63fd0069b18cb8", "body": "I will absolutely validate. Thanks!", "created": "2020-02-21T20:20:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "For the record, there's a bigger issue here with our ability to lint Puppet code samples throughout the docs. We know it's not effective over the long haul to just play whack-a-mole with these, but at least these will be fixed while we try to resolve the \"how do we lint all code samples across the docs?\" question. :)", "created": "2020-02-24T12:17:00.000000" } ], "components": [ "Style Guide & Usage" ], "created": "2019-12-01T15:49:00.000000", "creator": "624394a25f63fd0069b18cb8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Examples within the [Language Visual Index|[https://puppet.com/docs/puppet/latest/lang_visual_index.html]] page follow style guide." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4d1f8ee9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyr0n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_152942421_*|*_3_*:*_1_*:*_4259314_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_6653519618_*|*_10006_*:*_1_*:*_270476478" } ], "description": "Looking at the (latest version)\u00a0+Language visual index+, I see some examples that do not follow the [Puppet style guide|[https://puppet.com/docs/puppet/latest/style_guide.html#spacing-indentation-and-whitespace]]. For example, in the visual index, the first example in the resource declaration section has a file resource in use, but does not have a single space between the first opening bracket of the file resource, and the title. There are a few more places in the Language Visual Index that also do not follow the style guide.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54247", "fixedVersions": [], "id": "54247", "issueType": "Improvement", "key": "DOCUMENT-1066", "labels": [ "docs-hack", "lang", "medium", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "624394a25f63fd0069b18cb8", "resolution": "Done", "resolutionDate": "2020-02-21T14:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Visual Language Index page does not follow style guide in some places.", "timeSpent": "PT0S", "updated": "2020-02-24T12:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [], "comments": [ { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Thank you, Akash. The link should be to\u00a0[https://puppet.com/docs/facter/3.11/index.html]. I've made the fix to the source ([https://github.com/puppetlabs/osp-docs/blob/5.5/puppet_index.dita]), and it's on its way through the publishing pipeline. I will close this ticket when I've confirmed the fix on the website.", "created": "2019-12-03T12:19:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Hm, this morning, the facter/3.11/index.html page is looping endlessly. Ticket opened.\u00a0https://puppet.atlassian.net/browse/WWM-2189", "created": "2019-12-04T07:58:00.000000" }, { "author": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "body": "While i don't view the reported ticket may be due to permission, but i confirm endless redirect on [https://puppet.com/docs/facter/3.11/index.html], i just tried.\n\n\u00a0\n\nThanks again for looking into this!\n\n\u00a0", "created": "2019-12-04T08:03:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Ah, yes, that's a Puppet-internal ticket. I'll keep my eye on it. In the meantime, if you need a way into the Facter 3.11 docs, the other pages seem to work ok, and you can start here:\u00a0[https://puppet.com/docs/facter/3.11/release_notes.html]", "created": "2019-12-04T08:09:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Okay! Loop repaired. Link on puppet/5.5/puppet_index.html is fixed.", "created": "2019-12-04T15:08:00.000000" } ], "components": [], "created": "2019-11-30T23:23:00.000000", "creator": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@16ebaa64" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyr07:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Dec/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_212240616_*|*_3_*:*_1_*:*_98965933_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4727735" } ], "description": "*Problem: The url pointing to facter documentation for puppet 5.5 opensource is broken, it return http 404, please fix the same.*\n\nMain documentation URL :\u00a0[https://puppet.com/docs/puppet/5.5/puppet_index.html]\n\nSection : Facter\n\nbroken url : https://puppet.com/docs/facter/,\u00a0this url redirects to\u00a0[https://github.com/puppetlabs/docs-archive/tree/master/facter/3.11]\u00a0which is http 404\u00a0\n\n*Suggested improvement: I am not sure where the correct document is, kindly find on your own.*\n\nents here. When adding specific text, please *bold changes*.\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55133", "fixedVersions": [], "id": "55133", "issueType": "Bug", "key": "DOCUMENT-1065", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "resolution": "Fixed", "resolutionDate": "2019-12-04T15:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The link pointing to facter is giving http 404", "timeSpent": "PT0S", "updated": "2019-12-04T15:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thanks for the heads-up on this. The link broke because it was pointing to a specific blog tag that doesn't currently exist on the revamped website. I've changed the link to point to a relevant ebook for now (changes will be live after the next docs site build), and will change the link back if blog tagging is readded.\u00a0", "created": "2019-12-04T12:01:00.000000" } ], "components": [], "created": "2019-11-28T04:31:00.000000", "creator": "623c0e44866b810069e435c6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@216bd1a7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyqhr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Dec/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_453011076_*|*_3_*:*_1_*:*_91420489_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_989580" } ], "description": "Broken link on\u00a0[https://puppet.com/docs/continuous-delivery/2.x/cd_user_guide.html]\n\nClicking on\u00a0[Read recent blog posts about continuous delivery|https://puppet.com/blog-tags/continuous-delivery]\u00a0doesn't work", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54244", "fixedVersions": [], "id": "54244", "issueType": "Bug", "key": "DOCUMENT-1064", "labels": [ "cd4pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0e44866b810069e435c6", "resolution": "Fixed", "resolutionDate": "2019-12-04T12:01:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken Link", "timeSpent": "PT0S", "updated": "2019-12-04T12:01:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [], "components": [], "created": "2019-11-26T03:17:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@17bcc71b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyol3:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_110981776_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_447909825" } ], "description": "On the agent requirements page it lists the system-logos package as a dependency: https://puppet.com/docs/pe/2019.2/supported_operating_systems.html#supported_operating_systems\n\nThis is literally a package that contains logos and can't reasonably be a dependency for the Puppet agent. It's also not a dependency in the actual package", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54120", "fixedVersions": [], "id": "54120", "issueType": "Bug", "key": "DOCUMENT-1063", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Fixed", "resolutionDate": "2019-12-02T14:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "system-logos dependency is wrong", "timeSpent": "PT0S", "updated": "2019-12-05T10:39:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:5b746714f5df9b2b2b558b20] You make a good case! This is something we've had on our to-do list for a while. We do now have the ability to generate PDFs of our doc sets on an ad hoc basis, but we'd like to have some mechanism where customers can self-serve PDFs. We are tracking this effort in an internal ticket, so I'm going to close this ticket as a duplicate, however, I've linked the two tickets and we'll definitely factor your comments into prioritization for that effort. ", "created": "2019-11-27T12:42:00.000000" } ], "components": [ "PE", "Website & IA" ], "created": "2019-11-25T11:52:00.000000", "creator": "5b746714f5df9b2b2b558b20", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4d545a22" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyntz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_166578328_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_9227067" } ], "description": "*Problem:*\n\n\u00a0The documentation is currently web based, only. Many external PSEs work in closed environments with no access to the internet, and therefore do not have access to Puppet documentation. They have to exit their workspace, find a computer where they can get web access, and either read in the hopes of retaining the information, or print the documents to take inside the secure area or facility.\n\n*Suggested improvement:*\n\n\u00a0\n\n_Suggested improvement:_\n\nProduce PDF copies of the documentation, at each major technology. You can see examples at\u00a0[Red Hat|[https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/]] and [VMware|[https://docs.vmware.com/en/VMware-vSphere/index.html]]\n\n*Summary:*\n\n\u00a0PDF version of documentation is required for delivery PSEs in order to build deliverables for customers and/or take the documentation into a secure area for reference.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54400", "fixedVersions": [], "id": "54400", "issueType": "New Feature", "key": "DOCUMENT-1062", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b746714f5df9b2b2b558b20", "resolution": "Duplicate", "resolutionDate": "2019-11-27T12:42:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[docs issue] Produce PDFs of Puppet Docs", "timeSpent": "PT0S", "updated": "2019-11-27T12:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5fc92cb6f8b012006900c169", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you for the ticket, [~accountid:557058:3fde63ce-1af9-4657-8cf9-544754ab54a6]! We're trying to figure out what the trouble is here.", "created": "2019-11-25T11:52:00.000000" }, { "author": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "body": "Anything I can do to help! \u00a0Just promise me I get the docs search bar back. :)", "created": "2019-11-25T11:54:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "[~accountid:557058:3fde63ce-1af9-4657-8cf9-544754ab54a6] we're working on getting that search bar back! Sorry for the inconvenience.\u00a0", "created": "2019-11-25T11:57:00.000000" }, { "author": "557058:1c8b4b8c-8c59-47c6-8446-8e20ecf2947f", "body": "[~accountid:557058:fd1909cc-c57f-4b1f-880c-e06d7009618b] is restoring search today and will advise team when it has been deployed. ", "created": "2019-11-25T11:58:00.000000" }, { "author": "557058:fd1909cc-c57f-4b1f-880c-e06d7009618b", "body": "Search should be restored. And if you're getting .markdown links those are definitely in the source, we have bits in place to fix them when they appear in the sidebar navigation and I think we had redirects on the old site that handled these as well.", "created": "2019-11-25T12:26:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:fd1909cc-c57f-4b1f-880c-e06d7009618b], yes, it's Markdown in the source (for functionality on GitHub), so I agree, this is an issue with broken redirects.\n", "created": "2019-11-25T14:30:00.000000" }, { "author": "5b0340d43eafdb09dee5bc3a", "body": "[~accountid:557058:3fde63ce-1af9-4657-8cf9-544754ab54a6], while we wait to get our search bar back, the workaround to search the docs at the moment is to go to\u00a0[https://puppet.com/search/docs/]. Apologies again for the inconvenience!", "created": "2019-11-25T14:36:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "As far as I can tell, this issue is resolved.", "created": "2020-03-31T16:53:00.000000" } ], "components": [ "Website & IA" ], "created": "2019-11-25T08:18:00.000000", "creator": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@24bf3483" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzynmv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_12158487_*|*_3_*:*_1_*:*_10987232346_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_595671_*|*_10005_*:*_1_*:*_123814" } ], "description": "*Problem:*\n\n[https://puppet.com/docs/puppetserver/6.5/index.html]\n\ncontains broken links\n\n*Suggested improvement:*\n\n\u00a0\n\nOn that page the logback.xml link points to [https://puppet.com/docs/puppetserver/6.5/config_file_logbackxml.markdown]\n\nwhich is a 404. \u00a0By removing the \".markdown\" from\u00a0the end, you get the intended document.\u00a0\n\nSimilarly, the same page's link to advanced logging configuration immediately below the above link goes to:\n\n[https://puppet.com/docs/puppetserver/6.5/config_logging_advanced.markdown]\n\nSame issue. \u00a0404. \u00a0Remove the .markdown, and the page displays.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54684", "fixedVersions": [], "id": "54684", "issueType": "Improvement", "key": "DOCUMENT-1059", "labels": [ "docs-web-redesign" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "resolution": "Fixed", "resolutionDate": "2020-03-31T16:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Issue in Puppet Server navigation sidebar", "timeSpent": "PT0S", "updated": "2020-03-31T16:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [], "components": [], "created": "2019-11-21T01:20:00.000000", "creator": "6243990945ece00069c8eca3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3b5f9a68" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzylc7:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_29595787_*|*_3_*:*_1_*:*_1424309_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3454028" } ], "description": "hi,\nThe Link to PUP-10149 in the release notes for 6.11.1 ( https://puppet.com/docs/puppet/latest/release_notes_puppet.html#puppet-release-notes-x.11.0 ) is broken.\n\nIt links to:\nhttps://tickets.puppetlabshttps//tickets.puppetlabs.com/browse/PUP-9994com/browse/PUP-10149", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54683", "fixedVersions": [], "id": "54683", "issueType": "Bug", "key": "DOCUMENT-1057", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243990945ece00069c8eca3", "resolution": "Fixed", "resolutionDate": "2019-11-21T10:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Link in 6.11.1 release notes is broken.", "timeSpent": "PT0S", "updated": "2019-11-21T10:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Blocked on graphic to come from UX", "created": "2020-02-11T10:27:00.000000" } ], "components": [], "created": "2019-11-19T09:33:00.000000", "creator": "557058:58c5336a-e9d7-4eff-b221-85517090556b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@299f9e7d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyk0n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_3480304_*|*_3_*:*_1_*:*_3095555717_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_3884627540_*|*_10006_*:*_1_*:*_541199183" } ], "description": "The rtyler/jenkins module has been handed to the Vox Pupuli team who have published https://forge.puppet.com/puppet/jenkins this past summer. Please update the following docs to reflect this, as users may attempt to use the older, unmaintained module based on the examples in the Roles and Profiles docs. \n\nhttps://puppet.com/docs/pe/2019.2/the_roles_and_profiles_method.html (including https://puppet.com/docs/pe/2019.2/roles_and_profiles_overview.png)\nhttps://puppet.com/docs/pe/2019.2/roles_and_profiles_example.html\nhttps://puppet.com/docs/pe/2019.2/designing_advanced_profiles.html\nhttps://puppet.com/docs/pe/2019.2/designing_convenient_roles.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55031", "fixedVersions": [], "id": "55031", "issueType": "Bug", "key": "DOCUMENT-1056", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:58c5336a-e9d7-4eff-b221-85517090556b", "resolution": "Done", "resolutionDate": "2020-02-14T11:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Replace references to rtyler/jenkins with puppet/jenkins", "timeSpent": "PT0S", "updated": "2020-02-14T11:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953]\nI'm aware that the steps are still available in the LTS docs, that's where I pulled them from for the customer in the above case. However, as the steps are against the LTS, not all customers would be comfortable going ahead and running those on their 2019 infrastructure in case it caused any harm.\n\nFrom my view of the issue, it was caused by the cert clean step of the puppet infrastructure run regenerate_master_certificate plan. My theory is that the cert had already been cleaned but from testing this may not be the issue.\n\nIf I come across any other instances where cert commands don't work I will file them here so this can be reassessed. \n\n\n\n", "created": "2019-11-19T11:02:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Sounds good, thanks [~accountid:557058:1134d60c-31df-407a-b573-e0cfaef8865e]. If you want to follow up on your theory about the cert, [~accountid:70121:4c61e06e-3a2f-49af-9e89-b6d0e94fb0c9] would be a good resource. ", "created": "2019-11-19T11:13:00.000000" }, { "author": "557058:3ff86ead-03bb-4b44-9e1d-735086bfa278", "body": "\"SSH as root from the Puppet master\" is completely prohibited with no possibility of exception at the current customer I am working with. This will not be the only such case. If we can't find a way to make the plan work without root SSH then we have no supported process for such customers to regenerate the master certificate.", "created": "2020-05-13T11:00:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "To emphasize, where we've been hitting the biggest problems with this, it's been in places with policy issues that complicate or prohibit the use of features the task relies on \u2014\u00a0not engineering problems with the task itself. Patrick's issue might be resolvable with engineering work, but Chris's won't.", "created": "2020-05-13T11:19:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "As of this latest version, 2019.7, the regenerate cert commands use orchestrator instead of Bolt, so they no longer require SSH. \nhttps://puppet.com/docs/pe/latest/release_notes_pe.html#simplified-prerequisites-for-select-puppet-infrastructure-run-commands\n\nIt seems like this addresses the underlying concern here?", "created": "2020-05-14T10:54:00.000000" }, { "author": "557058:3ff86ead-03bb-4b44-9e1d-735086bfa278", "body": "It looks like that doesn't include regenerating the master certificate, so it would not have helped with the cert regeneration I did yesterday.", "created": "2020-05-14T10:58:00.000000" } ], "components": [], "created": "2019-11-15T08:23:00.000000", "creator": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@72fffa4f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Priority" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzyhlz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_353421547_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1036052" } ], "description": "The manual steps for regenerating certs have been removed from the documentation:\nhttps://puppet.com/docs/pe/2019.1/regenerate_certificates.html\n\nIn some cases, the `puppet infrastructure run` commands will fail and the manual steps will need to be carried out so I think it's important that they are also listed here\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54500", "fixedVersions": [], "id": "54500", "issueType": "Task", "key": "DOCUMENT-1055", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:1134d60c-31df-407a-b573-e0cfaef8865e", "resolution": "Won't Fix", "resolutionDate": "2019-11-19T10:50:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Cert regeneration Docs, Manual steps removed in 2019.1, 2019.2", "timeSpent": "PT0S", "updated": "2020-08-10T11:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52], can you tell me more about what you are missing that removing this note would help with?\n\nWhen I test this in Slack's auto-preview, I still see the short description of the page (below). \n\nNOTE: This page was generated from the Puppet source code on 2019-10-21 12:56:41 -0700 This page is a list of Puppet\u2019s built-in functions, with descriptions of what they do and how to use them. Functions are plugins you can call during catalog compilation. A call to any function is an expression that resolves to a value. For more information on how to call functions, see the language reference page about function calls.", "created": "2019-11-18T15:18:00.000000" }, { "author": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "body": "Useless is probably an overstatement but I think the NOTE is distracting in the preview and I suspect most don't read past it.", "created": "2019-11-18T15:26:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The note helps people, internal and external, know that if they make manual changes or PRs to the page, it would get overwritten. I also think the date stamp helps people know how up-to-date the information on the page is.\n\nWhat might help with the \"tl", "created": "2019-11-18T15:53:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "As per previous comments. PRs welcome to adjust this, of course!", "created": "2020-01-16T15:34:00.000000" } ], "components": [], "created": "2019-11-14T12:40:00.000000", "creator": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4021a6c9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hylaxz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_357183795_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5096436640" } ], "description": "The first line of the functions docs https://puppet.com/docs/puppet/latest/function.html is a note about how it's generated. This is probably not very important to users and it means that auto-preview generation in slack is useless.\n{noformat}\nNOTE: This page was generated from the Puppet source code on 2019-10-21 12:56:41 -0700\n{noformat}\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54399", "fixedVersions": [], "id": "54399", "issueType": "New Feature", "key": "DOCUMENT-1054", "labels": [ "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "resolution": "Won't Fix", "resolutionDate": "2020-01-16T15:34:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "note at top of puppet functions page makes preview useless", "timeSpent": "PT0S", "updated": "2020-01-16T15:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks for catching this, [~accountid:5daaf339eb076d0c302b242f]! I've fixed the issue and it should be live on the next docs build later today.", "created": "2019-11-06T16:04:00.000000" } ], "components": [], "created": "2019-10-20T05:05:00.000000", "creator": "5daaf339eb076d0c302b242f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4cc5509b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxvuf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Nov/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1511940525_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\n{{system users}} feature not marked for {{useradd}} provider in table despite being mentioned in [provider description|https://puppet.com/docs/puppet/latest/types/user.html#user-provider-useradd]\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/latest/types/user.html#user-provider-features]\n\n_Current text :_\n\n/\n\n_Suggested improvement:_\n\nMark {{system users}} feature for {{useradd}} provider in table\n\n*Summary:*\n\n\u00a0Add missing {{x}} for {{system}} users feature", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54119", "fixedVersions": [], "id": "54119", "issueType": "Bug", "key": "DOCUMENT-1052", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5daaf339eb076d0c302b242f", "resolution": "Fixed", "resolutionDate": "2019-11-06T16:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "User provider support table inconsistent with description", "timeSpent": "PT0S", "updated": "2019-11-06T16:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is as designed. We don't separately maintain docs for superseded versions within a stream. ", "created": "2020-02-20T11:45:00.000000" } ], "components": [], "created": "2019-10-17T16:52:00.000000", "creator": "5b0340d43eafdb09dee5bc3a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3f187848" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxtp3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_45960_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_10871536315" } ], "description": "User Feedback:\u00a0[https://puppet.com/docs/puppetserver/6.0/install_from_packages.html]\n\n\n\nThis was something introduced in puppet +v5.5.2 as:# puppetserver ca --help puppetserver: 'ca' is not a puppetserver command. See 'puppetserver --help'.# puppetserver --help usage: puppetserver ([--help] | [--version]) []The most commonly used puppetserver commands are: foreground gem irb reload ruby start stopSo, by introducing this docs for 5.5.x, it breaks the versioning schema and makes puppet not backward compatible for patch releases.\n\n---\n\nInvestigate to see if the listed command is incorrect. Perhaps we can add info on patch releases\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54398", "fixedVersions": [], "id": "54398", "issueType": "Story", "key": "DOCUMENT-1050", "labels": [ "feedback-form-docs-site" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b0340d43eafdb09dee5bc3a", "resolution": "Won't Fix", "resolutionDate": "2020-02-20T11:45:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Investigate issue with puppetserver ca command", "timeSpent": "PT0S", "updated": "2020-02-20T11:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "PR:\u00a0[https://github.com/puppetlabs/puppetserver/pull/2361]", "created": "2020-07-02T02:43:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs updated:\u00a0[https://puppet.com/docs/puppetserver/latest/install_from_packages.html]", "created": "2020-07-13T02:15:00.000000" } ], "components": [], "created": "2019-10-17T16:33:00.000000", "creator": "5b0340d43eafdb09dee5bc3a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e166148" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxtov:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1307840_*|*_3_*:*_1_*:*_251048863_*|*_10009_*:*_1_*:*_948701268_*|*_5_*:*_1_*:*_0_*|*_6_*:*_1_*:*_57311_*|*_10006_*:*_1_*:*_18811628224_*|*_10005_*:*_1_*:*_3263768238" } ], "description": "Feedback from a user: Add instructions on how to install Server on other platforms (like Ubuntu).\u00a0\n\nThere is an `apt-get` command, so perhaps the issue is that the commands are not clearly separated by platform. Separating the docs in this way would make them more user-friendly, especially for newer users who may not already be familiar with the command-line.\n\n\u00a0\n\n[https://puppet.com/docs/puppetserver/latest/install_from_packages.html]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54241", "fixedVersions": [], "id": "54241", "issueType": "Story", "key": "DOCUMENT-1051", "labels": [ "feedback-form-docs-site", "medium", "puppet", "server" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b0340d43eafdb09dee5bc3a", "resolution": "Fixed", "resolutionDate": "2020-07-13T02:15:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Server installation instructions", "timeSpent": "PT0S", "updated": "2020-07-13T02:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:e61e70fa-c93f-4ac7-b34d-33b82b270b41], thanks for bringing this to our attention!\n\n6.0 is EOL at this point, as is 2019.0.x, and 2019.1.x contains Puppet 6.4. I've changed the table to show that 2019.1 and later are compatible with 6.x agents. The change will be live on the next docs build.", "created": "2019-10-01T12:14:00.000000" } ], "components": [], "created": "2019-10-01T01:41:00.000000", "creator": "557058:e61e70fa-c93f-4ac7-b34d-33b82b270b41", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2ec1a4ef" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzxcmn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33758038_*|*_3_*:*_1_*:*_4030055_*|*_10009_*:*_1_*:*_77100574_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_2_*:*_233454" } ], "description": "Hi there,\n\n[https://puppet.com/docs/puppet/latest/about_agent.html#reference-4922]\u00a0incorrectly states that PE 2019.x will support 6.x agents; per\u00a0[https://puppetlabs.zendesk.com/agent/tickets/36268], this is clearly not the case. We've just had negative feedback about the product and support experience because of this error from a customer. Can we please have this clarified to state that 2019.x will only support agents 6.0.5 and earlier ASAP?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54118", "fixedVersions": [], "id": "54118", "issueType": "Bug", "key": "DOCUMENT-1049", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e61e70fa-c93f-4ac7-b34d-33b82b270b41", "resolution": "Fixed", "resolutionDate": "2019-10-02T09:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Incorrect agent version specification in PE agent support matrix", "timeSpent": "PT0S", "updated": "2019-10-02T09:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "aggregatetimeestimate": "144000", "aggregatetimeoriginalestimate": "144000", "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "body": "Hi All,\n\nI am fairly new to reporting bugs in this community, if there is something I have missed, please enlighten me and I will add/correct those to the best of my ability.", "created": "2019-09-15T11:33:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Hi Akash,\u00a0\n\n\u00a0\n\nThanks for catching those errors! Corrections will appear in the docs for 5.5+ shortly.\u00a0\n\n\u00a0\n\nThanks", "created": "2019-09-16T16:51:00.000000" } ], "components": [], "created": "2019-09-15T11:15:00.000000", "creator": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "correction of the paragraph by removing the duplication" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@671b3497" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzx0uf:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Sep/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_106609326_*|*_5_*:*_1_*:*_0" } ], "description": "*Problem:*\n\n1. The document contains duplication of a few words. It is at the 3rd point of 'The catalog compilation process'\n\n\u00a02. The documents contain a paragraph which is grammatically incorrect.\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/5.5/subsystem_catalog_compilation.html]\n\n_Current text :_\n # _Code outside of node definitions is evaluated. Resources in the code are added to the are added to the node's catalog, and any classes declared in the code are loaded and declared._\n # Note:\u00a0Classes are usually classes are defined in modules, although the main manifest can also contain class definitions.\n # If a matching node definition is found, the code in it is evaluated at\u00a0node scope (overriding top-scope variables.) Resources in the code are added to the are added to the node's catalog, and any classes declared in the code are loaded and declared.\n\n_Suggested improvement:_\n # _Current text :Code outside of node definitions is evaluated. Resources in the code are added to the *-are added to the-* node's catalog, and any classes declared in the code are loaded and declared._\n # _Note:\u00a0*classes* are usually *-classes are-* defined in modules, although the main manifest can also contain class definitions._\n # _If a matching node definition is found, the code in it is evaluated at\u00a0node scope (overriding top-scope variables.) Resources in the code are added to the -*are added to the*- node's catalog, and any classes declared in the code are loaded and declared._\n\nProvide suggested improvements here. When adding specific text, please *bold changes*.\n\n*Summary:*\n # just remove the strike out text.\n # change Classes to classes and remove strikeout text.\n # just remove the strike out text.\n\n\u00a0", "environment": "NA", "epicLinkSummary": null, "estimate": "PT144000S", "externalId": "55030", "fixedVersions": [], "id": "55030", "issueType": "Bug", "key": "DOCUMENT-1047", "labels": [], "originalEstimate": "PT144000S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:61a97e39-aaf4-458e-a681-5e2128c785ab", "resolution": "Fixed", "resolutionDate": "2019-09-16T16:51:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Errors in catalog compilation page", "timeSpent": "PT0S", "updated": "2019-09-19T15:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Talk to Austin Blatt on PuppetDB about this to reconcile these notes.", "created": "2019-09-17T10:38:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I spoke with Austin and he agreed it is best to just remove the note that you can upgrade PuppetDB independently of Puppetserver. You CAN, but it is not recommended since it will not allow the user to take advantage of upgrade features.\n\nI changed the second shortdesc to a generic \"Upgrade PuppetDB to get the newest features.\"\u00a0\u00a0", "created": "2019-10-25T13:42:00.000000" } ], "components": [ "PuppetDB", "Puppet Server" ], "created": "2019-09-12T09:08:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7d9a0070" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwz9j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Sep/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_437398508_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_3294274386" } ], "description": "The following advisory appears near the top of the page describing the upgrade process, [https://puppet.com/docs/puppet/latest/upgrade_minor.html|https://puppet.com/docs/puppet/latest/upgrade_minor.html,]:\n{quote}The order in which you upgrade components is important. Always upgrade\u00a0Puppet Server\u00a0and PuppetDB simultaneously, including the {{puppetdb-termini}} package on Puppet Server nodes, and always upgrade them before you upgrade agent nodes. Do not run different major versions on your Puppet masters (including Server) and PuppetDB nodes.\n{quote}\nFurther down the page, however, the first sentence in the \"Upgrade PuppetDB\" section is\n{quote}PuppetDB can be upgraded independently of your master and agent nodes.\n{quote}\nSo which is it?\u00a0 PuppetDB and Puppet Server must be upgraded together, or they can be upgraded independently? I suspect that it depends on the details of the upgrade in question, but those dependencies should be documented.\n\nMy educated guess would be that the first passage is meant to apply only to upgrades between major versions, whereas the latter is about upgrades within the same major version.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55132", "fixedVersions": [], "id": "55132", "issueType": "Bug", "key": "DOCUMENT-1046", "labels": [ "puppet", "puppetdb", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Fixed", "resolutionDate": "2019-10-25T13:42:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Inconsistent instructions for upgrading w.r.t. timing of puppetdb and puppetserver", "timeSpent": "PT0S", "updated": "2019-10-25T13:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Thanks for the catch! I have deleted the line break between 2008r and 22012 for Windows and added 10.13 for Mac.\u00a0", "created": "2019-09-19T17:20:00.000000" } ], "components": [], "created": "2019-09-10T17:03:00.000000", "creator": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1bcedb3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwy1r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Sep/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_581744156_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_196943787" } ], "description": "On this page: [https://puppet.com/docs/pe/2019.1/installing_pe_client_tools.html#supported-pe-client-tools-operating-systems]\n\nTwo issues on this page:\n\n1) The Windows Operating system list is incorrectly formatted. (It looks like there's an additional line break which is not needed)\n\n2) Additionally, the listed Mac OS versions does not include 10.13.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54904", "fixedVersions": [], "id": "54904", "issueType": "Bug", "key": "DOCUMENT-1045", "labels": [ "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "resolution": "Fixed", "resolutionDate": "2019-09-19T17:21:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Mac OS version numbers and Windows formatting issues on pe-client-tools page", "timeSpent": "PT0S", "updated": "2019-09-19T17:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "Hey [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], this is the info we'd love to have published with the Puppet Server 6.6 release, if possible. Thanks!", "created": "2019-09-09T17:17:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:104b5720-714d-4539-b455-df472251ec89], in mentioned that the current information says there isn't support for Java 7 and above... do you know offhand *where* it says that?", "created": "2019-09-13T10:35:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "I swear I saw something different somewhere, but I just found this page, which is actually out of date and incorrect:\u00a0[https://puppet.com/docs/puppetserver/6.5/services_master_puppetserver.html#supported-platforms]\n\n\u00a0\n\nI would expect this kind of info to be in this page:\u00a0[https://puppet.com/docs/puppetserver/6.5/install_from_packages.html#system-requirements]\n\n\u00a0\n\nOr some place more easily accessible.", "created": "2019-09-13T11:43:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Ah, perfect, that's helpful! I'm sorry I don't know my way around Server docs as well! ", "created": "2019-09-13T11:52:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:104b5720-714d-4539-b455-df472251ec89], what needs correcting on the supported platforms page? I saw that yesterday and also thought it looked out of date!\n\neta: Yeesh, nevermind, I see some of what you're talking about here! I'll take care of the obviously outdated stuff. What I really need to know is whether the list at https://puppet.com/docs/puppetserver/6.5/install_from_packages.html#platforms-with-packages is up-to-date.\n", "created": "2019-09-13T11:53:00.000000" } ], "components": [], "created": "2019-09-09T17:16:00.000000", "creator": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@106b2f14" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwx6n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Sep/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_56988807_*|*_10007_*:*_1_*:*_353267409_*|*_10009_*:*_1_*:*_4179_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_272264349" } ], "description": "Our current information says that Puppet Server 5+ doesn't support Java 7 and below. In Java-land supporting Java >= 9 is not something that was taken lightly and support was rarely assumed, however we've never been very clear on our official stance.\n\nWhat we want to do is officially support Java 8 and Java 11 in FOSS going forward and have that be explicit. Though if opensource users get it to work on other versions, good for them.\n\nThe supported Java version to Puppet Server version table would look something like this:\n\nPuppet Server 2.x => Java 7 & 8\n\nPuppet Server 5.x => Java 8\n\nPuppet Server 6.0-6.5.x => Java 8, experimental support for Java 11\n\nPuppet Server 6.6.0 and above => Full support for Java 8 & 11, I don't know of a reason it wouldn't work on the intervening versions, but we won't be testing with those. I don't know of a reason why it wouldn't work with a version greater than Java 11, but we don't test with those either. We will accept patches for support greater than Java 11 as a best effort, community supported basis. We do not have plans at this time to add additional supported versions, nor remove support for either 8 or 11. Both are considered \"LTS\" versions and are supported by upstream maintainers until 2022 or later.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55029", "fixedVersions": [], "id": "55029", "issueType": "Improvement", "key": "DOCUMENT-1044", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "resolution": "Fixed", "resolutionDate": "2019-09-17T14:51:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Publish more specific information regarding Java version support in Puppet Server", "timeSpent": "PT0S", "updated": "2019-09-17T14:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [], "created": "2019-08-16T17:36:00.000000", "creator": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@191dd68" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwgqf:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_19705_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_16250030793_*|*_10005_*:*_1_*:*_6878" } ], "description": "/docs/puppet/5.3/lang_iteration.html\n\n\u00a0\n\nlinks just go to general page. maybe the same page.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54768", "fixedVersions": [], "id": "54768", "issueType": "Task", "key": "DOCUMENT-1043", "labels": [ "feedback-form-docs-site", "lang", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "resolution": "Won't Fix", "resolutionDate": "2020-02-20T18:30:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet docs: function links don't go to functions", "timeSpent": "PT0S", "updated": "2020-02-20T18:30:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:6243990945ece00069c8eca3], thanks for the ticket! As you've seen, there's an issue with that particular function. I actually pinned it down this morning, and will have a fix in the next couple of days for that one. Do you have other examples where you'd like to see something different?", "created": "2019-08-16T15:59:00.000000" }, { "author": "6243990945ece00069c8eca3", "body": "It would be nice if searching in google for \"puppet list built in functions\" would suggest the latest version page first and not the one for 5.4. Is that something you can influence through google webmaster tools?\n\n\u00a0\n\nyaml_data could also do with a bit more documentation.", "created": "2019-08-22T01:14:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "We're working on the versioning issue right now as well", "created": "2019-08-22T17:01:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Information has been added back into regsubst and yaml_data manual, pending updates to generated docs. Docs should be live within a couple hours of this comment.", "created": "2019-09-17T15:58:00.000000" } ], "components": [], "created": "2019-08-16T05:12:00.000000", "creator": "6243990945ece00069c8eca3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@582d4b7c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzwgcf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Aug/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_38851863_*|*_3_*:*_1_*:*_2242630201_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_522123619" } ], "description": "hi,\n\nCould you please improve the documentation for built-in functions? Some of them are pretty much non existent.\n\nExample:\n\n[https://puppet.com/docs/puppet/6.7/function.html#regsubst]\n\nThe documentation for regsubst solely exists of 2 function signatures, how am I supposed to know what passing S for $encoding does?\n\nAlso why is flags in first function Optional[Optional? That just looks wrong.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55028", "fixedVersions": [], "id": "55028", "issueType": "Improvement", "key": "DOCUMENT-1042", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6243990945ece00069c8eca3", "resolution": "Fixed", "resolutionDate": "2019-09-17T15:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve List of built-in functions", "timeSpent": "PT0S", "updated": "2019-09-17T15:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Thank you for catching that, [~accountid:5c2ff333c5484b691dd2c43a]. I've made this update.\u00a0", "created": "2019-08-30T12:25:00.000000" } ], "components": [], "created": "2019-07-31T07:01:00.000000", "creator": "5c2ff333c5484b691dd2c43a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1f2012ae" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzw307:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Enhancement" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Aug/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_29400200_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2582031207" } ], "description": "*Problem:* \n\n*Once you update the console services certificate, you need to remember to restart the console-services and nginx services for it to take effect.*\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/pe/2019.1/use_a_custom_ssl_cert_for_the_console.html]\n\n\u00a0\n\n_Suggested improvement:_\n\n\u00a0\n\n*Step 5: Restart services*\u00a0\n\n*Once applied you will need to restart the Console and Nginx Service for the changes to take effect.*\n\n*{{puppet resource service pe-console-services ensure=stopped}}*\n\n*{{puppet resource service pe-console-services ensure=running}}*\n\n*{{puppet resource service pe-nginx ensure=stopped}}*\n\n*{{puppet resource service pe-nginx ensure=running}}*\n\n\u00a0\n\n*Summary:*\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54397", "fixedVersions": [], "id": "54397", "issueType": "Improvement", "key": "DOCUMENT-1041", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c2ff333c5484b691dd2c43a", "resolution": "Fixed", "resolutionDate": "2019-08-30T12:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add reminder to restart services once updated", "timeSpent": "PT0S", "updated": "2019-08-30T12:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "62438a418678e9007059bcca", "created": "2019-07-30T15:17:00.000000", "name": "puppet-server-650-release-notes.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14273" } ], "comments": [ { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "I've created a PR here https://github.com/puppetlabs/puppetserver/pull/2135 that'd I'd love your input on James.", "created": "2019-07-31T17:28:00.000000" }, { "author": "62438a418678e9007059bcca", "body": "Feedback provided. I appreciate the gravity with which this criticism was taken.\n\nFor the record: the last paragraph of my description was unfair, and I apologize for it.\n", "created": "2019-08-01T11:29:00.000000" } ], "components": [ "Puppet Server" ], "created": "2019-07-30T15:24:00.000000", "creator": "62438a418678e9007059bcca", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6a17c93f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzw29j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "31/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_163146842_*|*_5_*:*_1_*:*_0" } ], "description": "The explanation in the Puppet Server 6.5.0 release notes for SERVER-2576 is largely technically incomprehensible, and the parts that are comprehensible seem to be technically incorrect. In addition, there are obvious grammar errors; e.g.:\n\n{quote}\nmanage the contents of the {{webserver.cipher-suites}} configuration value to be those strong suites that available to you.\n{quote}\n\nIf I search the Eclipse Jetty Canonical Repository's [VERSION.txt|https://github.com/eclipse/jetty.project/blob/jetty-9.4.x/VERSION.txt] file for changes related to TLS or ciphers, for {{jetty-9.4.12.v20180830}}, I see this change:\n\n{noformat}\n + 2807 Exclude TLS_RSA_* ciphers by default\n{noformat}\n\nIn [Issue 2807 (Exclude TLS_RSA_\\* ciphers by default)|https://github.com/eclipse/jetty.project/issues/2807], it was decided to remove the {{TLS_RSA_\\*}} cipher suites by default.\n\nThe reasoning that Jetty provided for this change\u2014_ssllabs.com caps sites to grade B if they support {{TLS\\_RSA\\_\\*}} ciphers_\u2014is actually incorrect. The specific penalty is that the grade is capped to a B unless the site supports _some_ ciphers that provide forward secrecy. There is no penalty for supporting non-FS ciphers as long as at least some FS ciphers are supported.\n\nBut that notwithstanding, [issue 2807|https://github.com/eclipse/jetty.project/issues/2807], seems to be the change that the release notes allude to: because Puppet server 6.5.0 rebased to Jetty 9.4, the {{TLS_RSA_\\*}} ciphers are no longer included in the implicit default for {{cipher-suites}} in {{webserver}}.\n\nI have no idea why the Puppet server 6.5.0 release notes spend three paragraphs rambling on about FIPS compliance. The Jetty [VERSION.txt|https://github.com/eclipse/jetty.project/blob/jetty-9.4.x/VERSION.txt] file file mentions FIPS only once, for {{jetty-9.4.9.v20180320}}:\n\n{noformat}\n + 2010 SniX509ExtendedKeyManager causes exception: \"FIPS mode: only SunJSSE KeyManagers may be used\"\n{noformat}\n\nSo, FIPS appears to be a complete red herring.\n\nHere's what I think the write-up for SERVER-2576 was trying to communicate:\n\n{quote}\nThe implicit default for the {{cipher-suites}} setting (in the {{webserver}} section, in {{webserver.conf}}) no longer includes the {{TLS_RSA_\\*}} ciphers. Additionally, Puppet Server will emit warnings if any {{TLS_RSA_\\*}} ciphers are explicitly enabled (via an explicit {{cipher-suites}} setting).\n\nIn order to avoid potentially breaking clients that can only use {{TLS_RSA_\\*}} ciphers, the Puppet Server 6.5.0 {{webserver.conf}} file now includes an explicit {{cipher-suites}} setting that matches the implicit {{cipher-suites}} setting of earlier versions of Puppet Server. This has three effects:\n\n* Older clients that require the {{TLS_RSA_\\*}} ciphers will continue to work.\n* Puppet Server will generate warnings in the logs that the {{TLS_RSA_\\*}} ciphers are enabled.\n* Puppet Server will generate warnings in the logs for ciphers enumerated in the {{cipher-suites}} setting that are not available on that specific OS. (Note that these warnings can be safely silenced by editing the explicit {{cipher-suites}} setting and removing the offending ciphers.)\n\nA future version of Puppet Server will remove the explicit {{cipher-suites}} setting in {{webserver.conf}}, thus permitting the implicit default to apply. This will break any clients that still require the {{TLS_RSA_\\*}} ciphers.\n\nIn advance of this change, we strongly recommend updating any clients that still require the {{TLS_RSA_\\*}} ciphers to clients that can use more recent ciphers, and then removing the explicit {{cipher-suites}} setting in {{webserver.conf}}.\n{quote}\n\nAm I correct? Or was the explanation for SERVER-2576 so unclear that even after investigating for myself, I have failed to unravel what the exact change was?\n\nMore generally, I know that writing documentation, including release notes, is a thankless job. But it's an _important_ job. Getting it right is the difference between clearly communicating a change to Puppet administrators\u2014including what actions they should take\u2014and forcing them to throw their hands up and go figure it out for themselves.\n\nAnd to be explicitly clear: I'm not throwing the people tasked with documenting this change under the bus. From reading the rambling mishmash explanation of SERVER-2576, it is painfully obvious that writers lacked the technical knowledge to understand the change, and thus could not properly summarize it. That's absolutely not their fault. Assigning people to perform tasks, but without ensuring they have the necessary technical skills to perform those tasks, is an organizational/management failing.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54238", "fixedVersions": [], "id": "54238", "issueType": "Bug", "key": "DOCUMENT-1039", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "62438a418678e9007059bcca", "resolution": "Fixed", "resolutionDate": "2019-08-01T12:43:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Server 6.5.0 release notes for SERVER-2576 incomprehensible/incorrect", "timeSpent": "PT0S", "updated": "2019-08-01T12:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Thanks for the feedback! I've fixed the typo and it should publish in the next 24 hours.", "created": "2019-07-29T15:58:00.000000" } ], "components": [], "created": "2019-07-27T05:58:00.000000", "creator": "5daaf339eb076d0c302b242f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5e0c36f7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvz6v:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_208844045_*|*_6_*:*_1_*:*_0" } ], "description": "*Problem:*\n\nTypo in [\"Creating environments\" section \"Environment resources\"|https://puppet.com/docs/puppet/6.7/environments_creating.html#concept-7229].\n\n*Suggested improvement:*\n\nhttps://puppet.com/docs/puppet/6.7/environments_creating.html#concept-7229\n\n_Current text :_\n\nThe modulepath, the main manifest, Hiera data, and the config version script, can all be specified in envronment.conf. \n\n_Suggested improvement:_\n\nThe modulepath, the main manifest, Hiera data, and the config version script, can all be specified in *environment.conf*. \n\n*Summary:*\nFixed typo in last word: {{envronment.conf}} -> {{environment.conf}}\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54498", "fixedVersions": [], "id": "54498", "issueType": "Bug", "key": "DOCUMENT-1038", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5daaf339eb076d0c302b242f", "resolution": "Fixed", "resolutionDate": "2019-07-29T15:58:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Typo in \"Creating environments\"", "timeSpent": "PT0S", "updated": "2019-07-29T15:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Hi [~accountid:70121:6954a10e-a5cb-45a4-ad4c-6ba40e385a0f], \u00a0\u00a0\n\nI've added the note in red and updated the path to include 'puppet'. Please review and let me know if you have any additional suggestions.\u00a0\u00a0\n\nTo enable the\u00a0Puppet\u00a0log, create the requisite registry key by opening a command prompt and running:\n reg add\n{code:java}HKLM\\System\\CurrentControlSet\\Services\\EventLog\\Puppet\\Puppet /v EventMessageFile /t REG_EXPAND_SZ /d \"C:\\Program Files\\Puppet Labs\\Puppet\\puppet\\bin\\puppetres.dll\"{code}\nAlternatively, use PowerShell and the New-EventLog cmdlet to do the same thing:\n{code:java}New-EventLog -Source Puppet -LogName Puppet -MessageResource \"C:\\Program Files\\Puppet Labs\\Puppet\\puppet\\bin\\puppetres.dll\"{code}\n{color:#ff0000}Note: If you are using an older version of Puppet, double check that you have the most up to date path to puppetres.dll.{color}", "created": "2019-08-13T14:44:00.000000" }, { "author": "70121:6954a10e-a5cb-45a4-ad4c-6ba40e385a0f", "body": "Logan,\n\nThis looks good. I have not additional suggestions. Let me know if you need anything from me.\n\nRegards,\n\nChris", "created": "2019-08-19T16:53:00.000000" } ], "components": [], "created": "2019-07-24T10:53:00.000000", "creator": "70121:6954a10e-a5cb-45a4-ad4c-6ba40e385a0f", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The path to the puppetres.dll should be updated and a note added about verifying that the path to puppetres.dll is valid." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7f654813" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Normal" }, { "fieldName": "CS Severity", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "2 - Annoyance" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvx9r:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "35616" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Aug/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_451780109_*|*_3_*:*_1_*:*_170001234_*|*_10009_*:*_1_*:*_284650114_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1362773079" } ], "description": "The docs indicate to use the following to update the logging location in Windows.\n{code}reg add HKLM\\System\\CurrentControlSet\\Services\\EventLog\\Puppet\\Puppet /v EventMessageFile /t REG_EXPAND_SZ /d \"C:\\Program Files\\Puppet Labs\\Puppet\\bin\\puppetres.dll\"\n{code}\nAs pre:\n [https://puppet.com/docs/puppet/6.7/services_agent_windows.html#logging-for-puppet-agent-on-windows-systems]\n\nAt least on Puppet agent version 6 and 5 the path to the puppetres.dll is not correct. The path should be the following.\n\n\"C:\\Program Files\\Puppet Labs\\Puppet\\puppet\\bin\\puppetres.dll\"\n\nI recommend updating the docs to reflect the accurate path. If this path has changed at some point in the past the docs could make an indication that the correct path to the DLL should be verified as the command does not error out when executed if the path is incorrect.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54766", "fixedVersions": [], "id": "54766", "issueType": "Improvement", "key": "DOCUMENT-1037", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:6954a10e-a5cb-45a4-ad4c-6ba40e385a0f", "resolution": "Fixed", "resolutionDate": "2019-08-19T17:13:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Incorrect documentation for modifying where Puppet logs in Windows", "timeSpent": "PT0S", "updated": "2019-12-05T04:24:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Closing this due to lack of resources to add it to the docs right now. We will reassess if it comes up again / something gets written about it in the specification.\u00a0\n\n\u00a0", "created": "2020-07-15T08:19:00.000000" } ], "components": [], "created": "2019-07-23T13:30:00.000000", "creator": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3fe73b00" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvwn3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_529221529_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_30364598524_*|*_10005_*:*_1_*:*_18711868" } ], "description": "It was recently suggested that the puppet-syntax project could use PAL instead of interacting with private puppet APIs. A couple of us took a look at how this might work, but became stuck pretty quickly.\n\nCould we have some user focused documentation of the PAL API?\nAll I could find was 'predocs' (in google docs) linked to in https://puppet.atlassian.net/browse/PUP-8168\n\nI couldn't see anything in https://github.com/puppetlabs/puppet-specifications either.\n\nThanks,\nAlex (Vox Pupuli)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54117", "fixedVersions": [], "id": "54117", "issueType": "Improvement", "key": "DOCUMENT-1036", "labels": [ "large", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:054fa98a-5e29-48e7-aeca-d5542926f8ba", "resolution": "Won't Fix", "resolutionDate": "2020-07-15T08:19:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation for PAL (Puppet As a Language)", "timeSpent": "PT0S", "updated": "2020-07-15T08:19:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "body": "As far as i can tell only the\u00a0[5.5 documentation has been updated|https://github.com/puppetlabs/puppet-docs/commit/20cd47450b179b97915eac0c825a1170fb40569f] however i believe this bug is present in all version.\u00a0 I have created a [PR|https://github.com/puppetlabs/puppet-docs/pull/969].", "created": "2020-04-07T04:19:00.000000" } ], "components": [], "created": "2019-07-16T05:13:00.000000", "creator": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5a0eca6b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvq4f:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_643985024_*|*_3_*:*_4_*:*_2713909134_*|*_10009_*:*_1_*:*_6426274_*|*_5_*:*_1_*:*_45131377_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_2_*:*_3620943344_*|*_10006_*:*_2_*:*_18416024715" } ], "description": "*Problem:*\n\n\u00a0The current documentation for [reduce|https://puppet.com/docs/puppet/6.6/function.html#reduce] stats that 'If the structure has one value, Puppet returns the value and does not call the lambda.'\u00a0 however this does not seem to be the case\n\n\u00a0\n{code:java}$ puppet apply -e '$ret = [\"foo\"].reduce(\"\") | $a, $b | {\"${a}-${b}-\" } notice($ret)'\n$ Notice: Scope(Class[main]): -foo-{code}\nI have preformed the above test in puppet 4.8 and puppet 5.5. and the lambda is run for both\n\n\u00a0\n\n*Suggested improvement:*\n\n[https://puppet.com/docs/puppet/6.6/function.html#reduce]\n\n_Current text :_\n\nIf the structure has one value, Puppet returns the value and does not call the lambda.\n\n_Suggested improvement:_\n\nRemove this sentence entirely\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54235", "fixedVersions": [], "id": "54235", "issueType": "Bug", "key": "DOCUMENT-1035", "labels": [ "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:e83e1a27-3346-490e-9e8f-a84f75436063", "resolution": "Fixed", "resolutionDate": "2020-05-05T17:40:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "reduce: If the structure has one value", "timeSpent": "PT0S", "updated": "2020-05-05T17:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [ { "attacher": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "created": "2019-07-15T11:33:00.000000", "name": "Screenshot 2019-07-15 09.45.48.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14192" }, { "attacher": "5caf5082c75c532928c11f7b", "created": "2019-07-15T11:12:00.000000", "name": "links-explorer.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14272" } ], "comments": [ { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Based on my reading of the doc page, I'd say the Usage notes section is correct. Maybe a bit lacking, but technically correct.\n\nbq. is 0 if the catalog was successfully applied\nThis is accurate.\n\nbq. and 1 if the run either failed or wasn't attempted\nThis is also accurate.\n\nThe Usage notes bit doesn't mention the possibility of _other_ exit codes (2,4, and 6), but what it does mention is accurate.", "created": "2019-07-10T14:50:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "[~accountid:557058:bb372eb8-0089-49ba-8b22-213d5bf560f6] How about: The UX when attempting to obtain advanced exit codes for {{puppet agent}} is lacking.", "created": "2019-07-10T15:07:00.000000" }, { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Sure, that works.\n\nAnd to put a user story around it:\n * As a Puppet user wanting to understand the exit codes of {{puppet agent \\-t}}, I'd expect the the Usage Notes section regarding {{'--test'}} to mention all possible exit codes, not just {{0}} and {{1}}.\n\n\u00a0", "created": "2019-07-10T15:21:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "As is, the usage notes strongly *imply* that the only possible exit codes are {{0}} and {{1}}, and incorrectly *state* that successful catalog application results in an exit code of {{0}}.\n\nBut the exit code is *not* always {{0}} when the catalog is successfully applied. The exit code may be either {{0}} or {{2}}. Depending on your definition of \"successfully applied\", the exit code may alternatively be {{4}} or {{6}}.\n\nThe first sentence may be made _technically_ correct (though no more useful) by replacing \"is\" with \"may be\", as follows:\n\n{quote}\nThe exit code after running with {{'\\--test'}} may be {{0}} if the catalog was successfully applied, or {{1}} if the run either failed or wasn't attempted (due to another run already in progress).\n{quote}\n\nA much more useful change would be:\n\n{quote}\nThe exit code after running with {{'\\--test'}} is {{0}} if the catalog was successfully applied with no changes or failures, and {{1}} if the run either failed or wasn't attempted (due to another run already in progress). See *{{detailed-exitcodes}}* for other possible values.\n{quote}\n\nor even:\n\n{quote}\nAfter running with {{'\\--test'}}, an exit code of {{0}} means the system was already in the desired state, because the catalog was applied with no changes or failures. See *{{detailed-exitcodes}}* for more information.\n{quote}\n\nThis last version is probably best, because it explains the mnemonic", "created": "2019-07-13T08:37:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The following change was PR'd last week. This ticket is pending merge.\n\n{noformat}\nThe exit code after running\nwith '--test' is one of the following:\n* 0: The run succeeded with no changes or failures", "created": "2019-07-15T10:13:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "Any chance we can link the PR to the ticket?", "created": "2019-07-15T10:38:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:5caf5082c75c532928c11f7b], the PR is linked to the ticket", "created": "2019-07-15T10:45:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "I'm sorry for being unclear.\n\nI am currently viewing this ticket. I do not see, within this ticket, a link to the mentioned PR.\n\nI would like to see, in this ticket, a link to the PR which addresses this ticket.\n\nPerhaps if I were viewing the PR (for which I do not have a link), I would see a link to this ticket.\n\nHere's what I see when I view the [Links Explorer|https://puppet.atlassian.net/browse/DOCUMENT-1034?page=com.otpl.jira.plugins.lxp:link-issue-tab-panel] tab on this ticket:\n\n !links-explorer.png|thumbnail! \n\n", "created": "2019-07-15T11:13:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "I added myself as a watcher for this ticket so that I would receive email updates about the progress of this ticket. Apparently a PR was submitted that relates to this ticket, but I was not notified because nobody updated this ticket with a link to the PR.\n\nIf you would be so kind as to provide a link to the PR which closes this ticket, I would be happy to add that link to the Links Explorer section of this ticket, thereby notifying watchers such as myself.", "created": "2019-07-15T11:18:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:5caf5082c75c532928c11f7b], the ticket is linked, so if you aren't seeing it there must be some kind of permission issue or something. The PR is at https://github.com/puppetlabs/puppet/pull/7607 \n\n!Screenshot 2019-07-15 09.45.48.png|thumbnail! ", "created": "2019-07-15T11:33:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "Yeah, I would guess that the \"permissions issue\" affects all people who don't have merge permissions on the associated repository.\n\nShould I post a new bug-report to note that most people cannot see links from tickets.puppetlabs.com to github.com ?", "created": "2019-07-15T15:07:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:5caf5082c75c532928c11f7b], no, I think it's working as intended but I just didn't realize. I'll ask about it and can pursue it if those are meant to be visible. Thank you!", "created": "2019-07-19T17:06:00.000000" } ], "components": [ "Puppet Client/Agent" ], "created": "2019-07-10T14:39:00.000000", "creator": "5caf5082c75c532928c11f7b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The noted paragaph in the Usage Notes section should be corrected or removed." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1ba2772f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvmtb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_80610931_*|*_10007_*:*_1_*:*_699547947_*|*_3_*:*_1_*:*_217519_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1192334" } ], "description": "The [Usage notes|https://puppet.com/docs/puppet/6.6/man/agent.html#USAGE-NOTES] section of the Man Page for puppet agent says:\n\n{quote}\nThe exit code after running with '{{\\--test}}' is {{0}} if the catalog was successfully applied, and {{1}} if the run either failed or wasn't attempted (due to another run already in progress).\n{quote}\n\nThis is incorrect, because '{{\\--test}}' includes '{{\\--detailed-exitcodes}}', as noted later on the same page.\n\n{quote}\n*{{\\--test}}*\nEnable the most common options used for testing. These are '{{onetime}}', '{{verbose}}', '{{no-daemonize}}', '{{no-usecacheonfailure}}', '{{detailed-exitcodes}}', '{{no-splay}}', and '{{show_diff}}'.\n{quote}\n\nAnd\n\n{quote}\n*{{\\--detailed-exitcodes}}*\nProvide extra information about the run via exit codes; only works if {{\\'--test'|| or {{'\\--onetime'}} is also specified. If enabled, {{'puppet agent'}} will use the following exit codes:\n\n{{0}}: The run succeeded with no changes or failures; the system was already in the desired state.\n\n{{1}}: The run failed, or wasn't attempted due to another run already in progress.\n\n{{2}}: The run succeeded, and some resources were changed.\n\n{{4}}: The run succeeded, and some resources failed.\n\n{{6}}: The run succeeded, and included both changes and failures.\n{quote}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55130", "fixedVersions": [], "id": "55130", "issueType": "Improvement", "key": "DOCUMENT-1034", "labels": [ "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5caf5082c75c532928c11f7b", "resolution": "Fixed", "resolutionDate": "2019-07-19T15:45:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Usage notes for --test are incorrect.", "timeSpent": "PT0S", "updated": "2019-07-19T17:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:5caf5082c75c532928c11f7b], it looks like you used a template that created a lot of unintended subtasks when you filed it. I am deleting the subtasks, but just wanted to explain the activity you're seeing.", "created": "2019-07-08T12:39:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "Thank you, [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79].\nI was trying to find a template that was appropriate to this task, and it seems that every time I selected a new template from the dropdown (to see what it looked like), Jira created a duplicate issue.", "created": "2019-07-09T10:38:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I'm sorry for the confusion, [~accountid:5caf5082c75c532928c11f7b]. I've made a docs template available for this project now, so hopefully that will help for the future. As to this issue itself, I've pushed a fix to the docs and made a PR to the source to add the link. Thank you for the ticket!", "created": "2019-07-10T16:33:00.000000" } ], "components": [ "Puppet Server" ], "created": "2019-07-08T08:10:00.000000", "creator": "5caf5082c75c532928c11f7b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@51070ab9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvklb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_12432067_*|*_10007_*:*_1_*:*_757402027_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_5522732_*|*_10006_*:*_2_*:*_184557006" } ], "description": "In the documentation for the [environment_timeout|https://puppet.com/docs/puppet/latest/configuration.html#environmenttimeout] setting:\n{quote}We recommend setting this to unlimited and explicitly refreshing your Puppet master as part of your code deployment process.\n * With Puppet Server, you should refresh environments by calling the environment-cache API endpoint. See the docs for the Puppet Server administrative API.{quote}\nThe text\n{quote}environment-cache API endpoint{quote}\nshould link to [https://puppet.com/docs/puppetserver/latest/admin-api/v1/environment-cache.html]\n\n\u00a0The text\n{quote}Puppet Server administrative API{quote}\nshould link to an administrative API overview page, but there doesn't seem to be one.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54396", "fixedVersions": [], "id": "54396", "issueType": "Improvement", "key": "DOCUMENT-1027", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5caf5082c75c532928c11f7b", "resolution": "Fixed", "resolutionDate": "2019-07-19T10:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The documentation for environment_timeout should include a link", "timeSpent": "PT0S", "updated": "2019-07-19T10:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd], can you verify that this is the right change to make?", "created": "2019-07-08T15:07:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "See\u00a0https://puppetcommunity.slack.com/archives/C113FRBRU/p1562373343410500", "created": "2019-07-09T10:33:00.000000" }, { "author": "557058:c16d7f1a-bff7-46b5-a8c1-7189ecf15616", "body": "To be honest, I feel like there's a bug here.\u00a0 I can't imagine a reason why component _should_ be a reserved name.\n\nIf it is a bug though, it's a long-standing one. Documenting it as off-limits may be the right approach.", "created": "2019-07-09T16:37:00.000000" }, { "author": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "body": "So, I did a test to try and find common words that fail and this is the result:\n\n{noformat}\nand\nany\narray\ncase\nclass\ncollection\ncomponent\nconsumes\ndefault\ndefine\nelse\nfalse\nfloat\nfunction\nhash\nif\nin\ninherits\ninteger\nmain\nnode\nnumeric\noptional\nor\npattern\nprivate\nproduces\nregexp\nscalar\nsite\ntrue\ntuple\ntype\nunit\nunless\nvariant\n{noformat}\n\nMost of these make sense, but some were quite surprising and probably should be documented in the official documentation.\n\nThe script used was as follows:\n\n{code:bash}\n#!/bin/sh\n\naspell -l en dump master | grep -v \"'\" | grep -v \"^[[:upper:]]\" | sort -n | grep -x '.\\{2,10\\}' > test_dict\n\ngood='good_words'\nbad='bad_words'\n\nfor x in `cat test_dict`", "created": "2019-07-10T08:14:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you for testing this [~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9]!\n\nOf that list, the following three words are not listed on the [reserved words page|https://puppet.com/docs/puppet/latest/lang_reserved.html].\n\n{noformat}\ncomponent\nregexp\nunit\n{noformat}\n\nI'll add these words to the page, because obviously they don't work, but would still like to hear from [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] about whether this is intentional and why they are disallowed.", "created": "2019-07-10T14:30:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Added words to reserved words list for v 4.10, 5.x, and 6.x.", "created": "2019-07-10T16:04:00.000000" } ], "components": [ "Puppet Language" ], "created": "2019-07-05T17:26:00.000000", "creator": "557058:c16d7f1a-bff7-46b5-a8c1-7189ecf15616", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@10c59adc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvkgf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_250853714_*|*_3_*:*_1_*:*_5607574_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_170602837" } ], "description": "This may not be intentional, but using the word \"component\" as a class name fails under every version of Puppet that I've tested, going back at least to version 4.0.0.\n\n{{$ puppet apply -e 'class component \\{ } include component'}}\n{{Error: Evaluation Error: Error while evaluating a Function Call, Cannot find definition Class (line: 1, column: 21) on node localhost.localdomain}}\n\nIt seems like the simple answer would be to document \"component\" as a reserved class name.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55129", "fixedVersions": [], "id": "55129", "issueType": "Bug", "key": "DOCUMENT-1026", "labels": [ "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:c16d7f1a-bff7-46b5-a8c1-7189ecf15616", "resolution": "Fixed", "resolutionDate": "2019-07-10T16:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"component\" should be on the reserved class names list", "timeSpent": "PT0S", "updated": "2019-07-10T16:04:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:623a46a67910a200718ac239], thanks for the ticket. If I understand you correctly, you'd like to see `cwd` added to paragraphs such as this one from the `onlyif` section of the document:\n\n{noformat}\nNote that this test command runs with the same provider, path, user, and group as the main command. If the path isn\u2019t set, you must fully qualify the command\u2019s name.\n{noformat}\n\nIs that correct?", "created": "2019-07-11T13:47:00.000000" }, { "author": "623a46a67910a200718ac239", "body": "Yes, [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], that is update I envisioned.\n\nThanks.", "created": "2019-07-11T15:09:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I've pushed changes to existing docs and PR'd a change to the code the docs are generated from.", "created": "2019-07-11T17:38:00.000000" } ], "components": [], "created": "2019-07-04T08:15:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6f22c447" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvk13:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_624696511_*|*_10007_*:*_1_*:*_667504181_*|*_3_*:*_1_*:*_787482_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_12889624" } ], "description": "The docs for the {{Exec}} resource type's {{onlyif}} and {{unless}} parameters document several other specific parameters that apply to the evaluation of these. The {{cwd}} parameter is not documented among them, but it should be, as in practice it has affected them historically and does affect them in current versions of Puppet 5 and 6.\n\nThis is directly related to issue PUP-9194, which corrected regressions of this very behavior in Puppet 5.5 and 6.0.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54395", "fixedVersions": [], "id": "54395", "issueType": "Improvement", "key": "DOCUMENT-1025", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Fixed", "resolutionDate": "2019-07-19T11:00:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Clarify Exec's use of cwd", "timeSpent": "PT0S", "updated": "2019-07-19T11:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "It _looked_\u00a0like this is an ecosystem wide issue with newer versions of OpenSSH. See Bolt encountering this issue (and linked issues) in\u00a0[Bolt's pre-docs|https://github.com/puppetlabs/bolt/blob/master/pre-docs/bolt_known_issues.md#false-errors-for-ssh-keys-generated-with-ssh-keygen-openssh-78-and-later]. However, r10k is using either a version of libgit2/libssh2 that we ship in PE or is using the git cli itself (not the Ruby version of ssh that bolt uses).\n\nI've opened an internal PR to see if we can bump libssh2 to a version that might correctly use those keys (not 100% sure the bump will fix the keys handling or that the bump won't also cause regressions with what we compile against libssh2).\n\nRegardless, of whether or not that fixes it we should probably update the docs to include a bit similar to what the bolt docs say.", "created": "2019-07-08T13:43:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Docs: Add a known issue for PE based on the information here and the Bolt known issue.", "created": "2019-07-08T15:03:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "Linked the (internal) ticket to track fixing this issue in our library.", "created": "2019-07-09T13:56:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "I believe we've fixed this internally and should go out in the next \"z\" release of our latest PE - 2019.1.1.", "created": "2019-07-12T17:13:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Closing since this was fixed in\u00a0CODEMGMT-1213.", "created": "2019-12-19T17:17:00.000000" } ], "components": [ "Code Management", "PE" ], "created": "2019-07-03T12:10:00.000000", "creator": "557058:3f5ca679-2eb3-435d-bea9-fcced1418643", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@981bc12" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvjof:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_431791186_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_10494439_*|*_10006_*:*_1_*:*_14181359609" } ], "description": "[https://puppet.com/docs/pe/2019.1/control_repo.html] \u2013 instructions for ssh-keygen don't work properly on RHEL8.\n\nThe provided ssh-keygen command on RHEL8 produces a key that isn't compatible with the ssh libraries shipped with 2019.1. Either need to update those libraries to support more SSH private key formats or add \"-m PEM\" to the options when run on RHEL8.\n\nError output in this situation is also not helpful: doesn't differentiate between an error parsing the file and an error reading the file.", "environment": "RHEL8", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54232", "fixedVersions": [], "id": "54232", "issueType": "Bug", "key": "DOCUMENT-1024", "labels": [ "code-mgmt", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3f5ca679-2eb3-435d-bea9-fcced1418643", "resolution": "Done", "resolutionDate": "2019-12-19T17:17:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation has ssh-keygen that produces unusable key on RHEL8", "timeSpent": "PT0S", "updated": "2019-12-19T17:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:58c5336a-e9d7-4eff-b221-85517090556b]! We made this change a couple of years ago, if I recall correctly, at a time when we were making some big changes to our docs tooling and information architecture. A URL with /latest/ in it still redirects to the latest version, but as you say, it redirects to a specific version rather than a URL that actually says \"latest\". \n\nWe had some technical reasons for this change as I recall, but we also felt like \"latest\" was a bit vague, and that users should be directed to an actual version. I know that makes it more tedious to just copy and bookmark URLs, but if you replace the version with /latest/, it will go to latest.", "created": "2019-07-02T11:13:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:58c5336a-e9d7-4eff-b221-85517090556b]! I closed this as \"won't fix\" because this was an intentional architecture decision we made. However, I also wanted to let you know that as of today, we've implemented a banner to alert users that they are not on the latest version. I know it's not exactly what you were looking for, but I hope it will help folks who might be trying to get to latest.", "created": "2019-07-12T14:16:00.000000" } ], "components": [], "created": "2019-06-26T11:28:00.000000", "creator": "557058:58c5336a-e9d7-4eff-b221-85517090556b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7a00aba6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvebb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1304390295_*|*_6_*:*_1_*:*_0" } ], "description": "Until recently (maybe early 2019?), doc URLs with `/latest` in the string always pointed to the latest. You could easily copy and paste or bookmark the URL and it would continue to point to the latest.\n\nAfter the recent changes, a URL like https://puppet.com/docs/puppet/latest/type.html would rewrite to https://puppet.com/docs/puppet/6.5/type.html. While it is nice to have \"pinned\" docs at times, when referencing latest it becomes more difficult to bookmark or C&P the URL to share with others. I would like to see the behavior revert.\n\nAlternatively, some keyboard shortcuts to select latest/specific (ala github's `y` shortcut to change the URL to a specific revision from a branch name) would provide simple workarounds to select which URL is preferred..", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54765", "fixedVersions": [], "id": "54765", "issueType": "Bug", "key": "DOCUMENT-1022", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:58c5336a-e9d7-4eff-b221-85517090556b", "resolution": "Won't Fix", "resolutionDate": "2019-07-11T13:47:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The `/latest` path unexpectedly rewrites to a specific version", "timeSpent": "PT0S", "updated": "2019-07-12T14:17:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "[~accountid:70121:4084c786-3448-4ef8-8889-3c056e90bb64] This is a great idea. Thanks!\u00a0", "created": "2019-09-03T11:16:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I have fixed the braces in the example given, but we will make a note to review curly space bracing int he rest of the docs as part of a team project.\u00a0", "created": "2019-09-06T14:12:00.000000" } ], "components": [ "Style Guide & Usage" ], "created": "2019-06-26T01:36:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@58d475a0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzvdun:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Aug/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1340036483_*|*_3_*:*_1_*:*_769695_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_3359913240_*|*_10005_*:*_1_*:*_1565492814" } ], "description": "Code examples in the documentation should follow the Style Guide. For example, in https://puppet.com/docs/puppet/6.5/lang_classes.html there are several instances where there is no space after the opening brace.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54495", "fixedVersions": [], "id": "54495", "issueType": "Bug", "key": "DOCUMENT-1021", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2019-09-06T14:12:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "code examples in documentation should follow Style Guide", "timeSpent": "PT0S", "updated": "2019-09-06T14:12:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "Ping [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] for comment on the Types that are not in the Puppet Specifications", "created": "2019-06-20T20:13:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good catch on these, [~accountid:557058:6713b848-54a4-4f2e-9636-a24860d9c3f2], thank you!\n\nTo fix this, we'll need information about the Types that are not in the spec. I'm marking this ticket as \"needs information\" based on that.\n\nIt's pretty simple to just add Types to the pages. However, I'm marking this ticket as \"medium\" sized because the categorization of the Types in docs is not quite the same as that in the spec, so we should investigate whether the docs categories should be changed to better align to the spec.\n\nAdditionally, I think the way the Types are listed on lang_data_type.html is confusing. We should consider using a definition list for these instead of a table.", "created": "2019-06-21T10:28:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think {{TypeAlias}} and {{TypeReference}} can be considered internal to the type system.\nAll other types are meaningful - although not in every context.\n\n{{Object}} isn't really experimental - it is very much in use (and very useful as a safe way to extend Puppet - it is for example used by Bolt, and Lyra). We have tickets to write the specification - it is documented in the Pcore google document, and I made a series of blog posts about it. \n\nSee:\n* https://docs.google.com/document/d/1D1yXXDIw6a67o_hLeqdHWDq2bM41C4eToeJK9tzUc98/edit (roughly 80-90% of what is described is implemented", "created": "2019-06-25T10:20:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] Any progress on this? Just this week there have been several questions about {{SemVer}} and {{URI}} - people just don't know they exist and thus miss out on good stuff that is available in Puppet. Once they know about them, they can go read in the specs. To quickly improve on the situation maybe add them with a simple explanation what the type is for and then add more detail over time?", "created": "2020-01-30T04:22:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Progress made during docs hack day: I updated the list of data types to include *all* the types listed above, with links to our docs wherever relevant and a pointer to the spec for more information.\n\nI also added some of the missing types to the abstract parent types section, as that seemed an appropriate home for them:\n * Iterable\n * Iterator\n * RichData (this one wasn't on Glenn's list, but I noticed it was missing from the docs)\n * ScalarData\n\n[~accountid:557058:7edde36a-845c-4e08-9172-c7b2f0265ea1] can you please copyedit my work?\u00a0[https://github.com/puppetlabs/osp-docs/commit/ad2275f6d025da70dcfe6c153d629a31204b05fb]\n\nNext steps for this ticket are to document the remaining data types more thoroughly:\u00a0\n * Binary\n * Deferred\n * RunTime\n * SemVer\n * SemVerRange\n * URI\n * Variant\n * Object\n * TypeSet\n * Error\u00a0\n * Init\n\nNote: Timespan and Timestamp are documented here:\u00a0[https://puppet.com/docs/puppet/latest/lang_data_time.html]", "created": "2020-02-24T15:12:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "A couple tiny edits, one question, pushed to your branch. I like the restructure, and will be interested to hear if developers like the completeness a little better than before. ", "created": "2020-02-24T15:27:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "The now-complete list of data types is live here:\u00a0[https://puppet.com/docs/puppet/latest/lang_data_type.html#reference-2534]\u00a0", "created": "2020-02-24T16:28:00.000000" }, { "author": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "body": "[~accountid:557058:7edde36a-845c-4e08-9172-c7b2f0265ea1] Overall... It's a great improvement!! Thanks.\n\nThe introductory paragraph is a little confusing, but these are quite abstract concepts e.g. Trying to explain the Type of Types. so I don't have any recommendations to make it better.", "created": "2020-02-24T21:50:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "[~accountid:557058:6713b848-54a4-4f2e-9636-a24860d9c3f2] Ha! That's how I felt too. It's like, well, a third-year university comp sci course probably covers this.", "created": "2020-02-25T08:50:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I think the intro stating what {{Type}} data type is is fine - if you wanted to make it a bit clearer in the introduction it may be worth showing that the type of {{Integer}} is indeed {{Type[Integer]}} because then it is clearer that just {{Type}} matches all data types.\n\nThe way I usually describe types is that they are just named \"patterns\" that match \"values\", and that what you give within the brackets for a data type \"constrains\" the general pattern to a subset of what would be otherwise matched (e.g. {{Integer}} is all integers whereas {{Integer[1,5]}} defines a subset of all integers.\n\nIf you really want to explain {{Type}} a concrete example at the very end may be helpful. It is for example of value to know that a data type e.g. {{Integer}} is a \"value\" and can be assigned to variables, passed around etc. So if you wanted to write your own \"assert_type\" kind of function you may write something like this:\n\n{code:puppet}\nfunction myasserttype(Type $t, Any $value) >> Boolean {\n return $value =~ $t\n}\n{code}\nAnd someone could call this:\n{code:puppet}\nmyasserttype(Integer[1,5], 8) # would return false\n{code}\n\nNow, assume that you want to do some kind of assertion that only works for numerical data types. Then your \"mathassertion\" function could perhaps look like this:\n\n{code:puppet}\nfunction mymathassert(Type[Numeric] $t, Numeric $value) >> Boolean {\n return $value =~ $t\n}\n{code}\n\nAnd now it would be illegal to do a call like this (since a {{String}} data type is not a {{Type[Numeric]}}:\n{code}\nmymathassert(String, 42)\n{code}\n\nAs I said, it is fine as it is... and the new version of the docs is a great improvement.", "created": "2020-02-25T09:20:00.000000" } ], "components": [], "created": "2019-06-20T20:12:00.000000", "creator": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@46f137d7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzva7z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_50732899_*|*_3_*:*_1_*:*_3967676985_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_947197218_*|*_10006_*:*_2_*:*_20826461802" } ], "description": "I was doing a review of the Data Types documentation (https://puppet.com/docs/puppet/6.5/lang_data_type.html and https://puppet.com/docs/puppet/6.5/lang_data_abstract.html) and I think I noticed some Data Types that missing. \n\nSo our documentation lists:\n{code}\nAny\nArray\nBoolean\nCallable\nCatalogEntry\nClass\nCollection\nData\nDefault\nEnum\nFloat\nHash\nInteger\nNotUndef\nNumeric\nOptional\nPattern\nRegexp\nResource\nScalar\nSensitive\nString\nStruct\nTuple\nType\nUndef\n{code}\n\nHowever the Puppet Specifications site (https://github.com/puppetlabs/puppet-specifications/blob/master/language/types_values_variables.md) also lists these additional Types which are not documented\n{code}\nBinary\nDeferred\nIterable\nIterator\nRuntime\nScalarData\nSemVer\nSemVerRange\nTimespan\nTimestamp\nURI\nVariant\n\nThe following types are mentioned as Experimental so not surprised they're not documented\nObject\nTypeSet\n{code}\n\nHowever the Puppet Type code also has definitions for these Types which are not documented either in the Puppet Specifications (which is odd) nor on the Puppet Documentation site\n{code}\nError\nInit\nTypeAlias\nTypeReference\n{code}\n\nError\nhttps://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/types/type_factory.rb#L531-L536\n\nInit\nhttps://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/types/type_factory.rb#L75\n\nTypeAlias\nhttps://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/types/type_factory.rb#L607-L613\n\nTypeRefrence\nhttps://github.com/puppetlabs/puppet/blob/master/lib/puppet/pops/types/type_factory.rb#L615-L621\n\n\nMy expectation would be that all Types should be listed in the Puppet Specifications and should at least be worthy of a note in the Puppet Documentation site e.g.\n\n{code}\nThe following types exist but are not intended to be used by Module authors:\nInit\nTypeAlias\n....\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54764", "fixedVersions": [], "id": "54764", "issueType": "Bug", "key": "DOCUMENT-1020", "labels": [ "docs-hack", "lang", "medium", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:6713b848-54a4-4f2e-9636-a24860d9c3f2", "resolution": "Fixed", "resolutionDate": "2020-04-14T08:40:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Missing Puppet Data Types from documentation", "timeSpent": "PT0S", "updated": "2020-04-14T08:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thank for this ticket, it's an excellent suggestion to add this information to the system requirements page.\u00a0\n\n[~accountid:557058:cf9507a2-54bf-4dec-90af-b6ff0ddd3f65] can you help me track down the port number for an external DynamoDB database, please?\u00a0", "created": "2019-06-27T12:44:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "A new \"Supported external databases\" section is now in the docs:\u00a0[https://puppet.com/docs/continuous-delivery/2.x/cd_system_requirements.html#supported-external-databases]", "created": "2019-07-03T16:37:00.000000" } ], "components": [], "created": "2019-06-20T13:21:00.000000", "creator": "70121:1c1d139c-864a-412e-9799-4b3b7370e9cf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50e92e62" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzv9vr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "27/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_427414524_*|*_3_*:*_1_*:*_533037645_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_174519225" } ], "description": "The system requirements for installing Puppet Continuous Delivery for Puppet Enterprise ([https://puppet.com/docs/continuous-delivery/2.x/cd_system_requirements.html]) don't include detailed requirements for using an external database.\n\nThe reader has to conclude the following databases are supported by reading the docs for each of the installation methods. Only MySQL and PostgreSQL are mentioned on the general system requirements page. The following databases appear to be supported by CD4PE.\n * AWS DynamoDB\n * MySQL\n * PostgreSQL\n\nThe general system requirements page is also missing the port number used for connecting to an AWS DynamoDB database.\n\nThe docker container installation method doc includes specific details about the MySQL database requirements that aren't mentioned on the general system requirements page.\n\n_\"Note: Your MySQL database must use the latin1 character set and latin1_swedish_ci collation.\"_", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54576", "fixedVersions": [], "id": "54576", "issueType": "Bug", "key": "DOCUMENT-1019", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:1c1d139c-864a-412e-9799-4b3b7370e9cf", "resolution": "Fixed", "resolutionDate": "2019-07-03T16:38:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE System Requirements Missing External Database Requirements", "timeSpent": "PT0S", "updated": "2019-07-03T16:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi and thank you for the ticket! I'm closing this as a duplicate, but you can watch DOCUMENT-1017 for progress. ", "created": "2019-07-02T13:02:00.000000" } ], "components": [], "created": "2019-06-14T06:09:00.000000", "creator": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6f838631" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzv4sf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1579997959_*|*_6_*:*_1_*:*_0" } ], "description": "The documentation still does not make it clear that custom executable facts can output structured fact data in json format\n\nhttps://puppet.com/docs/facter/3.9/custom_facts.html#executable-facts-----unix", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55027", "fixedVersions": [], "id": "55027", "issueType": "Improvement", "key": "DOCUMENT-1018", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "resolution": "Duplicate", "resolutionDate": "2019-07-02T13:02:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "External Executable Fact Documentation - structured facts", "timeSpent": "PT0S", "updated": "2019-07-02T13:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "Thanks for opening the issue! Unfortunately, I'm not grokking what you mean by point #1. How does the compiler and the main master's webserver.conf differ?", "created": "2019-07-02T15:44:00.000000" }, { "author": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "body": "The four settings I listed, namely ssl-cert, ssl-key, ssl-ca-cert, ssl-crl-path are not present in the webserver.conf file by default. But those settings need to be present and set correctly or the compile masters will complain about the missing crl.pem etc.", "created": "2019-07-03T06:06:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "That's weird and maybe a bug then. We override those values with the ones from puppet.conf regardless of whether it's a compiler or primary master [see|https://github.com/puppetlabs/puppetserver/blob/5.3.x/src/clj/puppetlabs/services/config/puppet_server_config_core.clj#L111]...\n\nDid you run the agent prior to starting up the compiler service to retrieve the certs and crl?", "created": "2019-07-03T09:57:00.000000" }, { "author": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "body": "Yes , the agent was run prior. And if the settings are removed, subsequent agent runs will fail until the settings are added back in.\n", "created": "2019-07-03T10:00:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "Okay, we'll get the docs updated, thanks so much for your time!", "created": "2019-07-03T10:15:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Resolved with this PR to master: https://puppet.atlassian.net/browse/DOCUMENT-1016\n\nChanges will be reflected in latest documentation.", "created": "2020-04-24T11:47:00.000000" } ], "components": [], "created": "2019-06-13T13:43:00.000000", "creator": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3e4ee24b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzv46n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1640738904_*|*_3_*:*_1_*:*_3379197970_*|*_10009_*:*_1_*:*_2058905767_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_17872038494_*|*_10005_*:*_1_*:*_2344604536" } ], "description": "the compile master documentation [ https://puppet.com/docs/puppetserver/5.1/scaling_puppet_server.html#creating-and-configuring-compile-masters ] about setting up separate compile and CA master servers is incomplete and misses some critical steps\n\nspecifically:\n1. fails to mention the changes required in /etc/puppetlabs/puppetserver/conf.d/webserver.conf around the configuration of the certs\n\n ssl-cert: \"/etc/puppetlabs/puppet/ssl/certs/compile.vagrant.pem\"\n ssl-key: \"/etc/puppetlabs/puppet/ssl/private_keys/compile.vagrant.pem\"\n ssl-ca-cert: \"/etc/puppetlabs/puppet/ssl/certs/ca.pem\"\n ssl-crl-path: \"/etc/puppetlabs/puppet/ssl/crl.pem\"\n\n2. should specific that compiles masters should have their puppet.conf pointed to the CA master.\n\n\n\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54492", "fixedVersions": [], "id": "54492", "issueType": "Bug", "key": "DOCUMENT-1016", "labels": [ "docs-hack", "server" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6b60b05-5517-4e3d-b888-2c76e9f5f74e", "resolution": "Fixed", "resolutionDate": "2020-04-24T11:47:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The puppet compile master documentation is incomplete", "timeSpent": "PT0S", "updated": "2020-04-24T11:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5a46c85fe0a6f308201def98", "attachments": [], "comments": [ { "author": "557058:adac4e58-01ac-4fce-8be9-94131c26c73d", "body": "fyi [~accountid:5a53f77aeb8cdb7a2cb274b1] [~accountid:557058:c047210e-99d5-4da3-a366-d9618caf3740]", "created": "2019-06-11T14:39:00.000000" }, { "author": "557058:0b16fa29-44bc-4e11-82b0-a346967ad808", "body": "Would we also want to put the Okta logo up on the \"Integrations\" page with a link back to this docs page? If so, I can make a PE ticket for that.", "created": "2019-06-11T15:34:00.000000" }, { "author": "5a46c85fe0a6f308201def98", "body": "[~accountid:557058:0b16fa29-44bc-4e11-82b0-a346967ad808] Updated intro paragraph: \n [https://puppet.com/docs/pe/2019.1/rbac_ldap_intro.html]\n{quote}Puppet Enterprise connects to external Lightweight Directory Access Protocol (LDAP) directory services through its role-based access control (RBAC) service. Because PE integrates with cloud LDAP service providers such as Okta, you can use existing users and user groups that have been set up in your external directory service.\n{quote}", "created": "2019-08-05T16:02:00.000000" }, { "author": "557058:0b16fa29-44bc-4e11-82b0-a346967ad808", "body": "Nice, thanks Kate!", "created": "2019-08-05T18:20:00.000000" } ], "components": [], "created": "2019-06-11T14:37:00.000000", "creator": "557058:0b16fa29-44bc-4e11-82b0-a346967ad808", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7a28afa9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzv2vz:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Enhancement" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Okta LDAP is supported by Puppet Enterprise (maybe CD4PE as well?)" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_512252227_*|*_3_*:*_1_*:*_1287555_*|*_10009_*:*_1_*:*_8419615_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4243464732" } ], "description": "Apparently Okta had to fix something on their end, but LDAP now works with Okta. [~accountid:557058:adac4e58-01ac-4fce-8be9-94131c26c73d] has more details. It would be good to add a note to the docs that makes it clearer that PE should work with any LDAP service, including a hosted one such as Okta. Something like \"Puppet Enterprise integrates with cloud LDAP service providers such as Okta.\"\n\nhttps://puppet.com/docs/pe/2019.1/rbac_ldap_intro.html\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54488", "fixedVersions": [], "id": "54488", "issueType": "Improvement", "key": "DOCUMENT-1015", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0b16fa29-44bc-4e11-82b0-a346967ad808", "resolution": "Done", "resolutionDate": "2019-08-05T18:21:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add note to external directory (LDAP) PE docs for Okta compatibility", "timeSpent": "PT0S", "updated": "2019-08-05T18:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [], "comments": [ { "author": "5caf5082c75c532928c11f7b", "body": "What _is_ the \"expected page\", I wonder.", "created": "2019-06-04T11:39:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Pretty sure the expected page is\u00a0[https://puppet.com/docs/puppetserver/6.0/http_certificate.html]\u00a0(checking on whether that's the right version for PE2019.1 though, might be 6.3). Will fix affected PE versions of this page.\u00a0", "created": "2019-06-05T09:11:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "There's a bunch of links to the wrong version of Puppet/Puppet Server/PuppetDB on that page for 2019.1. I'll fix em all on this ticket", "created": "2019-06-05T10:38:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Fixed in 2019.0 and 2019.1\u00a0docs \u2013 in Puppet 6, the CA API docs moved from Puppet to Puppet Server, so I updated this API Index table to point to the right place. For 2019.1, I also updated the other API docs and related information links to Puppet, Puppet Server, and PuppetDB to point to the correct corresponding version.\n\nThanks for reporting this [~accountid:557058:03aedc5a-47b0-4c60-a13f-46427c87153e].", "created": "2019-06-05T13:02:00.000000" } ], "components": [], "created": "2019-06-04T11:35:00.000000", "creator": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@53631fcf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuy5j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_77647776_*|*_3_*:*_1_*:*_8631473_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_5319421_*|*_10005_*:*_1_*:*_17034" } ], "description": "Steps to reproduce\n # Go to [https://puppet.com/docs/pe/2019.1/api_index.html]\n # Click on the Certificate Authority (CA) API hyperlink\n # Notice a 404 error\n\nExpected outcome: Link should go to the expected page and not result in a 404", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54575", "fixedVersions": [], "id": "54575", "issueType": "Bug", "key": "DOCUMENT-1014", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "resolution": "Fixed", "resolutionDate": "2019-06-05T13:02:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Link to Certificate Authority (CA) API on api_index.html page results in a 404", "timeSpent": "PT0S", "updated": "2019-06-05T13:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "This link was broken because the plugin was removed by Atlassian due to a lack of EULA. CD4PE no longer supports use of Bitbucket Server 4.x for new users", "created": "2019-06-11T11:27:00.000000" } ], "components": [], "created": "2019-06-03T07:36:00.000000", "creator": "5a6bea5a07f22c6af6ae9cef", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3bbadf4f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzux6n:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_96171892_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_608860094" } ], "description": "On the Configure Bitbucket Server repositories\u00a0page for CD4PE ([https://puppet.com/docs/continuous-delivery/2.x/configure_bitbucket.html)]\n\nin the section \"Configure the Bitbucket Server pull request plugin\"\n\nthere's a link to an Atlassian plugin which is no longer valid\n\n(https://marketplace.atlassian.com/apps/1213177/pull-request-notifier-for-bitbucket?hosting=server&tab=overview)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54485", "fixedVersions": [], "id": "54485", "issueType": "Bug", "key": "DOCUMENT-1013", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a6bea5a07f22c6af6ae9cef", "resolution": "Won't Fix", "resolutionDate": "2019-06-11T11:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken Link on Website", "timeSpent": "PT0S", "updated": "2019-06-11T11:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:6fc1f430-f771-4686-a97e-21c5e35f9100", "body": "What are you suggesting as a change? Nothing seems particularly obtuse to me. It's only a small paragraph. \n\nIf you provide an example of how you think it would be better, then it would be easier to compare /contrast and see if there are improvements to be made. ", "created": "2019-05-29T09:25:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Yes, please re-file this ticket when you have specifics about what's unclear (and what it should be changed to). Tech Pubs can't take action on this level of feedback.", "created": "2019-05-29T12:31:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Change:\n\nbq. If you encounter certain errors on your primary master replica after provisioning, you can reinitialize the replica. Reinitializing destroys and re-creates replica databases, as specified.\n\nTo:\n\nbq. If you encounter certain errors on your replica after provisioning, you can reinitialize the replica. Reinitializing destroys and re-creates replica databases, as specified.\n\nChange:\n\nbq. 1. On the primary master replica, reinitialize databases as needed:\n\nTo:\n\nbq. 1. On the replica, reinitialize databases as needed:\n", "created": "2019-05-29T18:17:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "In response to this customer's interpretation of the current phrasing:\n\u00a0\n{quote}When I try to run \"puppet infrastructure reinitialize replica\" on the Master, it tells me that the command can only be run on a replica.\n{quote}\n\u00a0", "created": "2019-05-29T18:18:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] We used the term \"primary master replica\" when we introduced HA to indicate that it applies to either your master in mono installs, or your MoM in mono+compile master installs. As of 2019.1, we simplified that terminology and now simply call it the replica or master replica (because there will eventually be a PDB replica in larger HA configurations). So, the change requested here has already happened circa 2019.1. \n\nhttps://puppet.com/docs/pe/2019.1/release_notes_pe.html#infrastructure-terminology-changes", "created": "2019-05-30T10:48:00.000000" } ], "components": [], "created": "2019-05-28T18:08:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1ade82f2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuto7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_66157307_*|*_4_*:*_1_*:*_50903258_*|*_5_*:*_1_*:*_0_*|*_6_*:*_1_*:*_20831890_*|*_10006_*:*_1_*:*_8484670_*|*_10005_*:*_1_*:*_19143" } ], "description": "[https://puppet.com/docs/pe/2019.0/configure_high_availability.html#task-1870]\n\n\"On the primary master replica, reinitialize databases as needed\" \n\nIt is easy for users (I have one instance already) to stop reading after \"primary master\".\n\nWe should review the entire document for clarity.\n", "environment": "All non-EOL versions of PE with HA", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55128", "fixedVersions": [], "id": "55128", "issueType": "Improvement", "key": "DOCUMENT-1012", "labels": [ "pe", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2019-05-30T10:48:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "reinitialize a replica documentation is easy to misread", "timeSpent": "PT0S", "updated": "2019-05-30T10:48:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [ { "author": "623a434701f8660070b62e0a", "body": "This ticket is a couple of years old. Here is a link to the latest documentation:\n\n[https://www.puppet.com/docs/puppet/8/style_guide.html#parameter-defaults|https://www.puppet.com/docs/puppet/8/style_guide.html#parameter-defaults|smart-link] \n\nI\u2019m not sure if this update is crucial or just \u201cnice to have.\u201d", "created": "2023-05-17T18:10:00.000000" } ], "components": [], "created": "2019-05-22T14:11:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5b576828" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [ "70121:81a73de1-7f52-49cd-b0b0-46c1b147202a" ] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuqo7:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "4.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/May/23" } ], "description": "I was trying to find a good reference for what APL is and how it works. While we talk about APL like it is a known thing, it is confusing for new users.\n\nThe only actual reference to APL, by name, that I could find is at [https://puppet.com/docs/puppet/5.3/style_guide.html#parameter-defaults] and links over to [https://puppet.com/docs/puppet/5.3/hiera_automatic.html#puppet-lookup] which takes a bit of work to figure out how it all fits together.\n\nIt would be great to have an APL page with pictures that walks new users through what happens as part of the standard Puppet workflow.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54116", "fixedVersions": [], "id": "54116", "issueType": "Improvement", "key": "DOCUMENT-1011", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "APL should have a single, well defined, reference", "timeSpent": "PT0S", "updated": "2023-05-17T18:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:5fc92cb6f8b012006900c169] - are you able to generate a list of docs pages that are 404ing?", "created": "2019-07-29T17:04:00.000000" }, { "author": "5fc92cb6f8b012006900c169", "body": "I'll take a look!", "created": "2019-07-29T17:14:00.000000" }, { "author": "557058:1dd06e71-4bcf-4744-bfcb-cd74fda73b7f", "body": "(original comment deleted to resolve duplicate username issue)\nComment from Matt Beck on July 30th:\n\nMichelle Fredette - here you go:\n\nhttps://docs.google.com/spreadsheets/d/1G2UINWduoYyxd70DSMSlSF7T4seURNQ6P556C5cp7eA/edit?usp=sharing", "created": "2019-07-30T15:29:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "I am sorry that new users are hitting lots of 404s from third-party sites like stack overflow. That's a frustrating experience. In the months since this ticket was opened, our website CMS has changed, we've archived many releases that are end-of-life, and our redirect engine is different (making some redirects easier to implement, and others harder). With all these changes, the docs team is challenged maintaining links from our own pages, let alone from sites we don't control.\n\nOften, you can get a stale URL to resolve by replacing the version number with the word \"latest\" (so {{puppet/4.8/architecture.html}} becomes {{puppet/latest/architecture.html}}). Also, if the links are very old, they might be pointing at {{docs.puppet.com}}", "created": "2020-02-21T10:07:00.000000" } ], "components": [ "Website & IA" ], "created": "2019-05-22T13:42:00.000000", "creator": "623c171cd32a94006a649bec", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1fc87678" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuqmn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jul/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_505570624_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_17863445758_*|*_10005_*:*_1_*:*_5381701778" } ], "description": "When we search on internet informations, stackoverflow provides many informations with answers. But links to puppet doc website point very very very often to 404.\n\nPuppet Inc lost help from search engine (like Google or Qwant, ...) to provide help to new comers.\n\nThat increase the entry barrier.\n\nI am a Puppet user since 2008 and member of Voxpupuli. But i have a coworker that explains this.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54482", "fixedVersions": [], "id": "54482", "issueType": "Bug", "key": "DOCUMENT-1009", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c171cd32a94006a649bec", "resolution": "Won't Do", "resolutionDate": "2020-02-21T10:07:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Doc web pages non-consistent provides access to 404", "timeSpent": "PT0S", "updated": "2020-02-21T10:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:557058:e0340dee-9d48-48c3-8c6a-02597af847c9],\n\nThank you for bringing this to our attention! That page name was changed in Puppet 5.3 to hiera_migrate.html. We set up a redirect, but it looks like that redirect works only for 5.3, instead of for all versions after that. I'll get a redirect for later versions set up.", "created": "2019-05-28T16:39:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Redirect has been merged and is functioning.", "created": "2019-06-05T12:43:00.000000" } ], "components": [], "created": "2019-05-22T07:58:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@61e2a57a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzuq9j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_526475116_*|*_10007_*:*_1_*:*_672981910_*|*_3_*:*_1_*:*_4076278_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_23218291" } ], "description": "I was looking at how to migration from Hiera 3 to Hiera 5 and noticed that this was bound to specific versions of Puppet.\n\nGood Link\n\n[https://puppet.com/docs/puppet/5.0/hiera_migrate_v3_yaml.html]\n\nBad Link\n\n[https://puppet.com/docs/puppet/latest/hiera_migrate_v3_yaml.html]\n\nPer conversation with [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd], migration documentation should always be made available and not be bound to specific versions of Puppet.\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54223", "fixedVersions": [], "id": "54223", "issueType": "Bug", "key": "DOCUMENT-1008", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Fixed", "resolutionDate": "2019-06-05T12:43:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Migration documentation shoul not be bound to a specific puppet version", "timeSpent": "PT0S", "updated": "2019-06-05T12:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This content was rewritten in 2017.3 and now appears in the first 3 sections here: https://puppet.com/docs/pe/2019.1/grouping_and_classifying_nodes.html#grouping-and-classifying-nodes", "created": "2019-05-17T16:43:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "thank you, I'm sure I've asked this before i realised.\u00a0", "created": "2019-05-20T03:11:00.000000" } ], "components": [], "created": "2019-05-17T05:36:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@c1ba73a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzunpj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_39993611_*|*_6_*:*_1_*:*_0" } ], "description": "the following page\u00a0[https://puppet.com/docs/pe/2017.1/console_classes_groups_getting_started.html]\u00a0\nappears to be unavailable in 2019.1 doco (and i believe 2019.x and 2018.x) the page explains what the concept of classification is before we include the term in the pages for \"managing nodes\" can it be reintroduced please as it is valuable and useful to be able to use for documentation and learning", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54574", "fixedVersions": [], "id": "54574", "issueType": "Improvement", "key": "DOCUMENT-1007", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Won't Fix", "resolutionDate": "2019-05-17T16:43:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "the page that explains what classification is appears to have been lost in 2019.1 documentation", "timeSpent": "PT0S", "updated": "2019-05-20T03:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "* forgeapi.pupptlabs.com: allow puppet module (install) downloads\n * pm.pupptlabs.com: allow puppet_agent module package downloads\n * s3amazonaws.com: allow puppet_agent module package downloads (redirect from pm.pupptlabs.com)\n * githhub.org: allow third-party module downloads (not served by the forge) and allow access to control repositories\n * rubygems.org: allow puppet/puppetserver gem (install) downloads", "created": "2019-05-16T16:02:00.000000" } ], "components": [], "created": "2019-05-16T16:01:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "* [forgeapi.puppet.com|http://forgeapi.puppet.com/], to autonomously deploy Forge modules and avoid using an alternative mechanism to manually provide them\n * [pm.puppetlabs.com|http://pm.puppetlabs.com/], required for upgrade and update, again can be wokred around by hand.\u00a0\n * [rubygems.org|http://rubygems.org/], dependency of external modules\n * [github.com|http://github.com/], source for external code\n * [s3.amazonaws.comhttp://s3.amazonaws.com/], the actual service behind PM. and forge packages, so required to support those two." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8536fe1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzun9b:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_90315620_*|*_5_*:*_1_*:*_0" } ], "description": "[https://puppet.com/docs/pe/2018.1/system_configuration.html#reference-7476]\n\nReferences:\n\nPE\u00a0uses some external web URLs for certain deployment and management tasks. You might want to ensure these URLs are reachable from your network prior to installation, and be aware that they might be called at various stages of configuration.\n * [forgeapi.puppet.com|http://forgeapi.puppet.com/]\n * [pm.puppetlabs.com|http://pm.puppetlabs.com/]\n\n * [rubygems.org|http://rubygems.org/]\n * [github.com|http://github.com/]\n * [s3.amazonaws.com|http://s3.amazonaws.com/]\nA user asks, why?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54479", "fixedVersions": [], "id": "54479", "issueType": "Improvement", "key": "DOCUMENT-1006", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2019-05-17T17:06:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Explain the URLs in System Configuration", "timeSpent": "PT0S", "updated": "2019-05-17T17:06:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5caf5082c75c532928c11f7b", "attachments": [], "comments": [ { "author": "557058:8f1e0495-1d4a-4123-bbad-727b7f49f370", "body": "Merged to master at\u00a0b1022c8217fe244ffdd9462180af3fd02050db79", "created": "2019-05-15T13:35:00.000000" }, { "author": "5caf5082c75c532928c11f7b", "body": "Merged by [jtappa|https://github.com/jtappa] on [May 15, 2019|https://github.com/puppetlabs/puppet/commit/b1022c8217fe244ffdd9462180af3fd02050db79].", "created": "2019-05-28T10:43:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you [~accountid:5caf5082c75c532928c11f7b]!", "created": "2019-05-28T11:34:00.000000" } ], "components": [ "Puppet Language" ], "created": "2019-05-15T10:03:00.000000", "creator": "5caf5082c75c532928c11f7b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@74433af6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzulfj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_1111782975_*|*_1_*:*_1_*:*_12655756_*|*_10009_*:*_1_*:*_1162959_*|*_5_*:*_1_*:*_0" } ], "description": "The [documentation|https://puppet.com/docs/puppet/latest/function.html#fail] for the [{{fail()}}|https://github.com/puppetlabs/puppet/blob/master/lib/puppet/parser/functions/fail.rb] function should mention what it does with its parameters.\n\nFixed by https://github.com/puppetlabs/puppet/pull/7524", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54682", "fixedVersions": [], "id": "54682", "issueType": "New Feature", "key": "DOCUMENT-1004", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5caf5082c75c532928c11f7b", "resolution": "Fixed", "resolutionDate": "2019-05-28T10:43:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve docstring for the fail() function.", "timeSpent": "PT0S", "updated": "2019-05-28T11:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [], "components": [], "created": "2019-05-13T09:24:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7028841" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzujpj:" }, { "fieldName": "Zendesk Ticket Count", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "1.0" }, { "fieldName": "Zendesk Ticket IDs", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "34765" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_371983452_*|*_3_*:*_1_*:*_317529_*|*_5_*:*_1_*:*_0" } ], "description": "This 2019.1 documentation needs updated:\n\nhttps://puppet.com/docs/pe/2019.1/upgrading_pe.html#upgrading-pe\n\nFor example:\n\n2019.0.z\tYou're up to date!\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54115", "fixedVersions": [], "id": "54115", "issueType": "Bug", "key": "DOCUMENT-1003", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2019-05-17T16:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "2019.1 upgrading_pe documentation needs updated", "timeSpent": "PT0S", "updated": "2019-12-05T04:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks [~accountid:5b574c837501ba2d6ea647b9]! I've made a comment on your PR.\u00a0", "created": "2019-05-03T07:05:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "We've updated the README to clarify this:\u00a0[https://github.com/puppetlabs/puppetlabs-vsphere#installing-the-vsphere-module]", "created": "2019-05-03T08:03:00.000000" } ], "components": [], "created": "2019-04-30T01:15:00.000000", "creator": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6d408302" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykjfr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_33669851_*|*_3_*:*_1_*:*_173840957_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_76085146_*|*_10005_*:*_1_*:*_103994" } ], "description": "The steps below are to be performed on the host that executes the VSphere module, but it isn't clear in the module Documentation -\u00a0https://forge.puppet.com/puppetlabs/vsphere\n\nThis may confuse some users thinking the steps are to be run in Master server.\nh4. On Debian 7 and 8, Ubuntu 14.04 LTS, and similar\n # Install the required dependencies:\n\u00a0\nOn Debian 7 and 8, Ubuntu 14.04 LTS and similar\n|1|apt-get install zlib1g-dev libxslt1-dev build-essential|\n\nOn RHEL 6 and 7, CentOS, and similar\n|1|yum install zlib-devel libxslt-devel patch gcc|\n\n # Install the required gems with this command:\n|1\n2|/opt/puppet/bin/gem install rbvmomi --no-ri --no-rdoc /opt/puppet/bin/gem install hocon --version='~>1.0.0' --no-ri --no-rdoc|\n\nIf you are running Puppet Enterprise 2015.2.0 you need to use the updated path:\n|1\n2|/opt/puppetlabs/puppet/bin/gem install rbvmomi --no-ri --no-rdoc /opt/puppetlabs/puppet/bin/gem install hocon --version='~>1.0.0' --no-ri --no-rdoc|", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54476", "fixedVersions": [], "id": "54476", "issueType": "Improvement", "key": "DOCUMENT-1001", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "resolution": "Fixed", "resolutionDate": "2019-05-03T08:03:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Pre-requisite steps on vSphere module aren't clear", "timeSpent": "PT0S", "updated": "2019-05-03T08:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:520566be-dc64-492b-8de1-701eed347203", "attachments": [ { "attacher": "5b29440b088822535508e534", "created": "2019-04-28T09:50:00.000000", "name": "Screen Shot 2019-04-28 at 8.47.36 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14200" } ], "comments": [ { "author": "557058:520566be-dc64-492b-8de1-701eed347203", "body": "Docs have been updated.\n\n2019.1: [https://puppet.com/docs/pe/2019.1/high_availability_overview.html#system-and-software-requirements]\n\n2019.0: [https://puppet.com/docs/pe/2019.0/high_availability_overview.html#system-and-software-requirements]\n\n2018.1: [https://puppet.com/docs/pe/2018.1/high_availability_overview.html#system-and-software-requirements]\n\n\u00a0", "created": "2019-06-03T08:10:00.000000" } ], "components": [], "created": "2019-04-28T09:53:00.000000", "creator": "5b29440b088822535508e534", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@24d56169" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzua5b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Jun/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_175428302_*|*_3_*:*_1_*:*_1467256886_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_1461529776_*|*_10005_*:*_1_*:*_13727" } ], "description": "Hi,\n\nOne of our customers was trying to create a Master-Replica node for creating a High Availability architecture. He was going to convert a node that used as a Compiler (or Compile-Master) and make it the Master-Replica node.\u00a0\n\nHowever, he saw a sentence in this doc and was puzzled. The snippet is highlighted in red, in the screenshot below.\n\nI spoke to Reid V and he suggested the following change to that snippet:\n\n\u00a0*You can decommission a node, uninstall all puppet packages & re-commission the node to be a replica. However, a compiler cannot perform 2 functions i.e as a compiler and a replica.*\n\n\u00a0\n\nLink:\n\n[https://puppet.com/docs/pe/2018.1/high_availability_overview.html#system-and-software-requirements]\n\n\u00a0\n\n!Screen Shot 2019-04-28 at 8.47.36 AM.png!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54663", "fixedVersions": [], "id": "54663", "issueType": "Improvement", "key": "DOCUMENT-1000", "labels": [ "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b29440b088822535508e534", "resolution": "Fixed", "resolutionDate": "2019-06-03T08:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Doc incorrectly suggests existing Compiler node cannot be repurposed as a Replica", "timeSpent": "PT0S", "updated": "2019-06-03T08:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [ { "attacher": "557058:35060490-aa27-40a2-b587-eca7672140c8", "created": "2019-04-17T23:59:00.000000", "name": "Screen Shot 2019-04-18 at 1.18.03 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14191" } ], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "PR:\u00a0[https://github.com/puppetlabs/puppetserver/pull/2063]", "created": "2019-05-03T09:25:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "The PR has been merged and the docs have been updated here:\u00a0[https://puppet.com/docs/puppetserver/6.3/intermediate_ca.html#set-up-puppet-as-an-intermediate-ca-with-an-external-root].\n\n[~accountid:557058:35060490-aa27-40a2-b587-eca7672140c8] Please reopen this ticket if this process is still not clear or you have other suggestions, and we can make more updates. Thanks!\u00a0", "created": "2019-05-07T14:52:00.000000" } ], "components": [], "created": "2019-04-18T00:16:00.000000", "creator": "557058:35060490-aa27-40a2-b587-eca7672140c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@32129f27" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzu3u7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/May/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_470145681_*|*_3_*:*_1_*:*_353045123_*|*_10009_*:*_1_*:*_365246829_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_505745264" } ], "description": "*Puppet Version: Puppet 6.x\n*Puppet Server Version: Puppet 6.x\n*OS Name/Version: EL 7\n\nDescribe your issue in as much detail as possible\u2026\nI'm working with multiple Puppet user sites who are having trouble setting up Puppet as an intermediate CA. There is confusion about what is intended by our current documentation here:\n\nhttps://puppet.com/docs/puppetserver/6.3/intermediate_ca.html#setting-up-an-intermediate-ca-with-an-external-root\n\nFor example, here are the current instructions, parsed with some references for future use:\n\nIf you want to set up an intermediate CA with an external root cert, you need to supply the following:\n\n1.\n a. a certificate bundle file consisting of your root cert\n b. plus \n c. a CA signing cert signed by that root\n2. \n a. a CRL file containing the root\u2019s CRL \n b. and \n c. the CRL for the new CA cert\n3. \n a. the private key for the \n b. intermediate signing cert\n\nHere are examples of some of the parts that are unclear:\n* It is unclear what aspects of the process can be completed prior to any new work, and which require new work. For example, before doing anything, one should be able to gather 1a. and 2a, but the other steps will require new work. \n* The example assumes a trivial PKI configuration, which leads one to question assumptions (Does the root CA really need to sign the CA signing cert (1c.) ?)\n* What order should things be arranged in the output PEM files (1a. 1b. 2a. and 2b.)\n* In a more complex enterprise PKI configuration, which CA can perform what task (1c. 2c. 3a.)\n* Technical jargon is used imprecisely. (Is 1c. and 3b. referring to the same intermediate CA signing cert or not? does 1b and 2b mean the same thing, or is there a distinction?)\n* Even after multiple readings, one of the users I was working with was convinced this was creating a chicken/egg problem, where the Puppet CA needed to sign its own private key (prior to the import happening, 3a)\n\nHere is what would make the documentation better:\n* Clearly identify what can be gathered prior to starting work on the Puppet CA, for instance gathering the chain of trust and CRL's, and properly combining them into precursors for 1a and 2a. [Chunking reduces the apparent complexity|https://en.wikipedia.org/wiki/Chunking_(psychology)].\n* Clearly identify what new PKI artifacts need to be created once a user has decided to follow these instructions, and how to know they are correct\n* Somehow break up the instructions into discrete, verifiable pieces such that one can be confident after one has passed a milestone in the process. (again, [Chunking|https://youtu.be/iueVZJVEmEs?t=653])\n* The example should reference a reasonable, \"best practices\" enterprise PKI architecture. Here are examples align with the implementation in use at the end users I am working with: (e.g. Root CA with Subordinate CAs)\n OpenSSL: http://blog.dornea.nu/2015/10/02/manage-pki-using-openssl/#39ad60ae1da5a0db4c2f65281b6314e9\n Windows 2012: https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh831348(v%3dws.11)\n Windows 2016: http://myitworld.azurewebsites.net/2016/01/18/installing-two-tier-pki-hierarchy-windows-server-2016-part1/\n* Provide a picture or two. I created what is surely a poor example and attached it (Corrections/clarification welcome, but hopefully in the form of updated documentation)\n* Provide example PEM files (perhaps with generic/redacted/truncated certificate information, but containing certificate headers and other relevant hints, such as which is the root cert, where do the intermediate certs go and in which order, which is the ca signing cert, etc. These will also provide clues to the users to sanity check what they're doing.\n* Finally, although the users I'm working with are pretty savvy and have a lot of access, consider rephrasing the instructions such that a Puppet practitioner could copy and paste them into their ticketing system, and the PKI SME (who does not know Puppet) who works that ticket, can reasonably provide what is requested in a single response.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54113", "fixedVersions": [], "id": "54113", "issueType": "Improvement", "key": "DOCUMENT-996", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:35060490-aa27-40a2-b587-eca7672140c8", "resolution": "Fixed", "resolutionDate": "2019-05-07T14:52:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Multiple users confused about Intermediate Puppet CA configuration", "timeSpent": "PT0S", "updated": "2019-05-07T14:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [], "components": [], "created": "2019-04-12T10:49:00.000000", "creator": "5b0340d43eafdb09dee5bc3a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@76ada201" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztzof:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_12620_*|*_3_*:*_1_*:*_268266490_*|*_5_*:*_1_*:*_0" } ], "description": "Adding this to the board so I don't forget.\n\nPR is here: [https://github.com/puppetlabs/puppet/pull/7480]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54888", "fixedVersions": [], "id": "54888", "issueType": "Task", "key": "DOCUMENT-994", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b0340d43eafdb09dee5bc3a", "resolution": "Fixed", "resolutionDate": "2019-04-15T13:20:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "(docs) exec resources are non-isomorphic (duplicate namevars allowed)", "timeSpent": "PT0S", "updated": "2019-04-15T13:20:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "puppet-server is documented here:\n\n[http://docs-internal.puppet.com/docs/pe/2019.0.z/configuring_puppet_orchestrator.html#configuring-pe-bolt-services]", "created": "2019-04-09T10:38:00.000000" } ], "components": [], "created": "2019-04-04T04:46:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "orche" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2e9298b0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztswn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_452985510_*|*_3_*:*_1_*:*_172375_*|*_5_*:*_1_*:*_0" } ], "description": "e.g. https://puppet.com/docs/pe/2019.0/running_jobs_with_puppet_orchestrator_overview.html#what-happens-during-a-task-run-from-the-orchestrator is not mentioning what's happening with tasks that run on targets that use SSH/WinRM", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54234", "fixedVersions": [], "id": "54234", "issueType": "Bug", "key": "DOCUMENT-993", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Fixed", "resolutionDate": "2019-04-09T10:38:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "orchestrator docs missing info about bolt-server", "timeSpent": "PT0S", "updated": "2019-04-09T10:38:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Fix is pushed and should be live on the next docs build tonight. Thanks for catching this and for making me laugh over it. :D", "created": "2019-04-01T18:56:00.000000" } ], "components": [], "created": "2019-04-01T07:00:00.000000", "creator": "602454391645270071f5ec8e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3c151c56" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztol3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "02/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_42964505_*|*_10009_*:*_1_*:*_55368207_*|*_5_*:*_1_*:*_0" } ], "description": "[https://puppet.com/docs/puppet/5.5/release_notes.html#puppet-5510]\n\n[https://puppet.com/docs/puppet/5.5/release_notes.html#puppet-5510-1]\n\ninstead of 5511 and 5510.\n\nAn off by one error creating a Schrodinger's release :P", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54763", "fixedVersions": [], "id": "54763", "issueType": "Bug", "key": "DOCUMENT-992", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "602454391645270071f5ec8e", "resolution": "Fixed", "resolutionDate": "2019-04-02T10:19:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet 5.5.10 is duplicated in the Release notes", "timeSpent": "PT0S", "updated": "2019-04-02T10:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [], "components": [ "Puppet Server" ], "created": "2019-03-26T12:49:00.000000", "creator": "70121:4e4745ce-68f2-4db3-bf71-242b4db49f84", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@79973954" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztl1b:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_2275138_*|*_6_*:*_1_*:*_0" } ], "description": "I am working with Windows and I am trying to utilize the registry module to enforce a registry setting and I have created the file and it doesn't get an error but it also does not update or notice when you delete the registry entry and it runs again.\n\nHere is the code from the page that I understand you have to configure.\n\n\u00a0\n\nThe client server is Windows 2012 R2 64 bit.\n\n\u00a0\n\nclass puppetconf::use_strong_crypto_aspnet {\nregistry_value { 'SchUseStrongCrypto':\n path => '32:HKLM\\SOFTWARE\\Microsoft\\.NETFramework\\v4.0.30319',\n ensure => present,\n type => dword,\n data => '1',\n}\n}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55026", "fixedVersions": [], "id": "55026", "issueType": "Bug", "key": "DOCUMENT-991", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:4e4745ce-68f2-4db3-bf71-242b4db49f84", "resolution": "Fixed", "resolutionDate": "2019-03-26T13:27:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Working with Windows Registry Module - Not Updating Missing Entry", "timeSpent": "PT0S", "updated": "2019-03-26T13:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Fix pushed, waiting for docs to rebuild and publish\n\n\u00a0", "created": "2019-03-26T12:13:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953], please thank whoever saw this for me.", "created": "2019-03-26T14:17:00.000000" } ], "components": [], "created": "2019-03-26T12:05:00.000000", "creator": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@33909a4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztkyv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_198111_*|*_3_*:*_1_*:*_280884_*|*_10009_*:*_1_*:*_7469751_*|*_5_*:*_1_*:*_0" } ], "description": "In this section:\nhttps://puppet.com/docs/puppet/5.5/release_notes_agent.html#puppet-agent-558-and-later\n\nThe link to Puppet release notes points to:\nhttps://puppet.com/release_notes.html\n\nI think it should point instead to:\nhttps://puppet.com/docs/puppet/5.5/release_notes.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54681", "fixedVersions": [], "id": "54681", "issueType": "Bug", "key": "DOCUMENT-990", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "resolution": "Fixed", "resolutionDate": "2019-03-26T14:17:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Broken link in Puppet 5.5 agent release notes", "timeSpent": "PT0S", "updated": "2019-03-26T14:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:520566be-dc64-492b-8de1-701eed347203", "attachments": [], "comments": [ { "author": "557058:520566be-dc64-492b-8de1-701eed347203", "body": "[~accountid:557058:8b915655-a6c3-4c09-9070-53484ff60ff3]\u00a0Docs for all Puppet 6.x releases have been updated.\n\n[https://puppet.com/docs/puppet/6.0/style_guide.html#quoting]\n\n\u00a0", "created": "2019-04-05T07:49:00.000000" } ], "components": [], "created": "2019-03-23T12:07:00.000000", "creator": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4b679114" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hztjcn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_169194647_*|*_3_*:*_1_*:*_174281742_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_764252194_*|*_10005_*:*_1_*:*_10174" } ], "description": "For all Puppet 6.x releases, the style guide says, in \"*Quoting*\" > \"*Option 2: Prefer double quotes*\":\n{quote}\u00a0A string SHOULD be enclosed in single quotes if it does not contain variable interpolations AND it:\n\nContains double quotes.\n Good:\n\nwarning({color:#FF0000}'{color}Class[\"apache\"] parameter purge_vdir is deprecated in favor of purge_configs{color:#FF0000}\"{color})\n\nBad:\n\nwarning({color:#FF0000}\"{color}Class[\\\"apache\\\"] parameter purge_vdir is deprecated in favor of purge_configs{color:#FF0000}'{color})\n{quote}\nNote how the examples mix single and double quotes. The code should be:\n{quote}A string SHOULD be enclosed in single quotes if it does not contain variable interpolations AND it:\n\nContains double quotes.\n Good:\n\nwarning('Class[\"apache\"] parameter purge_vdir is deprecated in favor of purge_configs{color:#0000FF}'{color})\n\nBad:\n\nwarning(\"Class[\\\"apache\\\"] parameter purge_vdir is deprecated in favor of purge_configs{color:#0000FF}\"{color})\n{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54680", "fixedVersions": [], "id": "54680", "issueType": "Improvement", "key": "DOCUMENT-989", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b915655-a6c3-4c09-9070-53484ff60ff3", "resolution": "Fixed", "resolutionDate": "2019-04-05T07:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Inconsistent quotes in the quoting section of the style guide", "timeSpent": "PT0S", "updated": "2019-04-05T07:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:623a46a67910a200718ac239] As the note on the revised Puppet 6.0+ architecture page says:\n\n{quote}\nPrevious versions of Puppet offered a standalone architecture, in which agents compiled their own catalogs using the Puppet apply application. We no longer recommend this configuration, because it's challenging to maintain and secure. \n{quote}\n\nThe bulk of the content removed from this page related to the standalone architecture and comparisons between the two architectures. (Additionally, we removed a small section about catalogs, which we felt didn't fit in an architecture overview. There is an entire separate page about catalogs [here|https://puppet.com/docs/puppet/6.3/subsystem_catalog_compilation.html].)\n\nAlthough we no longer recommend the standalone architecture, you can always switch to older versions of the docs to review those details if needed. ", "created": "2019-03-25T11:24:00.000000" }, { "author": "623a46a67910a200718ac239", "body": "Although I do think it was a mistake to pull the docs describing masterless operation while that's still supported, not withstanding what Puppet, Inc. _recommends_, that's hardly the primary issue here.\n\nThe page in question is the very first one in the documentation index, and its title\u00a0seems suited to that placement. It's the first place I would expect someone to go if they hit the docs site trying to determine \"What's this all about, then?\" The P5 page served in that role reasonably well, but the new page does not. It drops straight into jargon \u2013 \"catalog\", \"fact\", \"master\", \"agent\" \u2013 with no context or explanation, and although the core architectural concepts are wrapped up in the description of the master/agent _communication pattern_, they are easily missed because that's not what that text seems to be about. A communication pattern is not an architecture, and\u00a0all the parts of the P5 page that made that gaffe excusable have been stripped out of the P6 version. A page devoted solely to the details the current page covers does not belong in the position of this page or under the title it currently bears.\n\nMoreover, as I observed already, the previous version of the page contained multiple useful hyperlinks to deeper in the documentation, and they have all been removed. Most of them were not particularly related to masterless mode, so that doesn't explain it. The docs were not a paragon of navigability to begin with, and pulling out relevant links made them worse.\n\nOf course, you have no obligation to take my criticisms on board, but I fancy myself a decent technical writer, and I have considerable experience working with Puppet and writing about it. You can consider this a narrowly-scoped external review.", "created": "2019-03-25T14:40:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:623a46a67910a200718ac239] Fair points. FYI, we are planning on fleshing out the overview section of the Puppet docs. The two existing pages in the current overview section were moved there from elsewhere as of 6.0, and they represent just the initial iteration of this section. We'll add more high-level content as we have resourcing to develop it. We're a small team doing our best to write and maintain a LOT of docs. Thanks for your review and feedback.\n\ncc [~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] General feedback above about potential content for the new OSP overview section. ", "created": "2019-03-25T15:06:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:623a46a67910a200718ac239], thanks for your observations. We'll definitely look at this further. I did want to share that a rewrite of this section is already well underway, so you can look forward to that soon.", "created": "2019-03-25T15:37:00.000000" } ], "components": [], "created": "2019-03-21T07:53:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@37546723" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzthvz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_357251141_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1019006" } ], "description": "The Puppet 5 docs contain a nice overview of Puppet's overall architecture and mode of operation: [https://puppet.com/docs/puppet/5.5/architecture.html|https://puppet.com/docs/puppet/5.5/architecture.html.]. It serves as a reasonable starting point for someone brand new to Puppet, and a good entry point to the docs overall.\n\nOn the other hand, the corresponding page of the Puppet 6 docs, [https://puppet.com/docs/puppet/6.3/architecture.html], is much abbreviated relative to the other, and despite having a similar title and placement, it addresses only a much narrower topic.\u00a0 Even for that one topic, it omits links to related doc pages that are present in the P5 version.\u00a0 The P6 page does not in any way serve the same introductory purpose as the previous version, and I have so far been unable to find any other page in the P6 docs that does.\n\nThe revised page is moreover _wrong_, in that it claims unconditionally that \"Puppet is configured in an agent-master architecture.\"\u00a0 Of course, that is only one of two ways in which Puppet can be configured and used, both of which are widely deployed in real-world Puppet installations.\n\nThis change to the docs seems to have gone in between P5.5 and P6.0.\u00a0 It looks like an epic edit fail to me, especially considering the amount and nature of the text preceding the first heading in the content frame, but even if narrowing the scope and content was intentional, surely it's still appropriate for the page to link to other doc pages discussing details.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54762", "fixedVersions": [], "id": "54762", "issueType": "Bug", "key": "DOCUMENT-988", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Won't Fix", "resolutionDate": "2019-03-25T11:24:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The architecture overview was mangled between Puppet 5 and Puppet 6 docs", "timeSpent": "PT0S", "updated": "2019-03-25T15:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Hi Nathalie - I have added the Hiera 1 content to the archive now. You can see it at the link above. It was by design that we did not archive it", "created": "2019-03-22T14:17:00.000000" } ], "components": [], "created": "2019-03-20T10:55:00.000000", "creator": "70121:69ba0e26-3bf5-4c7e-b37e-2e566c07ea0a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69a3d5b0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzthiv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_184941460_*|*_5_*:*_1_*:*_0" } ], "description": "[https://github.com/puppetlabs/docs-archive/tree/master/hiera] only contains documentation for hiera version 2.0, 3.0 and 3.1\n\nThe old documentation used to include hiera version 1.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54662", "fixedVersions": [], "id": "54662", "issueType": "Bug", "key": "DOCUMENT-986", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:69ba0e26-3bf5-4c7e-b37e-2e566c07ea0a", "resolution": "Fixed", "resolutionDate": "2019-03-22T14:17:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "docs-archive is missing hiera 1 documentation", "timeSpent": "PT0S", "updated": "2019-03-22T14:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Thanks for raising this question. We're looking into this issue.\u00a0", "created": "2019-03-13T17:20:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Such a fantastic catch! Thank you for reporting it, Nod\u00f8n. I'm kicking off a build that should publish the fix to 6.0, 6.1, 6.2, and 6.3 sometime tonight (Pacific time). I will confirm tomorrow.", "created": "2019-03-14T16:49:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "(y)", "created": "2019-03-15T02:35:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Yes, caught up all the way to Puppet 6.3. [https://puppet.com/docs/puppet/6.3/lang_data_time.html]\u00a0", "created": "2019-03-15T08:27:00.000000" } ], "components": [ "Puppet Language" ], "created": "2019-03-06T08:14:00.000000", "creator": "623c0c0d761efb0069ce025b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8fcf92f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzt5d3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_635754545_*|*_3_*:*_1_*:*_67140579_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_71882893" } ], "description": "In the Puppet 5.5 docs there is documentation for the \"time data types\": [https://puppet.com/docs/puppet/5.5/lang_data_time.html]\n\nThis page is missing in the Puppet 6.x Documentations.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54230", "fixedVersions": [], "id": "54230", "issueType": "Bug", "key": "DOCUMENT-984", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0c0d761efb0069ce025b", "resolution": "Fixed", "resolutionDate": "2019-03-15T08:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Timestamp & Timespan Data Type Documentation missing", "timeSpent": "PT0S", "updated": "2019-03-15T08:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "clarify what the \"second example\" refers to.", "created": "2019-03-18T11:15:00.000000" } ], "components": [], "created": "2019-03-04T14:20:00.000000", "creator": "557058:3b7ec66e-afa6-415b-bc38-41ac050b8845", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@54aa42ce" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzt3rz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1194859131_*|*_3_*:*_1_*:*_2122832_*|*_10009_*:*_1_*:*_13096_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_557642_*|*_10006_*:*_1_*:*_1836144711_*|*_10005_*:*_1_*:*_39267" } ], "description": "[https://puppet.com/docs/puppet/5.4/function.html#split]\n\nDocumentation on the puppet website for the split function seems to be missing example code that goes with its explanation.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54474", "fixedVersions": [], "id": "54474", "issueType": "Bug", "key": "DOCUMENT-983", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3b7ec66e-afa6-415b-bc38-41ac050b8845", "resolution": "Fixed", "resolutionDate": "2019-04-08T18:03:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "5.4 split function documentation missing example code", "timeSpent": "PT0S", "updated": "2019-04-08T18:03:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "623c0c0d761efb0069ce025b", "body": "I discussed about it in slack: https://puppetcommunity.slack.com/archives/C0W298S9G/p1550833772351400", "created": "2019-02-22T04:54:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd], it looks to me like confdir is an outdated location, and global hiera should be in codedir as of Puppet 4. Can you confirm?", "created": "2019-02-25T18:08:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "I steped over an other page which addresses this Question: [https://puppet.com/docs/puppet/4.10/configuration.html#hieraconfig]\n\n\u00a0", "created": "2019-05-03T03:47:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "I looked at code - and this is what is in defaults.rb on master:\n{code:ruby}\n :hiera_config => {\n :default => lambda do\n config = nil\n codedir = Puppet.settings[:codedir]\n if codedir.is_a?(String)\n config = File.expand_path(File.join(codedir, 'hiera.yaml'))\n config = nil unless Puppet::FileSystem.exist?(config)\n end\n config = File.expand_path(File.join(Puppet.settings[:confdir], 'hiera.yaml')) if config.nil?\n config\n end,\n :desc => \"The hiera configuration file. Puppet only reads this file on startup, so you must restart the puppet master every time you edit it.\",\n :type => :file,\n },\n{code}\n\nI read that as that it is $codedir/hiera.yaml, and only if that does not exist $confdir/hiera.yaml (I think that $confdir/hiera.yaml is the backwards compatibility thing).\n", "created": "2019-05-07T11:52:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "* OK, the info on [https://puppet.com/docs/puppet/4.10/whered_it_go.html#new-codedir-holds-all-modulesmanifestsdata] seems to be correct, so I'm leaving it be.\n * [https://puppet.com/docs/puppet/4.10/hiera_config_yaml_5.html#location-of-hierayaml] is incorrect, and I've pushed a fix for that\n * [dirs_confdir.html|https://puppet.com/docs/puppet/4.10/dirs_confdir.html] contains some old information that is now corrected\n * I've updated information on dirs_codedir.html\n * PR'd a fix to a string in configuration.rb to clarify the default location.\n\nBecause Puppet 4 is already EOL'd, I've changed only\u00a0[hiera_config_yaml_5.html#location-of-hierayaml|https://puppet.com/docs/puppet/4.10/hiera_config_yaml_5.html#location-of-hierayaml] in 4.10 docs, and all other changes in 5.5 forward. I will resolve this ticket when all docs changes are built. The PR to configuration.rb clarifies the situation, but the explanation there isn't wrong, so this ticket can be resolved before that change is published.\n\nThank you for this ticket and the update, [~accountid:623c0c0d761efb0069ce025b]!", "created": "2019-05-07T14:42:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "Thx for clarification! Are the PR already passed or if not, can you just notify me, when they are productiv? So I know, if I find incomplete information about this topic, it's to be fixed to. Just so I know, would be nice. :)", "created": "2019-05-08T01:14:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "I'm not shure about your workfllows but, i think this is the right status now.", "created": "2019-05-08T01:15:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "I steped over: https://puppet.atlassian.net/browse/HI-490\n\nand then found:\n\nhttps://puppet.atlassian.net/browse/PUP-6178\n [https://github.com/puppetlabs/puppet-specifications/commit/5e87a5d4da571ec219f0b273de5efb0c91e2d091]\n [https://github.com/puppetlabs/puppet/commit/37b5d89c9741060e4d8ed4e18af58dfa2184ddaa]\n [https://docs.google.com/document/d/1d7PTHoMxmWL-4HXbXCR3DlZdsJk1ItgtOeRvzcslIEI/edit#|https://docs.google.com/document/d/1d7PTHoMxmWL-4HXbXCR3DlZdsJk1ItgtOeRvzcslIEI/edit]\n\n\u00a0\n\nI'm just asking [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] are you shure? Yes it's some old stuff, but the code you reference isn't the complete story it seems. $codedir seems to be used if it exists so, people who use it don't notice any problem because the package manager did deploy a new hiera.yaml into $confdir. I did find all this stuff because of:\n [https://github.com/puppetlabs/puppet-docs/blob/a5f90bed8e4cbd49ec76199fd7817f15876dab44/source/puppet/4.5/release_notes.markdown#path-change-of-hierayaml]\n\nThen continued to look in the other release notes and found:\n [https://puppet.com/docs/puppet/5.0/release_notes.html#hiera-5-default-file]\n[https://github.com/puppetlabs/puppet-docs/blob/a5f90bed8e4cbd49ec76199fd7817f15876dab44/source/puppet/4.5/release_notes_agent.md#path-change]\n[https://puppet.com/docs/puppet/5.0/release_notes.html#hiera-5-default-file]\n\nI don't want to annoy you, I (now) think docs would be corrected in the wrong way.", "created": "2019-05-08T07:13:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Eh... what a mess. The change in PUP-6178 makes the *old* location win if it exists - I suppose to not create a surprise if there was a file in new location that was not to be taken as the hiera configuration. Thus, if you have the old one, you need to delete it to get the new default location.\n\n", "created": "2019-05-08T11:32:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "You are definitely not annoying me, [~accountid:623c0c0d761efb0069ce025b]. I appreciate the information and your input. :) This one was a little confusing, once we started poking around! I'll work on adjusting those docs changes this afternoon.", "created": "2019-05-08T12:34:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "OK, in looking at these other tickets you found, it seems that hiera.yaml lived in confdir, was moved to codedir, and was later moved back to confdir, which explains why this issue is proving difficult to figure out. I want to spend some time looking at this before I go wild reverting changes, and then I can plan the appropriate fixes.", "created": "2019-05-08T14:54:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "* [https://puppet.com/docs/puppet/4.10/hiera_config_yaml_5.html#location-of-hierayaml] is correct and I've reverted these changes\n * closed the PR to configuration.rb\n * \u00a0[https://puppet.com/docs/puppet/4.10/whered_it_go.html#new-codedir-holds-all-modulesmanifestsdata] no longer lists hiera.yaml for 4.4 and later.\n * added a note about hiera location to 4.10/hiera_config_yaml.html about the codedir being honored over the confdir for backward compatibility\n * [dirs_confdir.html|https://puppet.com/docs/puppet/4.10/dirs_confdir.html] in 6.0+ are reverted\n * Revert information on dirs_codedir.html in 6.0+", "created": "2019-05-08T17:38:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "OK. Yea in old days it was /etc/hiera.yaml IIRC. How ever glad to get it clarified.", "created": "2019-05-09T01:46:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "OK, I think I've got things in order! So I reverted some changes and added others, listed above, to (I hope!) make things more clear. I'm building docs right now, so I would expect changes to be live within the hour. If you still see errors after that, it means they need to be fixed, so please let me know about them.\n\nAnd thank you again for your research and attention to this, [~accountid:623c0c0d761efb0069ce025b]. This issue was a bit confusing, and the move back to confdir was so long ago that I'd completely forgotten it until seeing some of those old tickets.\n\nPlacing this in ready to review until I verify the changes are live.", "created": "2019-05-09T15:46:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "I just read the comment about hiera.yaml at [https://puppet.com/docs/puppet/4.10/dirs_confdir.html#config-files] and noticed codedir is written in `[codedir]` but confdir is written \"normaly\" `confdir` and codedir is doubled: `[codedir][codedir]`. (just read the comment on the webpage I think you will see what I meen.)\n\n(Or is it wanted like this?)", "created": "2019-05-10T03:06:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "The comment at\u00a0[https://puppet.com/docs/puppet/4.10/dirs_confdir.html#config-files] is only in the version 4.10. Puppet still has this code section, that codedir/hiera.yaml wins over confdir/hiera.yaml (I just checked the recent code in the master branch). Shouldn't this comment be for all versions (at least until the code is maybe changed to only confdir)? If you like I'll make a PR.", "created": "2019-05-10T03:12:00.000000" }, { "author": "623c0c0d761efb0069ce025b", "body": "https://github.com/puppetlabs/puppet-docs/pull/933", "created": "2019-05-10T04:21:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:623c0c0d761efb0069ce025b], there was one issue with the PR, but I'm good to merge that as soon as it's fixed. Thank you so much for doing this! I've made a corresponding PR this morning to the codebase to make sure the note is present in future versions.", "created": "2019-05-10T10:34:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "All changes have been made.\n\n\u00a0", "created": "2019-05-14T15:32:00.000000" } ], "components": [ "Hiera" ], "created": "2019-02-22T04:53:00.000000", "creator": "623c0c0d761efb0069ce025b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5c6faabf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsxpj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_281697737_*|*_10007_*:*_1_*:*_339464320_*|*_3_*:*_3_*:*_131387472_*|*_10009_*:*_2_*:*_46124861_*|*_4_*:*_1_*:*_20917941_*|*_5_*:*_3_*:*_79283201_*|*_10004_*:*_1_*:*_6108916085_*|*_10005_*:*_2_*:*_25338939" } ], "description": "[https://puppet.com/docs/puppet/4.10/whered_it_go.html#new-codedir-holds-all-modulesmanifestsdata] lists the *{{hiera.yaml}}* in the *$codedir*.\n\n[https://puppet.com/docs/puppet/4.10/hiera_config_yaml_5.html#location-of-hierayaml] lists the *hiera.yaml* in the $confdir.\n\nThis to pages disagree on where the global hiera.yaml should be. I tested both and both worked. Is one of the 2 locations backword compatibility?\n\nDocumentations should be clarified and unified so they don't disagree anymore.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54679", "fixedVersions": [], "id": "54679", "issueType": "Bug", "key": "DOCUMENT-982", "labels": [ "hiera", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0c0d761efb0069ce025b", "resolution": "Fixed", "resolutionDate": "2019-05-14T15:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "pages disagree on where the global hiera.yaml should be", "timeSpent": "PT0S", "updated": "2019-05-14T15:32:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] https://github.com/puppetlabs/control-repo has been updated now.", "created": "2019-02-26T17:04:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I've updated the references I could find in the code management section", "created": "2019-04-04T12:37:00.000000" } ], "components": [], "created": "2019-02-20T12:37:00.000000", "creator": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@61430c0a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzswf3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_426736969_*|*_3_*:*_1_*:*_3284336859_*|*_10009_*:*_1_*:*_7426382_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_8727" } ], "description": "The managing environments with code-manager page references putting modules committed directly to the control repo in the {{site}} directory. This has proven so CS and bolt have decided to rename that directory to {{site-modules}} to make it clearer. BOLT-1108 and https://github.com/puppetlabs/control-repo/pull/71/files track this. There are a few open questions on the CS pr but once it gets merged in we should update the docs to match.\n\n\ninstances:\n\n\"An environment.conf file to implement a site directory for roles, profiles, and custom modules.\"\n\"An environment.conf file to implement a {{site-modules/}} directory for roles, profiles, and custom modules.\"\n\n\"modulepath=site:modules:$basemodulepath\"\n\"modulepath=site-modules:modules:$basemodulepath\"\n\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54394", "fixedVersions": [], "id": "54394", "issueType": "Task", "key": "DOCUMENT-981", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d2f4e3cd-249f-4cc2-8a57-23433aeefb52", "resolution": "Fixed", "resolutionDate": "2019-04-04T14:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Control repo docs to refer to site-modules", "timeSpent": "PT0S", "updated": "2019-04-04T14:32:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Talking with [~accountid:557058:104b5720-714d-4539-b455-df472251ec89] in Slack, seems like this procedure is better as it uses all {{puppet}} commands instead of doing things manually (I've copied this procedure to the ticket's description):\n\n{code}\n[root@master ~]# puppetserver ca clean --certname master.vagrant\nRevoked certificate for master.vagrant\nCleaned files related to master.vagrant\n\n[root@master ~]# puppet ssl clean\nNotice: Removed private key /etc/puppetlabs/puppet/ssl/private_keys/master.vagrant.pem\nNotice: Removed public key /etc/puppetlabs/puppet/ssl/public_keys/master.vagrant.pem\nNotice: Removed certificate request /etc/puppetlabs/puppet/ssl/certificate_requests/master.vagrant.pem\nNotice: Removed certificate /etc/puppetlabs/puppet/ssl/certs/master.vagrant.pem\n[root@master ~]# puppet resource service puppetserver ensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n}\n\n[root@master ~]# puppetserver ca generate --certname master.vagrant --subject-alt-names dog,cat --ca-client\nSuccessfully saved certificate for master.vagrant to /etc/puppetlabs/puppet/ssl/certs/master.vagrant.pem\nSuccessfully saved certificate for master.vagrant to /etc/puppetlabs/puppet/ssl/ca/signed/master.vagrant.pem\nSuccessfully saved private key for master.vagrant to /etc/puppetlabs/puppet/ssl/private_keys/master.vagrant.pem\nSuccessfully saved public key for master.vagrant to /etc/puppetlabs/puppet/ssl/public_keys/master.vagrant.pem\n\n[root@master ~]# puppet resource service puppetserver ensure=running\nNotice: /Service[puppetserver]/ensure: ensure changed 'stopped' to 'running'\nservice { 'puppetserver':\n ensure => 'running',\n}\n{code}\n\nA copy-pastable block for the above is:\n{code}\npuppetserver ca clean --certname master.vagrant\npuppet ssl clean\npuppet resource service puppetserver ensure=stopped\npuppetserver ca generate --certname master.vagrant --subject-alt-names nate,pizza --ca-client\npuppet resource service puppetserver ensure=running\n{code}", "created": "2019-02-08T15:28:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "/cc [~accountid:557058:c241032a-c552-4408-9a96-dcd5a643ff69] and [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] for triage.", "created": "2019-02-08T16:08:00.000000" }, { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Might be beneficial to put this same info into the Puppetserver 5 docs as I see requests for this quite a bit on Slack.\n\nHere's the process I found that works (run this *on* the master):\n\n{code}\npuppet resource service puppetserver ensure=stopped\npuppet cert clean master.vagrant\npuppet cert generate --dns_alt_names cookies,cream master.vagrant\npuppet resource service puppetserver ensure=running\n{code}\n\nAnd here's the full output for reference:\n{code}\n[root@master ~]# puppet resource service puppetserver ensure=stopped\nNotice: /Service[puppetserver]/ensure: ensure changed 'running' to 'stopped'\nservice { 'puppetserver':\n ensure => 'stopped',\n}\n\n[root@master ~]# puppet cert clean $(hostname -f)\nWarning: `puppet cert` is deprecated and will be removed in a future release.\n (location: /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:370:in `run')\nNotice: Revoked certificate with serial 7\nNotice: Removing file Puppet::SSL::Certificate master.vagrant at '/etc/puppetlabs/puppet/ssl/ca/signed/master.vagrant.pem'\nNotice: Removing file Puppet::SSL::Certificate master.vagrant at '/etc/puppetlabs/puppet/ssl/certs/master.vagrant.pem'\nNotice: Removing file Puppet::SSL::Key master.vagrant at '/etc/puppetlabs/puppet/ssl/private_keys/master.vagrant.pem'\n\n[root@master ~]# puppet cert generate --dns_alt_names cookies,cream $(hostname -f)\nWarning: `puppet cert` is deprecated and will be removed in a future release.\n (location: /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:370:in `run')\nNotice: master.vagrant has a waiting certificate request\nNotice: Signed certificate request for master.vagrant\nNotice: Removing file Puppet::SSL::CertificateRequest master.vagrant at '/etc/puppetlabs/puppet/ssl/ca/requests/master.vagrant.pem'\nNotice: Removing file Puppet::SSL::CertificateRequest master.vagrant at '/etc/puppetlabs/puppet/ssl/certificate_requests/master.vagrant.pem'\n\n[root@master ~]# puppet resource service puppetserver ensure=running\nNotice: /Service[puppetserver]/ensure: ensure changed 'stopped' to 'running'\nservice { 'puppetserver':\n ensure => 'running',\n}\n\n[root@master ~]# puppet agent -t\nInfo: Using configured environment 'production'\nInfo: Retrieving pluginfacts\nInfo: Retrieving plugin\nInfo: Retrieving locales\nInfo: Caching catalog for master.vagrant\nInfo: Applying configuration version '1550265711'\nNotice: Applied catalog in 0.01 seconds\n\n[root@master ~]# puppet cert list -a\nWarning: `puppet cert` is deprecated and will be removed in a future release.\n (location: /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/application.rb:370:in `run')\n+ \"master.vagrant\" (SHA256) B6:2D:C5:CF:10:F7:19:F1:33:C3:85:90:4F:7D:AB:A9:83:8C:8B:5C:C8:AA:36:D9:49:90:8B:4F:CE:C0:7C:E3 (alt names: \"DNS:cookies\", \"DNS:cream\", \"DNS:master.vagrant\")\n{code}", "created": "2019-02-15T14:27:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:bb372eb8-0089-49ba-8b22-213d5bf560f6] [~accountid:557058:104b5720-714d-4539-b455-df472251ec89]\n\nI've added the commands you suggest to the doc below, if you could please review / edit?\n\n[https://docs.google.com/document/d/1FKw-rrj3df3CjagLUAknmveK6pNZ-v3U_IMxod7vtdc/edit?usp=sharing]\n\nDo you think this should go before or after the exiting steps on that page? In what circumstances would you\u00a0regenerate only\u00a0**\u00a0the\u00a0**\u00a0master's agent certificate, as opposed to all of the certificates like the existing explain?\u00a0\n\n\u00a0", "created": "2019-04-08T07:39:00.000000" }, { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Thanks [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] I've added some comments and suggestions to the Google doc.", "created": "2019-04-09T12:08:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:bb372eb8-0089-49ba-8b22-213d5bf560f6] [~accountid:557058:104b5720-714d-4539-b455-df472251ec89] Let me know if you're both happy with the google doc and I'll update the docs. Thanks!", "created": "2019-04-17T03:41:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I've updated the docs:\u00a0[https://puppet.com/docs/puppet/6.4/ssl_regenerate_certificates.html]\n\n[~accountid:557058:bb372eb8-0089-49ba-8b22-213d5bf560f6] [~accountid:557058:104b5720-714d-4539-b455-df472251ec89]\u00a0please reopen if you spot anything else. Thanks!\u00a0", "created": "2019-04-23T09:25:00.000000" } ], "components": [], "created": "2019-02-08T14:18:00.000000", "creator": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5babc4fd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzspbr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_247986456_*|*_3_*:*_2_*:*_8931144_*|*_10009_*:*_1_*:*_1298691898_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4816834103" } ], "description": "h2. Background\n\nThere are docs cover regenerating all of the certificates on a Puppet master: https://puppet.com/docs/puppet/6.2/ssl_regenerate_certificates.html#task-3367\n\nh2. The Problem\n\nThose docs are lacking for two reasons:\n* That's a destructive process and requires regenerating all agent keys because there's a new CA cert.\n* It doesn't go into detail about adding a DNS alt name to the master. Which is a common admin task.\n\nh2. The Solution\n\nI propose a new section is added that covers how to regenerate *just* the master's agent certificate and includes info on adding/modifying the DNS alt names in that certificate.\n\nI've figured out that these are the steps needed for puppetserver 6+. Note, these steps are specific to puppetserver (open-source), NOT Puppet Enterprise. The PE docs [already have that covered|https://puppet.com/docs/pe/2018.1/regenerating_certificates_monolithic_installs.html#regenerate-the-puppet-master-certificates].\n\n{code}\npuppetserver ca clean --certname master.vagrant\npuppet ssl clean\npuppet resource service puppetserver ensure=stopped\npuppetserver ca generate --certname master.vagrant --subject-alt-names nate,pizza --ca-client\npuppet resource service puppetserver ensure=running\n{code}\n\nReplace:\n* *{{master.vagrant}}* with the real certname of your master.\n* *{{\"nate,pizza\"}}* with your own comma-separated list of DNS alt names.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54222", "fixedVersions": [], "id": "54222", "issueType": "Improvement", "key": "DOCUMENT-979", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "resolution": "Fixed", "resolutionDate": "2019-04-23T09:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add docs for regenerating a Puppet master's agent certificate with DNS alt names", "timeSpent": "PT0S", "updated": "2019-04-23T09:25:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Waiting on UXD-918.", "created": "2019-02-15T13:22:00.000000" }, { "author": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] This seems to not have been fixed, looking at\u00a0[https://puppet.com/docs/pe/2019.2/system_configuration.html]\u00a0I can still see that 5432 is labelled as \"Orchestration/PCP\"", "created": "2020-01-28T06:47:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Weird, it looks like just this one diagram didn't get updated on the 2019.1+ branch:\nhttps://puppet.com/docs/pe/2019.2/system_configuration.html#firewall_configuration_for_monolithic_installs_with_compilers\n\nIt is correct in the 2019.0 version. So I'll just need to grab the mono_compile_port_diagram.png from 2019.0 and copy it to other live branches.", "created": "2020-01-28T12:22:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Okay! That diagram is updated in 2019.1+ now. Should appear in the next build. ", "created": "2020-01-30T14:13:00.000000" } ], "components": [], "created": "2019-02-05T06:22:00.000000", "creator": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@6405649f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzslfj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_535735777_*|*_3_*:*_2_*:*_259689304_*|*_4_*:*_3_*:*_20737193_*|*_5_*:*_4_*:*_26594456225_*|*_10010_*:*_1_*:*_228296_*|*_10004_*:*_1_*:*_4495876226_*|*_10005_*:*_1_*:*_353459330" } ], "description": "This ticket refers to this page:\u00a0[https://puppet.com/docs/pe/2019.0/system_configuration.html#|https://puppet.com/docs/pe/2019.0/system_configuration.html]\n\n\u00a0\n\nThe red \"5432\" things are labelled as \"orchestration\" where they should be \"postgres\" or \"postgresql\" or \"PostgreSQL\" or whatever you would prefer.\n\n\u00a0\n\nAlso, the transparent backgrounds on the diagrams means that when you click on them to expand you can't read them.\n\n\u00a0\n\nAlso also, while 5432 appears in every diagram it does not appear in the list of ports below the diagrams with the exception of the final one. The final description of \"standalone PE-PostgreSQL node uses this port to accept inbound traffic/requests from the master\" will not be appropriate for all the other tables though as it serves a different purpose. Something like \"PostgreSQL replication data\" would be more appropriate. Also I'm not 100% certain if the connection direction is correct, would be worth checking this.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54393", "fixedVersions": [], "id": "54393", "issueType": "Bug", "key": "DOCUMENT-978", "labels": [ "graphics", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:afa80a20-2814-4f2f-bbdd-ad5db4190123", "resolution": "Fixed", "resolutionDate": "2020-02-13T15:32:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Postgres is mislabelled as \"orchestration\" in port diagrams and missing description", "timeSpent": "PT0S", "updated": "2020-02-13T15:32:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hey [~accountid:557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68]! Thank you so much for this ticket. I've dug up the right information and updated the page", "created": "2019-02-01T10:41:00.000000" }, { "author": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "body": "thanks for fixing it so fast. In my opinion the letter in the openssl version is quite important. Could you replace the version \n{code}\n1.1.1\n{code}\nwith\n{code}\n1.1.1a\n{code}", "created": "2019-02-01T12:15:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Absolutely! That fix will be live on the next docs build.", "created": "2019-02-01T15:05:00.000000" } ], "components": [], "created": "2019-02-01T04:07:00.000000", "creator": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@28c7e939" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsijr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_22497312_*|*_3_*:*_1_*:*_933426_*|*_10009_*:*_1_*:*_4796525_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4229" } ], "description": "Hi,\nplease have a look here:\nhttps://puppet.com/docs/puppet/6.2/about_agent.html#component-version-numbers\nit says that openssl and ruby got downgraded. I installed the latest rpm on centos 7 and verified that this isn't the case. Ruby is still at 2.5.3 and openssl got even upgraded:\n\n{code}\n[root@4fb6828f1e15 /]# /opt/puppetlabs/puppet/bin/openssl version\nOpenSSL 1.1.1a 20 Nov 2018\n[root@4fb6828f1e15 /]# /opt/puppetlabs/puppet/bin/ruby -v\nruby 2.5.3p105 (2018-10-18 revision 65156) [x86_64-linux]\n[root@4fb6828f1e15 /]# yum info puppet-agent\nLoaded plugins: fastestmirror, ovl\nLoading mirror speeds from cached hostfile\n * base: mirror.fra10.de.leaseweb.net\n * extras: mirror.ratiokontakt.de\n * updates: mirror.imt-systems.com\nInstalled Packages\nName : puppet-agent\nArch : x86_64\nVersion : 6.2.0\nRelease : 1.el7\nSize : 93 M\nRepo : installed\nFrom repo : puppet6\nSummary : The Puppet Agent package contains all of the elements needed to run puppet, including ruby, facter, and hiera.\nURL : https://www.puppetlabs.com\nLicense : See components\nDescription : The Puppet Agent package contains all of the elements needed to run puppet, including ruby, facter, and hiera.\n : \n : Contains the following components:\n : cleanup\n : cpp-hocon 0.2.0\n : cpp-pcp-client 1.6.0\n : dmidecode 2.12\n : facter 3.12.3\n : hiera 3.5.0\n : leatherman 1.5.4\n : libwhereami 0.2.2\n : module-puppetlabs-augeas_core 1.0.1\n : module-puppetlabs-cron_core 1.0.0\n : module-puppetlabs-host_core 1.0.2\n : module-puppetlabs-mount_core 1.0.2\n : module-puppetlabs-scheduled_task 1.0.0\n : module-puppetlabs-selinux_core 1.0.1\n : module-puppetlabs-sshkeys_core 1.0.2\n : module-puppetlabs-yumrepo_core 1.0.3\n : module-puppetlabs-zfs_core 1.0.1\n : module-puppetlabs-zone_core 1.0.1\n : puppet 6.2.0\n : puppet-resource_api v1.6.3-7-g2419162\n : puppet-runtime 201901130\n : pxp-agent 1.10.4\n : runtime\n : shellpath 2015-09-18\n : virt-what 1.18\n : wrapper-script\n\n[root@4fb6828f1e15 /]#\n{code}\n\nI run into this at https://github.com/voxpupuli/puppet-php/pull/507#pullrequestreview-199013246. I assume the information in the table are simply wrong, and there was no downgrade. I don't know if the Resource API version changed (I don't know how to verify it). Puppet/Hiera versions are correct:\n\n{code}\n[root@4fb6828f1e15 /]# /opt/puppetlabs/puppet/bin/puppet --version\n6.2.0\n[root@4fb6828f1e15 /]# /opt/puppetlabs/puppet/bin/hiera --version\n3.5.0\n[root@4fb6828f1e15 /]#\n{code}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54470", "fixedVersions": [], "id": "54470", "issueType": "Bug", "key": "DOCUMENT-977", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9a0622ba-116b-4661-81b3-6a2a72bf7d68", "resolution": "Fixed", "resolutionDate": "2019-02-01T11:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Component version numbers for 6.2.0 are wrong?", "timeSpent": "PT0S", "updated": "2019-02-01T15:05:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:520566be-dc64-492b-8de1-701eed347203", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "To be fixed in 2018.1+", "created": "2019-03-04T14:36:00.000000" }, { "author": "557058:520566be-dc64-492b-8de1-701eed347203", "body": "Hi [~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] The following docs have been updated:\n\n2019.0 -\u00a0[https://puppet.com/docs/pe/2019.0/installing_pe.html#external-postgresql-parameters]\n\n2018.1 -\u00a0[https://puppet.com/docs/pe/2018.1/installing_pe.html#external-postgresql-parameters]\n\n\u00a0", "created": "2019-04-02T07:24:00.000000" } ], "components": [], "created": "2019-01-31T10:31:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Parameter: \"puppet_enterprise::database_port\"\n\nValue: Port that the database is running on.\n\nDefault: 5432" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7802dea6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzshfr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Mar/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_347774307_*|*_3_*:*_1_*:*_13259991_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_2473321206_*|*_10005_*:*_1_*:*_2431721440" } ], "description": "This documentation:\n\nhttps://puppet.com/docs/pe/2019.0/installing_pe.html#external-postgresql-parameters\n\nis missing {{puppet_enterprise::database_port}}\n\n:)\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54760", "fixedVersions": [], "id": "54760", "issueType": "Improvement", "key": "DOCUMENT-976", "labels": [ "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2019-04-02T10:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "add puppet_enterprise::database_port to installing_pe", "timeSpent": "PT0S", "updated": "2019-04-02T10:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "To recap - it is a common task to format a hash into a String where you want something that is nicely formatted (each entry on a separate line, and where possibly the separator is output as `=` instead of the default `=>`. The String.new() reference documentation is available in puppet docs, but it is a daunting task to figure out how to correctly describe a format that does what you want.\n\nMy blog posts shows several examples - from simple to more advanced. Most recently in slack I posted the example below to show how one user could get the task done without having to do a suggested bad hack using ERB and a recursive method in Ruby).\n\n{code:puppet}\n# Example - format a hash recursively with String.new function (i.e. String($hash, $format) ).\n#\nclass test {\n $hash = {\n 'var1' => 'value',\n 'var2' => 'value2',\n 'nest' => {\n 'foo' => 'bar',\n 'super' => { 'nest' => 'even', 'more' => 'values' },\n }\n }\n\n $format = {\n Hash => {\n format => '%#h', # get { } as delimiters around a hash, and each entry on a new line (indented)\n separator => \"\", # each key/val on a new line when using # above, so use empty string here\n separator2 => ' = ', # between key and value\n string_formats => { # Detailed formatting per data type nested in the hash\n String => '%s' # strings in the hash should not have quotes\n }\n }\n }\n # Do a notify with the formatted hash (indented)\n #\n notify { \"Using Format\":\n message => String($hash, $format)\n }\n\n # Do a notify with the formatted hash where the indentation is removed\n #\n notify { \"Using Format and dropping indentation\":\n message => String($hash, $format).regsubst(/^\\s*/, '', 'G')\n }\n}\ninclude test\n\n# Left as exercise, write a puppet language function mymodule::my_hash_format($hash) and do the formatting there.\n\n{code}\n\nSee the scrollback for the referenced slack conversation to find the ERB (bad way) suggestion.", "created": "2019-01-29T07:07:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "Oh, and my blog post on this topic is here: http://puppet-on-the-edge.blogspot.com/2016/05/converting-and-formatting-data-like-pro.html\nSince then, there has been some new features in `new` with additional flags and features - while I believe that the examples in that post are still relevant, it probably needs to be organized differently for a broader audience showing some more domain typical and relevant examples than my toy stuff.", "created": "2019-01-29T07:10:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "For this work, I think we would need current examples and pre-docs, so I am going to close this for now. We are happy to reopen it if someone can provide us with the use case (i.e., why does a user want to do this?), a simple, realistic code sample, an explanation of what the code sample demonstrates, relevant information about setting, defaults, syntax, etc. If you have an idea of where in the docs you would look for this kind of information, that's nice to have, but not necessary.", "created": "2020-02-21T09:52:00.000000" } ], "components": [], "created": "2019-01-29T07:01:00.000000", "creator": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@178c04b2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [ "70121:81a73de1-7f52-49cd-b0b0-46c1b147202a" ] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsftz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_184492085_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_76627863_*|*_10005_*:*_1_*:*_33272346410" } ], "description": "Per the conversation at [https://puppetcommunity.slack.com/archives/C0W298S9G/p1548770080898300?thread_ts=1548769329.894400&cid=C0W298S9G]\u00a0I would like it if the Puppet internal documentation could provide the advanced usage capabilities as posted in Henrik's blog without needing to try and figure out how to cross-reference the materials myself.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55126", "fixedVersions": [], "id": "55126", "issueType": "Improvement", "key": "DOCUMENT-974", "labels": [ "example", "large", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e0340dee-9d48-48c3-8c6a-02597af847c9", "resolution": "Won't Fix", "resolutionDate": "2020-02-21T09:52:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Docs should provide advanced references where possible.", "timeSpent": "PT0S", "updated": "2020-02-21T09:52:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [ { "attacher": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "created": "2019-01-29T03:20:00.000000", "name": "2019-01-29_10MS+0000_1279x892.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14238" }, { "attacher": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "created": "2019-01-29T03:19:00.000000", "name": "2019-01-29_10MS+0000_798x563.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14248" } ], "comments": [ { "author": "636d534b524352f9c6e4edbc", "body": "[~accountid:557058:1c8b4b8c-8c59-47c6-8446-8e20ecf2947f] Are you able to take a look at this ticket regarding outdated PDK docs?\u00a0\n\n\u00a0", "created": "2019-01-29T11:21:00.000000" }, { "author": "557058:1c8b4b8c-8c59-47c6-8446-8e20ecf2947f", "body": "Yes, this is a known issue. Once all the redirects are in place it will take time for that change to happen. cc: [~accountid:557058:fd1909cc-c57f-4b1f-880c-e06d7009618b]", "created": "2019-01-29T11:46:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "This is an issue on a lot of Google results for our docs", "created": "2019-01-29T13:23:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "After further investigation, this work will be handled by the larger docs.puppet.com decommissioning project. See DIP-78.", "created": "2019-01-29T14:13:00.000000" } ], "components": [], "created": "2019-01-29T03:22:00.000000", "creator": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1997e6c3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsfrb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_25515297_*|*_3_*:*_1_*:*_11967051_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1529982_*|*_10005_*:*_1_*:*_18469" } ], "description": "Even without cookies, the google search \"pdk docs\" returns https://docs.puppet.com/pdk/ as first hit, a page that goes to a generic redirect page leaving customers stranded.\n\nPlease either improve SEO to have https://puppet.com/docs/pdk/1.x/pdk.html as the first hit, and/or change the setup on our side to help folks coming in to https://docs.puppet.com/pdk to have a way to the actual docs by linking or redirecting at a HTTP level.\n\ncc [~accountid:557058:c737f20a-b831-4320-b376-844fe0567ee8] [~accountid:6323ae27ce3e476e42adaa2c]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54616", "fixedVersions": [], "id": "54616", "issueType": "Improvement", "key": "DOCUMENT-973", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "resolution": "Duplicate", "resolutionDate": "2019-01-29T14:13:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "google search \"pdk docs\" still has old docs.puppet.com site as first hit", "timeSpent": "PT0S", "updated": "2019-01-29T14:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Closing, as PE 2017.2 is no longer supported and this page wasn't included in newer docs.\u00a0", "created": "2020-02-19T17:39:00.000000" } ], "components": [], "created": "2019-01-26T18:49:00.000000", "creator": "5b29440b088822535508e534", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e0e481a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzseev:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_145196529_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_33460239689" } ], "description": "Hi,\n\nIn the doc page : [https://puppet.com/docs/pe/2017.2/awscf_intro.html]\n\nThe following snippet: \"\n\nPuppet\u2019s templates are available in a\u00a0[production S3 bucket|https://console.aws.amazon.com/s3/home?region=eu-west-1#&bucket=puppet-enterprise-cloudformation-templates&prefix=production/],\u00a0{{s3://puppet-enterprise-cloudformation/production/}}.\n\n\"\u00a0\n\nThere is no bucket {{s3://puppet-enterprise-cloudformation/production/\u00a0}}\n\nI think it was deleted but this doc page was not updated.\n\nRegards\n\nRajesh", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54887", "fixedVersions": [], "id": "54887", "issueType": "Bug", "key": "DOCUMENT-972", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b29440b088822535508e534", "resolution": "Won't Do", "resolutionDate": "2020-02-19T17:40:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "S3 bucket link in doc is invalid ", "timeSpent": "PT0S", "updated": "2020-02-19T17:40:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "https://puppet.com/docs/pipelines-for-apps/enterprise/agent.html#minimum-system-requirements", "created": "2019-02-21T10:09:00.000000" } ], "components": [], "created": "2019-01-25T13:18:00.000000", "creator": "557058:a1934fbf-2a74-46f4-a302-1419213a1c67", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60975d40" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hylosv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_251516251_*|*_3_*:*_1_*:*_68540243_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2001389654" } ], "description": "Documentation needed for Piplelines agents minimum system requirements for build servers\n\n\u00a0\n\nBuild server Depends on how much activity it has.\n\nMinimum:\n2 CPU\n4GB\n100GB (200GB for shared build server)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54661", "fixedVersions": [], "id": "54661", "issueType": "Task", "key": "DOCUMENT-971", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a1934fbf-2a74-46f4-a302-1419213a1c67", "resolution": "Fixed", "resolutionDate": "2019-02-21T10:09:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Pipelines Agent system requirements", "timeSpent": "PT0S", "updated": "2019-02-21T10:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "created": "2019-01-25T06:51:00.000000", "name": "Screen Shot 2019-01-25 at 13.51.04.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14276" } ], "comments": [ { "author": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "body": "the puppet run itself will return those services to on,", "created": "2019-02-13T16:07:00.000000" } ], "components": [], "created": "2019-01-25T07:08:00.000000", "creator": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5f99d107" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Priority" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsduf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_273811123_*|*_3_*:*_1_*:*_1689294_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_1103464_*|*_10005_*:*_1_*:*_1399208711" } ], "description": "The following documentation describes how to regenerate compile master certificates:\n\n[https://puppet.com/docs/pe/2018.1/regenerate_compile_master_certificates.html|https://puppet.com/docs/pe/2018.1/regenerate_compile_master_certificates.htm]\n\nThe following steps do not work as written:\n\n!Screen Shot 2019-01-25 at 13.51.04.png|width=765,height=292!\n\nStep 8 calls for pe-puppetserver to be restarted, however since the SSL directory does not exist as it was removed in an earlier step, an error is printed:\n\n\u00a0\n{code:java}Jan 25 13:45:48 2018cm puppetserver[12365]: Exception in thread \"main\" java.lang.IllegalArgumentException: Unable to open 'ssl-cert' file: /etc/puppetlabs/puppet/ssl/certs/2018cm.platform9.puppet.net.pem\n{code}\n\u00a0\n\n\u00a0\n\nI propose the following changes starting from step 8:\n\n\u00a0\n\n\u00a0\n\n8. Re-start the Puppet agent service\n{code:java}puppet resource service puppet ensure=running\u00a0\n{code}\n{{9.}}\u00a0Ensure Puppet agent completes 1 run\n {{10.Log into the MoM as root}}.\n 11. On the MoM, sign the compile master's certificate request. Run\u00a0{{puppet cert --allow-dns-alt-names sign }}.\n 12.Log into the compile master as\u00a0{{root}}.\n 13.Run Puppet.\n PE will perform a full catalog run, and the compile master will resume its role in your PE deployment.\n \u00a0\n\n\u00a0\n\nIt would also be useful to have a reminder that the parameter dns_alt_names is set appropriately in the puppet.conf on the compile master before the cert is signed, maybe in one of those note boxes, like this:\n\n\u00a0\n\nNote:\u00a0ensure the\u00a0{{dns_alt_names}}\u00a0value is set\u00a0 in puppet.conf to a comma-separated list of any alternative names that agents use to connect to compile masters. The installation uses\u00a0{{puppet}}\u00a0by default.\n\n\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54660", "fixedVersions": [], "id": "54660", "issueType": "Bug", "key": "DOCUMENT-970", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "resolution": "Fixed", "resolutionDate": "2019-02-13T16:39:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Compile Master certificate regeneration steps incorrect in 2018.1 docs", "timeSpent": "PT0S", "updated": "2019-02-13T16:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5f35c4af8d89e300463337a9", "attachments": [], "comments": [ { "author": "63d2e1780d930a766df1296b", "body": "I am the original reporter, but for some reason my account was deleted. \u00af\\_(\u30c4)_/\u00af", "created": "2022-09-26T16:53:00.000000" }, { "author": "623a434701f8660070b62e0a", "body": "This request is about 4 years old. I\u2019m not sure if this update is crucial or just \u201cnice to have.\u201d", "created": "2023-05-17T18:11:00.000000" } ], "components": [], "created": "2019-01-24T10:48:00.000000", "creator": "999854:e4347c29-7a79-4d78-92e0-2e945203bd93", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@48c8deed" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsd1b:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "3.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "26/Sep/22" } ], "description": "It would be handy if the Hiera merge behavior documentation covered merging arrays of hashes. For example, what is the result of the following using a \u201cunique\u201d merge?\n\n{code}\n# a.yaml\npeople:\n - name: Alice\n password: rKlXG1WwsmpSWwkXkN\n\n# b.yaml\npeople:\n - name: Daniel\n password: hunter2\n{code}\n\nhttps://puppet.com/docs/puppet/6.1/hiera_merging.html#merge-behaviors\n\n_I'm filing this in DOCUMENTS with my community account since my last day at Puppet will be 1/31/2019_", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55110", "fixedVersions": [], "id": "55110", "issueType": "Improvement", "key": "DOCUMENT-969", "labels": [ "core", "hiera", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "999854:e4347c29-7a79-4d78-92e0-2e945203bd93", "status": "Accepted", "statusCategory": "To Do", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Hiera merge behavior for arrays of hashes", "timeSpent": "PT0S", "updated": "2023-05-26T10:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [ { "author": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "body": "Some additional info via forensics from an unnamed source:\n\nStorage - the Puppet agent a is ~30MB download from the Puppet Master server ~250MB when extracted on the system.\n\nThe Puppet runs as a system daemon, which sits idle most of the time. While the agent is idle the agent consumes roughly these resources.\n\n* CentOS Linux release 7.5.1804 (Core) (AWS t2.small)\n* Windows Server 2016 Datacenter (AWS t2.small)\n\nWhen the Puppet agent starts up there will be additional resource consumption, which is just the process waking up. The agent does play nice with other processes and only consumes what is needed.\n\nPeriodically, once ever 30 minutes by default, the daemon will activate and perform a Puppet run. Runs may last anywhere from 5 seconds to multiple minutes, depending on how much configuration Puppet is checking and enforcing. During a run, Puppet will invoke system utilities pertinent to checking system state, and if necessary updating system configuration.\n\nSystem resource utilization will depend on how much work Puppet has to perform during a given run. Normal \u201cin sync\u201d runs where Puppet is only validating configuration typically won\u2019t register significant utilization above the idle baseline. When Puppet performs configuration work, additional resource utilization will occur dependent on resource utilization required by the underlying system utilities Puppet invokes to perform configuration actions.\n\nWhat this means - depending on the amount, type, and complexity of the configurations you are applying to each system will change the amount of resources consumed during a Puppet agent run. There are some baseline facts that we know, but the overall consumption is tied to the number of system resources being managed and how the OS prioritizes these processes. Overall, the agent consumes very little resources on the managed node. Because the agent uses built-in, system tools the system will see some minimal resource spikes while they are being used, but with little impact from the Puppet agent.\n\nPuppet has many large enterprise customers who run the Puppet agent on 10's of thousands of nodes, upwards of 100K nodes, and are conscious of system resources and contention. Puppet works well within these environments without consuming unnecessary resources. There are many ways of tuning Puppet and the agent to limit the amount of resources consumed as well as the frequency of configuration runs.\n", "created": "2019-01-22T14:06:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:5abd613dd4cf3c56be24b70d], is this information you might be able to provide? I think even disk and memory requirements would be helpful.\n\nMinimum disk space required for initial installation: e.g. XYZ MB\nMinimum CPU requirements: e.g. Puppet has been run and tested on a variety of hardware specifications. [Insert additional caveats or known data points here]\nMinimum memory requirements: e.g. 512 MB, etc.", "created": "2020-02-21T09:56:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Docs, add the following information:\n\nMinimum disk space required for initial installation: e.g. 150 MB\n\nPuppet has been run and tested on a variety of hardware specifications, the following are the weakest we tested:\n\n 1 CPUs, 2.4 GHz, Intel Xeon Family, 0.5 GiB memory (Amazon Linux 2 AMI)\n 1 CPUs, 2.5 GHz, Intel Xeon Family, 1 GiB memory (Windows Server 2019)\n\n", "created": "2020-03-26T15:45:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Revised the shortdesc and added hardware requirements here:\u00a0[https://puppet.com/docs/puppet/6.16/system_requirements.html#hardware_requirements]\u00a0in 6.16 and latest-preview. Changes will be published shortly.\u00a0", "created": "2020-07-16T10:55:00.000000" } ], "components": [], "created": "2019-01-22T13:58:00.000000", "creator": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69841872" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzsbov:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_508571254_*|*_3_*:*_1_*:*_3210704_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_2839629167_*|*_10006_*:*_1_*:*_9851501299_*|*_10005_*:*_1_*:*_33527739393" } ], "description": "As a user of Puppet who needs to justify it's installation in my organization, I would like the Puppet documentation to include a list of minimum system requirements to install the agent. Currently, the only documentation available is the following page, which states:\n\n\"The Puppet agent service has no particular hardware requirements and can run on nearly anything.\"\n\nhttps://puppet.com/docs/puppet/5.5/system_requirements.html\n\nIt would be helpful if Puppet could include the following information related to Puppet agent: \n\nMinimum disk space required for initial installation: e.g. XYZ MB\nMinimum CPU requirements: e.g. Puppet has been run and tested on a variety of hardware specifications. [Insert additional caveats or known data points here]\nMinimum memory requirements: e.g. 512 MB, etc. \n\nIf we aren't able to provide specifics, it would be helpful to have a page that describes the minimum requirements in more detail and some of the key factors as to why we aren't able to publish specific numbers and how to obtain them if someone is interested. \n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54758", "fixedVersions": [], "id": "54758", "issueType": "Improvement", "key": "DOCUMENT-968", "labels": [ "docs-hack", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "resolution": "Done", "resolutionDate": "2020-07-16T11:42:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Include minimum disk, CPU and memory requirements for Puppet agent", "timeSpent": "PT0S", "updated": "2020-07-16T11:42:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "To fix: make a pr to the code base.", "created": "2019-01-22T10:30:00.000000" } ], "components": [], "created": "2019-01-17T14:27:00.000000", "creator": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@8971d1f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzslhj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_417717102_*|*_3_*:*_1_*:*_432206971_*|*_10009_*:*_1_*:*_24567326_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1467140598" } ], "description": "The page at https://puppet.com/docs/puppet/6.1/man/lookup.html#NAME references {{puppet-lookup}}. It's a proper Puppet application, and as such, does not have a {{puppet-lookup}} binary. It should simply be {{puppet lookup}} with no dash.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54756", "fixedVersions": [], "id": "54756", "issueType": "Task", "key": "DOCUMENT-980", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "resolution": "Fixed", "resolutionDate": "2019-02-13T16:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet-lookup is named improperly", "timeSpent": "PT0S", "updated": "2019-02-13T16:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:6fc1f430-f771-4686-a97e-21c5e35f9100", "body": "existing: \"This means you can no longer write code to the codedir", "created": "2019-01-16T09:05:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good clarification, [~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100], thank you! I fixed this up in 2017.3 and forward.", "created": "2019-01-18T17:29:00.000000" } ], "components": [], "created": "2019-01-16T08:27:00.000000", "creator": "5bb243ee607be0205f96d28d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@681a9cf9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzs85r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_205313576_*|*_5_*:*_1_*:*_347574237_*|*_6_*:*_1_*:*_0" } ], "description": "Document located at:\u00a0[https://puppet.com/docs/pe/2018.1/code_mgr_how_it_works.html#understanding-file-sync-and-the-staging-directory]\n\nAlso at [https://puppet.com/docs/pe/2019.0/code_mgr_how_it_works.html]\u00a0and previous versions equivalent pages\u00a0\n\nCustomer has raised a support ticket regarding the line\u00a0\n\n'This means you can no longer write code to the codedir'\n\nThe customer has said that this line \"lead us to believe that local changes to code in the codedir would be ignored but we are able to directly edit code and have it run on nodes, despite those code changes not being reflected in git\".\n\nLine should be updated to\u00a0\n\n'This means you should no longer write code to the codedir'\n\nTo prevent future misunderstandings.\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55109", "fixedVersions": [], "id": "55109", "issueType": "Task", "key": "DOCUMENT-967", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5bb243ee607be0205f96d28d", "resolution": "Fixed", "resolutionDate": "2019-01-18T17:29:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "How Code Manager works", "timeSpent": "PT0S", "updated": "2019-01-22T18:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Whoever picks up this ticket: this is in generated docs and should be a PR to the Puppet code base.", "created": "2019-01-22T10:28:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Tidy is \"heavy\" and a Catch 22 ...\n\n[https://ask.puppet.com/question/132/does-filebucket-need-periodic-maintenance-cleaning/]\n\n[https://ask.puppet.com/question/30973/tidy-not-remove-files/]\n\n\u00a0", "created": "2020-02-21T17:32:00.000000" } ], "components": [], "created": "2019-01-14T17:58:00.000000", "creator": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@766deeb3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzs6u7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_664039422_*|*_10007_*:*_1_*:*_11143316_*|*_3_*:*_1_*:*_354182_*|*_10009_*:*_1_*:*_3347306739_*|*_6_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_163016083_*|*_10005_*:*_1_*:*_33980896839" } ], "description": "Current documentation of the File resource states the following re: the backup attribute of the file resource: \n\nhttps://puppet.com/docs/puppet/5.5/types/file.html#file-attribute-backup\n\n_\"backup\n\nWhether (and how) file content should be backed up before being replaced. This attribute works best as a resource default in the site manifest (File { backup => main }), so it can affect all file resources.\n\nIf set to false, file content won\u2019t be backed up.\nIf set to a string beginning with ., such as .puppet-bak, Puppet will use copy the file in the same directory with that value as the extension of the backup. (A value of true is a synonym for .puppet-bak.)\nIf set to any other string, Puppet will try to back up to a filebucket with that title. See the filebucket resource type for more details. (This is the preferred method for backup, since it can be centralized and queried.)\nDefault value: puppet, which backs up to a filebucket of the same name. (Puppet automatically creates a local filebucket named puppet if one doesn\u2019t already exist.)\n\nBacking up to a local filebucket isn\u2019t particularly useful. If you want to make organized use of backups, you will generally want to use the puppet master server\u2019s filebucket service. This requires declaring a filebucket resource and a resource default for the backup attribute in site.pp:\"\n\n...\n\nIf you are using multiple puppet master servers, you will want to centralize the contents of the filebucket. Either configure your load balancer to direct all filebucket traffic to a single master, or use something like an out-of-band rsync task to synchronize the content on all masters.\"_\n\nAs a user of Puppet, I would like more information about how to effectively manage the filebucket on servers. Without any intervention and with enough large files and file changes, the filebucket will eventually exceed the allocated disk space and causes issue that need to be manually remediated by a System Administrator. While it appears there are plans to turn off the backup parameter by default in Puppet 7, it would be helpful for current users of Puppet to be aware of the implications of using the backup parameter and filebucket. \n\nWhile as of 2015.0.3, PE is no longer shipping with the backup option turned on for the File resource, it can still be enabled via the use of other Puppet code and/or modules that override this behavior. \n\nAt a minimum, I would recommend that the following additional information be included on the File resource page after the following sentence :\n\n\"Either configure your load balancer to direct all filebucket traffic to a single master, or use something like an out-of-band rsync task to synchronize the content on all masters.\"\n\nPROPOSED NEW TEXT: \n\nPlease be aware that enabling and using the backup option and by extension the filebucket resource requires appropriate planning and management to ensure that sufficient disk space is available for the file backups. Generally this can be implemented most efficiently with a find command and crontab entry to only retain the last X days of file backups or restrict the directory to a maximum size after which the oldest items are removed. \n\nSimilarly, I think this information should be cross-referenced on the filebucket page itself:\n\nhttps://puppet.com/docs/puppet/5.5/man/filebucket.html\n\n\n\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54219", "fixedVersions": [], "id": "54219", "issueType": "Improvement", "key": "DOCUMENT-966", "labels": [ "docs-hack", "generated-docs", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:03aedc5a-47b0-4c60-a13f-46427c87153e", "resolution": "Fixed", "resolutionDate": "2020-03-31T12:51:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add management of filebucket to File resource and filebucket documentation", "timeSpent": "PT0S", "updated": "2020-03-31T12:51:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I'm attaching a ticket about operating systems without packages (like Solaris), as that is also out of alignment and can be addressed at the same time.", "created": "2019-01-17T09:34:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "\"Support\" is a very meaningful word to PE customers who pay for support and we need to always be careful about the term \"supported platform\", especially in OSP docs where what we actually mean is \"platforms for which Puppet ships official packages\".\n\n- We still sometimes ship OSP agent packages for operating systems prior to a supported PE release shipping them, even if that window is just a few days or weeks and even if the agent package shipped with PE winds up being fundamentally identical.\n\n- As Jean noted, we provide pe_repo agent package downloads and paid technical support for operating systems and architectures that do not get OSP packages.\n\n- OSP users can compile Agent components from source on operating systems and architectures that don't get Puppet-shipped OSP {{puppet-agent}} packages. Those platforms and architectures might even be ones we support and ship PE-only packages for, but that doesn't mean OSP users can expect Puppet-shipped packages for those platforms, or that PE users can expect support for Agent components they compile themselves.", "created": "2019-03-05T17:31:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Seems there's too much variance in supported/packaged platforms for PE vs. OSP for these two links to align. Potentially, when we get conditionalizing working in our authoring tools, we can single-source this content, but for now, they need to remain separate topics. I don't think JIRA gives us the option to mark it as such, but this is essentially as designed. ", "created": "2019-03-21T12:19:00.000000" } ], "components": [], "created": "2019-01-10T13:38:00.000000", "creator": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@74096e59" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzs3xz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_336499969_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_5703208640" } ], "description": "Now that there is just the AIO agent for OSP/PE, shouldn't these two links line up?\u00a0 More than once in the past I went looking for supported agents and ended up confused so it'd be nice if they're streamlined and the same.\n\n(This time I was looking at Ubuntu 18.04 support specifically): https://puppet.com/docs/pe/2019.0/supported_operating_systems.html#puppet-agent-platforms https://puppet.com/docs/puppet/6.1/system_requirements.html#packaged-platforms", "duedate": "2019-03-31T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54615", "fixedVersions": [], "id": "54615", "issueType": "Bug", "key": "DOCUMENT-963", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "resolution": "Won't Do", "resolutionDate": "2019-03-21T12:19:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "AIO agent means that the OSP and PE supported OS should align?", "timeSpent": "PT0S", "updated": "2019-03-21T12:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "5c490f9c4c070827c2a1d0f7", "body": "I forked off the puppet-docs but am having difficulties finding that document bgtm.md in the source/puppet/6.1.\n\nOr did I fork off the wrong repo/branch?\n\nThanks.\n\n\u00a0", "created": "2019-01-10T00:43:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you for seeing this! I've fixed it and the fix will be live on the next docs rebuild.", "created": "2019-01-10T11:07:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:5c490f9c4c070827c2a1d0f7], somehow I missed your question before, I apologize!\n\nThe open source Puppet docs are in the process of being migrated to a content management system. I'm sorry to say PRs are no longer possible on most of the docs.\n\nWe're sad to lose this functionality, but we had to switch to a more scalable system for our docs team. The ticket was perfect, and I appreciate that you filed it.", "created": "2019-01-22T18:04:00.000000" } ], "components": [ "Modules" ], "created": "2019-01-10T00:10:00.000000", "creator": "5c490f9c4c070827c2a1d0f7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e167af6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzs2qv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_39386908_*|*_5_*:*_1_*:*_0" } ], "description": "In [https://puppet.com/docs/puppet/6.1/bgtm.html#concept-1345,]\n\nunder the Containment section:\n\n\"To contain classes, use the {{contain}} function. For example, the {{puppetlabs-nt}}p module uses containment in the main {{ntp}} class:\"\n\nThe \"p\" in puppetlabs-ntp isn't included in the highlight.\u00a0 I believe it should be included.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54753", "fixedVersions": [], "id": "54753", "issueType": "Bug", "key": "DOCUMENT-962", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5c490f9c4c070827c2a1d0f7", "resolution": "Fixed", "resolutionDate": "2019-01-10T11:07:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "the p in puppetlabs-ntp isn't highlighted in https://puppet.com/docs/puppet/6.1/bgtm.html#concept-1345", "timeSpent": "PT0S", "updated": "2019-01-22T18:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [ { "attacher": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "created": "2019-01-03T15:02:00.000000", "name": "ss1.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14263" } ], "comments": [ { "author": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "body": "Editorially, this sort of bug shows that at least one person has read the release notes.", "created": "2019-01-03T15:06:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good catches, thank you!", "created": "2019-01-07T16:49:00.000000" } ], "components": [ "Puppet Client/Agent" ], "created": "2019-01-03T15:05:00.000000", "creator": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@31d2a133" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzry1j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_331175622_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_20629436" } ], "description": "I found typos in the \"puppet ssl subcommand\" section of the Puppet 6.0 release notes.\n\n[https://puppet.com/docs/puppet/6.0/release_notes_puppet.html]\n\nThe word \"command\" is misspelled as \"comman\".\n\nThe closing after \"submit_request\" ends one character early so only \"submit_reques\" is highlighted.\n\nOther than those, thank you for the release notes, very useful.", "environment": "Firefox 64.0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54469", "fixedVersions": [], "id": "54469", "issueType": "Bug", "key": "DOCUMENT-961", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "resolution": "Fixed", "resolutionDate": "2019-01-07T16:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "typos in puppet 6.0 release notes", "timeSpent": "PT0S", "updated": "2019-01-07T16:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "just waiting to verify the fix in the next docs build", "created": "2019-01-07T16:54:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good catch, thank you!", "created": "2019-01-08T11:54:00.000000" } ], "components": [], "created": "2019-01-03T10:42:00.000000", "creator": "557058:fd17676f-b54f-4df6-b0e2-ce0f8a23c31e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3f633f84" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrxlj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_347013225_*|*_3_*:*_1_*:*_15843139_*|*_5_*:*_1_*:*_0_*|*_10011_*:*_1_*:*_68395127_*|*_10005_*:*_1_*:*_5053239" } ], "description": "They should note where plans are stored in a module (the plans/ directory). [https://puppet.com/docs/puppet/6.1/modules_fundamentals.html]\n\n\u00a0\n\nPlans in modules seems relevant to all Puppet versions from 6.0 on.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54108", "fixedVersions": [], "id": "54108", "issueType": "Bug", "key": "DOCUMENT-960", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:fd17676f-b54f-4df6-b0e2-ce0f8a23c31e", "resolution": "Fixed", "resolutionDate": "2019-01-08T11:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet docs on module layout mention tasks/, but not plans/", "timeSpent": "PT0S", "updated": "2019-01-08T11:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "6232900033fb840069670be8", "body": "Hi Guys,\n\nActually, I was also reading the [\"Puppetfile\" documentation |https://puppet.com/docs/pe/2019.0/puppetfile.html], and I've noticed that the example for the git repos are also missing examples for Bitbucket with the protocol (ssh://).\n\nCan you also update this documentation ?\n\nCheers,\nVincent", "created": "2018-12-16T21:56:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I've added notes to the configuration topics and the Puppetfile page. The fix should be live sometime today.", "created": "2019-02-07T17:08:00.000000" } ], "components": [], "created": "2018-12-16T18:39:00.000000", "creator": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@404f5dd1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzop4f:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_59358590_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4514356293" } ], "description": "[https://puppet.com/docs/pe/2019.0/code_mgr_config.html#enable-code-manager-after-installation]\n\nOur doc currently shows example of r10_remote parameter \"git@:puppet/control.git\", this however doesn't work for users who are using Bitbucket server. The right git URL should look like this \"ssh://git@:/puppet/control.git\"\n\nReference Support KB article -\u00a0https://support.puppet.com/hc/en-us/articles/227829007-KB-0058-Fix-your-Bitbucket-Stash-Code-Manager-configuration-in-Puppet-Enterprise-2015-3-x-to-2017-2-x", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54106", "fixedVersions": [], "id": "54106", "issueType": "Improvement", "key": "DOCUMENT-958", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "resolution": "Fixed", "resolutionDate": "2019-02-07T17:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "r10_remote parameter for Bitbucket requires \"ssh://\" at the beginning of Git URL", "timeSpent": "PT0S", "updated": "2019-02-07T17:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "[~accountid:557058:97a3d564-f045-44ef-b504-f23937482ee5] Thanks! I've fixed the typo. Let me know if you see any other issues with the Getting Started, I'm working on some improvements to that section at the moment.", "created": "2018-12-10T12:34:00.000000" } ], "components": [], "created": "2018-12-10T11:12:00.000000", "creator": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7b8b55ab" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrllj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_113893_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4848527" } ], "description": "There seems to be a typo on this page of the Getting started with Pipelines for Containers walkthrough:\n\n[https://puppet.com/docs/pipelines-for-containers/free/gs_create_wordpress_container.html]\n\nStep 4 has you create a k8s-wordpress\u00a0repo, but step 5 says to push to k8s-mysql\u00a0(which I assume should be k8s-wordpress).\u00a0 The k8s-mysql\u00a0was part of the previous section's steps.", "duedate": "2018-12-31T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54659", "fixedVersions": [], "id": "54659", "issueType": "Bug", "key": "DOCUMENT-957", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "resolution": "Fixed", "resolutionDate": "2018-12-10T12:35:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Getting Started with PFC guide typo", "timeSpent": "PT0S", "updated": "2018-12-10T12:35:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Hi [~accountid:557058:0a2bfc9c-1912-49b1-9776-665ef20c8769]! It looks like you've already added this info in\u00a0DOCUMENT-1020?", "created": "2020-04-14T03:21:00.000000" }, { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Hi [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1]. I added these types to the overview chart here\u00a0[https://puppet.com/docs/puppet/latest/lang_data_type.html#reference-2534]\u00a0, but this ticket was to add full info about these types to the main docs, and that hasn't been done.\u00a0", "created": "2020-04-14T10:33:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs-hack to do:\n * Add descriptions of the\u00a0SemVer and SemVerRange to this page:\u00a0[https://puppet.com/docs/puppet/6.17/lang_data_abstract.html], based on the information given in the spec above.\u00a0", "created": "2020-07-15T03:05:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "I'm assigning this to [~accountid:63d40628f6e1b543161789a7]\u00a0for a final review before adding these to a new Scalar section.\u00a0\n\nPredocs here:\u00a0[https://docs.google.com/document/d/1fGJUfs4rljLGNh6ztOQyERYcKCKFChH0nWq8bvb_2h0/edit]", "created": "2020-08-10T14:07:00.000000" }, { "author": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "body": "Since this has gone stale, closing this for now. If there is a need for these docs, please reopen.\u00a0", "created": "2020-09-09T14:01:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for letting us know [~accountid:5e3375e183d74c0e821851f3]! I am currently working on improving our sensitive data docs -\u00a0DOC-4872\u00a0+\u00a0DOC-4901\n\nI'll mark this as high priority and make sure it is next on the list.\u00a0", "created": "2021-03-18T08:49:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:63d40628f6e1b543161789a7]\u00a0could you please take a look at the Google doc Logan posted above and let us know if it's ready to be published? Thanks!", "created": "2021-03-23T02:32:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "Sorry missed this, will do!", "created": "2021-05-26T16:28:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "I made a pass through the doc and sent some comments to Logan. I also found a bug PUP-11077. Good times.", "created": "2021-06-01T19:41:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks Josh! I'll take this one now.", "created": "2021-06-02T06:34:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs updated.\n\nSemVer: [https://puppet.com/docs/puppet/7/lang_data_abstract.html#lang_data_abstract_flexible-semver-data-type]\n\nSemVerRange: [https://puppet.com/docs/puppet/7/lang_data_abstract.html#lang_data_abstract_flexible-semver-data-type]\n\n\u00a0", "created": "2021-10-05T05:25:00.000000" } ], "components": [], "created": "2018-12-05T15:09:00.000000", "creator": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@18ae1adc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|o08lw0:" }, { "fieldName": "Story Points", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:float", "value": "4.0" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Apr/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_446139362_*|*_3_*:*_5_*:*_9925815801_*|*_10009_*:*_3_*:*_6548027296_*|*_5_*:*_1_*:*_0_*|*_6_*:*_1_*:*_15225310986_*|*_10004_*:*_1_*:*_5733833825_*|*_10006_*:*_4_*:*_13745030882_*|*_10005_*:*_3_*:*_37761297744" } ], "description": "The data types {{SemVer}} and {{SemVerRange}} are not documented on this page https://puppet.com/docs/puppet/6.0/lang_data_type.html - they are in the specification here: https://github.com/puppetlabs/puppet-specifications/blob/master/language/types_values_variables.md#semverversion-ranges\n\nThere is also an improvement ticket PUP-9342 that will affect the specification.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54104", "fixedVersions": [], "id": "54104", "issueType": "Improvement", "key": "DOCUMENT-956", "labels": [ "docs-hack", "lang", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "High (migrated)", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "resolution": "Fixed", "resolutionDate": "2021-10-05T05:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Data types SemVer and SemVerRange are not documented", "timeSpent": "PT0S", "updated": "2021-10-05T05:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5a46c85fe0a6f308201def98", "attachments": [], "comments": [ { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "Sample response:\n\n{code}\ncurl -v -X POST -H 'Content-Type: application/json' \\\n> --cert $(puppet config print hostcert) \\\n> --key $(puppet config print hostprivkey) \\\n> --cacert $(puppet config print localcacert) \\\n> https://$(hostname -f):4433/rbac-api/v1/users/5cfd6d84-b7c8-4d6c-80cf-c68618b4dff0/password/reset\n* About to connect() to c7k.vm port 4433 (#0)\n* Trying 127.0.0.1...\n* Connected to c7k.vm (127.0.0.1) port 4433 (#0)\n* Initializing NSS with certpath: sql:/etc/pki/nssdb\n* CAfile: /etc/puppetlabs/puppet/ssl/certs/ca.pem\n CApath: none\n* NSS: client certificate from file\n* \tsubject: CN=c7k.vm\n* \tstart date: Oct 31 21:38:51 2018 GMT\n* \texpire date: Oct 28 21:38:56 2033 GMT\n* \tcommon name: c7k.vm\n* \tissuer: CN=\"Puppet Enterprise CA generated on c7k.vm at +2018-11-01 21:38:26 +0000\"\n* SSL connection using TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA\n* Server certificate:\n* \tsubject: CN=c7k.vm\n* \tstart date: Oct 31 21:38:51 2018 GMT\n* \texpire date: Oct 28 21:38:56 2033 GMT\n* \tcommon name: c7k.vm\n* \tissuer: CN=\"Puppet Enterprise CA generated on c7k.vm at +2018-11-01 21:38:26 +0000\"\n> POST /rbac-api/v1/users/5cfd6d84-b7c8-4d6c-80cf-c68618b4dff0/password/reset HTTP/1.1\n> User-Agent: curl/7.29.0\n> Host: c7k.vm:4433\n> Accept: */*\n> Content-Type: application/json\n>\n< HTTP/1.1 201 Created\n< Date: Tue, 04 Dec 2018 23:27:34 GMT\n< Content-Type: application/json", "created": "2018-12-04T17:19:00.000000" }, { "author": "5a46c85fe0a6f308201def98", "body": "Updated the 2018.1 and 2019.0 published docs and the GitHub source. \nhttp://docs-internal.puppet.com/docs/pe/2019.0.z/rbac_api_v1_password.html#password-endpoints-api-v1\nhttp://docs-internal.puppet.com/docs/pe/2018.1.z/rbac_api_v1_password.html#password-endpoints-api-v1\n\nhttps://github.com/puppetlabs/pe-rbac-service/pull/797\n", "created": "2018-12-19T11:35:00.000000" }, { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "[~accountid:5a46c85fe0a6f308201def98], I should have been clearer about the curl response ^^ above. Those are just the headers (from using the verbose flag in curl) to illustrate the response code.\n\nThe payload of the response is just the bare token.\n\nI put up a PR here that's probably better at explaining it than all my jabbering :-) https://github.com/puppetlabs/pe-rbac-service/pull/801", "created": "2019-01-29T15:12:00.000000" }, { "author": "5a46c85fe0a6f308201def98", "body": "[~accountid:557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12] thank you! I had every intention of running this API request myself. [~accountid:557058:dbc53efe-57a8-4acd-b329-21bc29e30ce8] even set up a vm-pooler-vms for my testing. I got as far as running the curl command and getting a 404 error.\u00a0", "created": "2019-01-30T12:05:00.000000" } ], "components": [], "created": "2018-12-04T17:15:00.000000", "creator": "70121:4c61e06e-3a2f-49af-9e89-b6d0e94fb0c9", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@54c9f27b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzri3b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_496567827_*|*_10009_*:*_2_*:*_1896591219_*|*_3_*:*_1_*:*_1734756897_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_779110175" } ], "description": "In the PE docs found here (although I believe this is not limited to just PE 2019.0): https://puppet.com/docs/pe/2019.0/rbac_api_v1_password.html#response-format, the docs say that the \"POST /users/:sid/password/reset\" endpoint returns a 200 OK response on success, but it actually returns a 201 Created response ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54102", "fixedVersions": [], "id": "54102", "issueType": "Bug", "key": "DOCUMENT-954", "labels": [ "DOCS" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:4c61e06e-3a2f-49af-9e89-b6d0e94fb0c9", "resolution": "Fixed", "resolutionDate": "2019-01-30T12:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "DOCS - RBAC API response code is incorrect", "timeSpent": "PT0S", "updated": "2019-01-30T12:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [], "comments": [ { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Looks like the External facts ToC entry has, at least in recent history, always pointed at the External facts section in the Custom facts page. I'm guessing someone wanted that section in the very long Custom facts page highlighted at the ToC level (makes sense). At one time, the ToC could point to the section and the anchor would take you to the right place, so someone just did that rather than splitting the content into a separate page. But we can no longer put an anchor link in the ToC.\n\nI'm going to split this into a separate page, and link to it from both the ToC and the Custom facts page.\u00a0", "created": "2019-01-28T14:17:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Fixed for Puppet 6.0, Puppet 6.1, and Puppet 6.2. For example, see [https://puppet.com/docs/puppet/6.2/external_facts.html]\u00a0.\u00a0", "created": "2019-02-13T14:53:00.000000" } ], "components": [], "created": "2018-11-30T23:24:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@77abcb6b" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrggn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_214951799_*|*_3_*:*_1_*:*_1916914876_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4317490827" } ], "description": "There are two entries in the table of contents that both link to the same page (facter's custom_facts page), which is confusing: https://github.com/puppetlabs/puppet-docs/blob/dd5dadfea459504743112459306de1c3706d8a33/source/puppet/6.0/_puppet_toc.html#L212", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54211", "fixedVersions": [], "id": "54211", "issueType": "Bug", "key": "DOCUMENT-953", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2019-02-13T14:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "table of contents has two links to facter/custom_facts.html (\"Custom fact walkthrough\")", "timeSpent": "PT0S", "updated": "2019-02-13T14:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thank you [~accountid:623a4a598d8b9c0068b7e31a]! This type was moved out of core Puppet in 6.0 and is now a module, augeas_core, that ships in the puppet-agent package. I've updated the link in these docs for 6.0 forward. The fix should be live later today.", "created": "2019-02-07T14:26:00.000000" } ], "components": [ "Puppet Language" ], "created": "2018-11-30T16:09:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4c0618a4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrgev:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_240943343_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_5714466803" } ], "description": "On https://github.com/puppetlabs/puppet-docs/blob/master/source/puppet/6.0/resources_augeas.md / there is a broken link to https://puppet.com/docs/puppet/6.0/types/augeas.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54658", "fixedVersions": [], "id": "54658", "issueType": "Bug", "key": "DOCUMENT-952", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2019-02-07T14:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet-docs/source/puppet/6.0/resources_augeas.md: link to nonexistent types/augeas.html (error 404)", "timeSpent": "PT0S", "updated": "2019-02-07T14:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks [~accountid:557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0]! What are your thoughts [~accountid:557058:104b5720-714d-4539-b455-df472251ec89] [~accountid:557058:c241032a-c552-4408-9a96-dcd5a643ff69]?\u00a0", "created": "2018-12-04T03:45:00.000000" }, { "author": "557058:2249d8e6-5f8c-489f-942b-1c2739792d34", "body": "The best practices doc, as CS has committed to support it and open sourced it so FOSS users can use it.\u00a0 However it needs to have the word \"enterprise\" removed from it as its not PE specific anymore and that's confusing to FOSS users.\n\nHowever the grafana dashboard is a separate feature for those that want to diy integrate Puppet Server's grafana exporting into their own infra so I don't think it should fully be removed, nor deprecated.", "created": "2018-12-04T10:39:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Added a paragraph to the top of the page detailing the two different options, and referenced and recommended the option listed in the Puppet Metrics Collection doc (this has also been updated to reflect Puppet, not PE). We will document both options for the reasons Justin explained above. Thanks!\u00a0\n\n[https://puppet.com/docs/puppetserver/6.0/puppet_server_metrics.html]", "created": "2018-12-11T00:34:00.000000" } ], "components": [], "created": "2018-11-30T14:16:00.000000", "creator": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@35656e4c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrga7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_247851085_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_653197637" } ], "description": "The puppet developer dashboard has recently been broken:\u00a0SERVER-2324\n\nAnd now is being removed completely:\u00a0[https://github.com/puppetlabs/puppetserver/pull/1878]\n\nAs alternatives to view metrics data, there is conflicting info from [https://puppet.com/docs/puppetserver/6.0/puppet_server_metrics.html]\u00a0vs [https://github.com/puppetlabs/best-practices/blob/master/puppet-enterprise-metrics-collection.md]\n\nBased on the couple of CS people I spoke to, it seems like they prefer what is in the best practices doc vs using grafanadash. It seems like we should pick a preferred option and stop maintaining and documenting the other option.\n\nAdding a few people as watchers to this ticket to get any additional feedback they may have.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54611", "fixedVersions": [], "id": "54611", "issueType": "Bug", "key": "DOCUMENT-951", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "resolution": "Fixed", "resolutionDate": "2018-12-11T00:34:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Conflicting info about ways to view puppet master metrics", "timeSpent": "PT0S", "updated": "2018-12-11T00:34:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I updated the docs to include the new module:\u00a0https://puppet.com/docs/puppetserver/6.0/puppet_server_metrics.html#using-the-grafanadash-module-to-quickly-set-up-a-graphite-demo-server", "created": "2018-12-11T00:28:00.000000" } ], "components": [], "created": "2018-11-30T07:55:00.000000", "creator": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@495a8cfb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrfsv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_270752495_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_652798836" } ], "description": "This page [https://puppet.com/docs/puppetserver/6.0/puppet_server_metrics.html]\u00a0says to install\u00a0cprice404-grafanadash. This module is outdated and has been replaced with a newer version owned by puppetlabs: puppetlabs-grafanadash\n\n[https://forge.puppet.com/puppetlabs/grafanadash]\n\nInstalling the old version as documented results in multiple errors.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55025", "fixedVersions": [], "id": "55025", "issueType": "Bug", "key": "DOCUMENT-950", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "resolution": "Fixed", "resolutionDate": "2018-12-11T00:28:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet_server_metrics instructions contain reference to outdated grafanadash module", "timeSpent": "PT0S", "updated": "2018-12-11T00:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:623a4a598d8b9c0068b7e31a]! \n\nEnvironments are used on the master, rather than the agent. Please see the relevant docs here: https://puppet.com/docs/puppet/6.0/environments_about.html", "created": "2018-12-05T12:22:00.000000" }, { "author": "623a4a598d8b9c0068b7e31a", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], that's fine, but where is the documentation that the --environment option exists for the \"puppet agent\" command? I can't find any such documentation. That should be in the manual page and in the output of \"puppet help agent\". You can see that --environment is documented for \"puppet module\" and \"puppet lookup\". It's simply missing for \"puppet agent\".", "created": "2018-12-05T12:33:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:623a4a598d8b9c0068b7e31a], as I understand it, we would not support or advise the use of the --environment option on the agent. I don't know the details offhand, or what your use case is, but it may be worth asking about in our Slack community or on the puppet-users list.", "created": "2018-12-05T12:56:00.000000" }, { "author": "623a4a598d8b9c0068b7e31a", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], well, it's used in the r10k documentation, which is how I learned about it: https://github.com/puppetlabs/r10k/blob/master/doc/dynamic-environments/quickstart.mkd#Summary\n\nIt's useful for temporarily applying a certain environment to an agent run. I use it all the time, so I know what it does, I just found it odd that it's not documented properly.", "created": "2018-12-05T13:28:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hi [~accountid:623a4a598d8b9c0068b7e31a],\n\nI dug around and found some better information. Although the agent man page does not contain a complete list of settings, the --environment setting is documented in the configuration page. The agent man page provides this information and a link to the documentation.\n\n{quote}\n\nSee the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html for the full list of acceptable settings. A commented list of all settings can also be generated by running puppet agent with '\u2013genconfig'.\n{quote}", "created": "2019-01-14T15:53:00.000000" } ], "components": [ "Puppet Client/Agent" ], "created": "2018-11-29T16:45:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@4bddbb6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrfnb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_752492390_*|*_6_*:*_2_*:*_687305_*|*_10005_*:*_2_*:*_3218147859" } ], "description": "The puppet agent manual page ([https://puppet.com/docs/puppet/6.0/man/agent.html|https://puppet.com/docs/puppet/6.0/man/agent.html]) and output of \"puppet help agent\" are missing documentation on the --environment option.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55024", "fixedVersions": [], "id": "55024", "issueType": "Bug", "key": "DOCUMENT-949", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Won't Fix", "resolutionDate": "2019-01-14T15:53:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet agent man page missing --environment option", "timeSpent": "PT0S", "updated": "2019-01-14T15:53:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:750ff3bd-7564-4d8a-b480-b500b85be583] Port 8081 *is* documented on the system configuration page for mono+CM and mono+CM+standalone postgres. Can you please clarify what you believe is missing? Is it that 8081 is needed in mono configurations also? And/or that the existing usage description for 8081 is inaccurate? If the latter, drafty suggested wording would be appreciated.", "created": "2018-12-03T11:20:00.000000" }, { "author": "557058:750ff3bd-7564-4d8a-b480-b500b85be583", "body": "Sorry for the slow reply.\n\n8081 is documented for connections from compilers \u2192 master of masters. It should additionally be documented for end user \u2192 master of masters.\n\nI notice that I've used 4433 \u2014 console services API \u2014 to get RBAC tokens. That should be available to end users as well. That would go to the master of masters.\n\nI've also used the 8140 port, but I'm not sure if that's correct any more. I was trying to hit {{https://pe-mom1-prod.ops.puppetlabs.net:8140/puppet/v3/environments}}. That doesn't seem to be working for me right now, but that might be a permissions issue on my end.\n\nAlso, the Code Manager port (8170) isn't documented here at all. That needs to be exposed to the Internet, or at least where ever your git repos are hosted. It definitely should be available to end users so that they can get status information about their deploys.\n\nSo, the diagrams should be updated with a TCP-8081, a TCP-4433, TCP-8170, and _maybe_ a TCP-8140 arrow from end user to master of masters along side the TCP-443 arrow. There should be an arrow from \u201cThe Internet\u201d to the master of masters for TCP-8170.\n\nTCP-8170 needs documentation. It's listed at the bottom of the page, but it seems odd that it's not listed with other first-class services like PuppetDB.\n\nThe table for most of those ports should have something like \u201cEnd users use this port for API calls.\u201d Something more specific would be nice, but I'm not sure what all it would be. For example, 4433 is used for RBAC, but I image end users might use it for other things too.\n\nSorry to expand the scope on this so much!", "created": "2018-12-06T17:11:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Sorry to hear you're leaving, Daniel. :( Hope it's a great change for you. \n\nI just looked at this ticket yesterday and concluded that it would be easiest to make these changes for our next major PE release, when we need to update some infrastructure terminology anyway. I've updated this ticket description summarizing the changes you've suggested. Would you look it over and see if I've captured everything accurately? \n\nOne question I have: you say \"InfraCore recommends running [comms to PDB on 8081] through the load balancer to the PuppetDB host (for consistency), but the PE/PuppetDB teams may feel otherwise.\" I'm not sure how that would look in the diagram. It'd be super helpful if you have a chance to grab a screen shot of the diagram and annotate it with what you mean. ", "created": "2019-01-18T07:35:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:750ff3bd-7564-4d8a-b480-b500b85be583] Have you had a chance to review the updated ticket description here?", "created": "2019-01-29T09:35:00.000000" }, { "author": "557058:750ff3bd-7564-4d8a-b480-b500b85be583", "body": "Sorry I missed this! I'll try to get to this today, but after that I won't have access to this ticket. You might be able to make an exception for my community account: danielparks.", "created": "2019-01-31T10:22:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "I'll just move this to our external Docs project, DOCUMENT. I don't think there's any secret info here...\n\nUpdate: This is now DOCUMENT-975 and you should be able to view it externally [~accountid:557058:750ff3bd-7564-4d8a-b480-b500b85be583].", "created": "2019-01-31T10:30:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:999854:e4347c29-7a79-4d78-92e0-2e945203bd93] I'd like to file a UX ticket asap to get these diagrams updated. Can you glance at the updated ticket description and let me know if I've captured your concerns there?", "created": "2019-02-12T10:13:00.000000" }, { "author": "999854:e4347c29-7a79-4d78-92e0-2e945203bd93", "body": "Yup, that looks good! Sorry for the delay.", "created": "2019-02-15T11:04:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Waiting on UXD-918.", "created": "2019-02-15T13:22:00.000000" } ], "components": [], "created": "2018-11-28T16:00:00.000000", "creator": "557058:750ff3bd-7564-4d8a-b480-b500b85be583", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1205b692" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzresv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_414699882_*|*_3_*:*_1_*:*_80205957_*|*_5_*:*_1_*:*_0_*|*_10022_*:*_1_*:*_3111_*|*_10010_*:*_1_*:*_232289_*|*_10004_*:*_3_*:*_6579595547_*|*_10005_*:*_3_*:*_4317823751" } ], "description": "To all diagrams (mono, mono+CM, mono+CM+PGSQL) add:\n* TCP-8081, TCP-4433, TCP-8170, and [maybe?] TCP-8140 from end user to master along side the TCP-443 arrow. \n* TCP-8170 from the internet to the master.\n\nFor all tables, verify that the ports above are included. At the least, they should say \"End users use this port for API calls.\" Ideally, find out what API service uses each port.\n* 8081 - PuppetDB API\n* 4433 - Node classifier API\n* 8170 - Code Manager API\n* 8140 - Status API\n\nFor all tables, incorporate content from \"Port usage for all installation types\".\n\n--------- original ticket description below --------- \n\nThe [System configuration|https://puppet.com/docs/pe/2019.0/system_configuration.html] page doesn't list port 8081 for PuppetDB API access. Clients use this to query PuppetDB from their laptops.\n\nInfraCore recommends running this through the load balancer to the PuppetDB host (for consistency), but the PE/PuppetDB teams may feel otherwise.\n\nThe [PuppetDB: Query structure|https://puppet.com/docs/puppetdb/6.0/api/query/v4/query.html#query-structure] page documents that PuppetDB API access runs on port 8081. (It also runs on 8080, but that's unencrypted and people shouldn't use it.)\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54099", "fixedVersions": [], "id": "54099", "issueType": "Improvement", "key": "DOCUMENT-975", "labels": [ "graphics", "kearney", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:750ff3bd-7564-4d8a-b480-b500b85be583", "resolution": "Fixed", "resolutionDate": "2019-04-09T13:36:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update port documentation", "timeSpent": "PT0S", "updated": "2019-04-09T13:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "created": "2018-11-27T23:57:00.000000", "name": "new_mono.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14237" }, { "attacher": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "created": "2018-11-27T23:56:00.000000", "name": "puppet_mono_arch.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14246" } ], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:f950b51f-34da-4ab4-974c-82e6f4989984] The page you link to is intended as an overview of PE configuration options and has never included port details. I think the diagrams and detail you're looking for are located here: https://puppet.com/docs/pe/2019.0/system_configuration.html", "created": "2018-12-03T11:14:00.000000" } ], "components": [], "created": "2018-11-27T23:58:00.000000", "creator": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ab620d1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzredb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "03/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_472278208_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_338042" } ], "description": "The PE architecture diagrams hosted at:\n\nhttps://puppet.com/docs/pe/2019.0/choosing_an_architecture.html\n(and for the previous 2018 version)\n\n...Used to contain port numbers and colourised traffic flows. This was useful information in order to explain to network teams the required connectivity.\n\nBad or missing network firewall rules are the number one cause of puppet errors in corporate environments so this information is critical in order to be able to plan deployments and explain firewall related errors.\n\n*Old Image*\n !puppet_mono_arch.png|thumbnail! \n\n*New Image*\n !new_mono.png|thumbnail! ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55106", "fixedVersions": [], "id": "55106", "issueType": "Bug", "key": "DOCUMENT-948", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:f950b51f-34da-4ab4-974c-82e6f4989984", "resolution": "Won't Fix", "resolutionDate": "2018-12-03T11:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "[regression] Please reinstate the port numbers on PE architecture diagrams", "timeSpent": "PT0S", "updated": "2018-12-03T11:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5b0340d43eafdb09dee5bc3a", "attachments": [], "comments": [ { "author": "5b0340d43eafdb09dee5bc3a", "body": "Thanks Ben, the link should work now. ", "created": "2018-12-11T12:21:00.000000" } ], "components": [], "created": "2018-11-26T13:32:00.000000", "creator": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@56dd875f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzrcmv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_596236525_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_695501308" } ], "description": "The {{cmd endpoint}} link at [https://puppet.com/docs/puppetdb/6.0/configure.html#node-purge-gc-batch-limit]\u00a0points to the old domain.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54998", "fixedVersions": [], "id": "54998", "issueType": "Bug", "key": "DOCUMENT-947", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ddaa4b87-3b61-49bb-98f9-56fd02cdbb6b", "resolution": "Fixed", "resolutionDate": "2018-12-11T12:21:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Link points to old domain", "timeSpent": "PT0S", "updated": "2018-12-11T12:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [ { "attacher": "557058:541540de-2539-4691-9a46-f7393ac3e39e", "created": "2018-11-16T14:19:00.000000", "name": "Screen Shot 2018-11-16 at 1.19.34 PM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14271" } ], "comments": [ { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Hello! Thanks for reporting this. It broke because the docs don't support upgrading from 3.x directly to 6.0, so we removed the upgrade docs that that was part of. However, the information seems relevant, so I'm going to make the link point to [the 5.5 version of that page|https://puppet.com/docs/puppet/5.5/whered_it_go.html], which still applies.\u00a0", "created": "2018-11-16T15:31:00.000000" } ], "components": [], "created": "2018-11-16T14:21:00.000000", "creator": "557058:541540de-2539-4691-9a46-f7393ac3e39e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "The link is updated to point to an existing document." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@599d24ad" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzr7y7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4251130_*|*_3_*:*_1_*:*_1624753_*|*_5_*:*_1_*:*_0" } ], "description": "Hi there!\n\nI was just reading through the 3.x -> 6\u00a0[upgrade doc|https://puppet.com/docs/puppet/6.0/lang_updating_manifests.html]\u00a0and found a broken link: [https://puppet.com/docs/puppet/6.0/whered_it_go.html]\n\n!Screen Shot 2018-11-16 at 1.19.34 PM.png!\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54209", "fixedVersions": [], "id": "54209", "issueType": "Bug", "key": "DOCUMENT-945", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:541540de-2539-4691-9a46-f7393ac3e39e", "resolution": "Fixed", "resolutionDate": "2018-11-16T15:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"Updating 3.0 -> 6\" doc has broken link to \"where everything went\"", "timeSpent": "PT0S", "updated": "2018-11-16T15:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for spotting. This will be updated with a new NTP code example in the next build.\u00a0\u00a0", "created": "2018-11-22T09:00:00.000000" } ], "components": [ "Style Guide & Usage" ], "created": "2018-11-16T09:09:00.000000", "creator": "623c0c0d761efb0069ce025b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@143ee460" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzr7kn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_266831637_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_251015501" } ], "description": "in the section [https://puppet.com/docs/puppet/5.5/style_guide.html#internal-organization-of-classes-and-defined-types] there is a link to: \"ntp\" [https://github.com/puppetlabs/puppetlabs-ntp/blob/3.3.0/manifests/init.pp#L28-L49]\n\nThis NTP code is old and in this place a bad example!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54750", "fixedVersions": [], "id": "54750", "issueType": "Bug", "key": "DOCUMENT-944", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0c0d761efb0069ce025b", "resolution": "Fixed", "resolutionDate": "2018-11-22T09:00:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "bad link in guide lines", "timeSpent": "PT0S", "updated": "2018-11-22T09:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This code example is correct, but I've added a note to make it clearer. The docs will be updated in the next build. Thanks!", "created": "2018-11-22T08:49:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1], Sorry, no, that example is broken - you are not allowed to make a call (to include) inside a resource expression. There is no way that is \"good\" - it does not compile.", "created": "2018-11-23T09:12:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd] Should it be like this?\n{code:java}class foo {\n include bar\n}\n{code}\n\u00a0", "created": "2018-11-23T09:36:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "The entire section is strange:\n{code}\nSeparating classes and defined types into separate files is functionally identical to declaring them in init.pp, but has the benefit of highlighting the structure of the module and making the function and structure more legible.\n\nWhen a resource or include statement is placed outside of a class, node definition, or defined type, it is included in all catalogs. This can have undesired effects and is not always easy to detect.\n\nGood: manifests/init.pp:\n# class foo\nclass { 'foo':\n include bar\n}\n# end of file\nBad: manifests/init.pp:\nclass { 'foo':\n #...\n}\ninclude bar\n{code}\nIt is not even showing examples of what the text is talking about.", "created": "2018-11-23T12:55:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] No, that is syntax error - not valid puppet code.", "created": "2018-11-23T12:56:00.000000" }, { "author": "557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd", "body": "From the text above the examples - I think they were supposed to be:\n\nGood: manifests/init.pp:\n{code}\n# class foo\nclass foo {\n include bar\n}\n# end of file\n{code}\n\nBad: manifests/init.pp:\n{code}\nclass foo {\n #...\n}\ninclude bar\n{code}\nSince that would illustrate what the text is talking about.", "created": "2018-11-23T15:42:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks! I have updated the docs with the correct code.\u00a0", "created": "2018-11-26T07:27:00.000000" } ], "components": [], "created": "2018-11-16T08:46:00.000000", "creator": "623c0c0d761efb0069ce025b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@24b60417" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzr7k7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "22/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_268284724_*|*_4_*:*_1_*:*_252925708_*|*_5_*:*_2_*:*_87801228_*|*_10005_*:*_1_*:*_250290944" } ], "description": "hello this code makes not much sense:\n{code:java}\nclass { 'foo':\n include bar\n}\n{code}\nI found it here: https://puppet.com/docs/puppet/5.5/style_guide.html#classes-and-defined-types", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54657", "fixedVersions": [], "id": "54657", "issueType": "Bug", "key": "DOCUMENT-943", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0c0d761efb0069ce025b", "resolution": "Fixed", "resolutionDate": "2018-11-26T07:27:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "style guide has wrong code example", "timeSpent": "PT0S", "updated": "2018-11-26T07:27:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Thanks for the ping on this ticket. I've pushed up a fix and it should be live on the next docs build.", "created": "2018-12-06T17:39:00.000000" } ], "components": [ "Facter" ], "created": "2018-11-16T04:58:00.000000", "creator": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@92d10ea" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "CS Priority", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Reviewed" }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzr7hz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Dec/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_281974939_*|*_5_*:*_1_*:*_3089909885_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1491634417" } ], "description": "The following documentation describes the file and data formats we can use for external facts:\n\n[https://puppet.com/docs/facter/3.9/custom_facts.html#structured-data-facts|https://puppet.com/docs/facter/3.12/custom_facts.html#structured-data-facts]\n\nIn practice if you use a file extension .txt you are limited to the \"string\" data type, for instance:\n\ntest_boolean_true=true\u00a0\n\nwill be interpreted as the string \"true\" not the boolean type \"true\"\n\nThis is not explicit in the documentation and caused some confusion to customers\n\nFor changes i propose that the following line:\n\n\u00a0\n\n{{'.txt}}: Key value pairs, in the following format:'\n\nbe changed to something that indicates the data type:\n\n{{'.txt}}: Key value pairs, of string\u00a0 data type, in the following format:'\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54656", "fixedVersions": [], "id": "54656", "issueType": "Improvement", "key": "DOCUMENT-942", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:59f72e60-2599-4fa1-a8b1-1d5a9ff792ca", "resolution": "Fixed", "resolutionDate": "2018-12-06T17:39:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Custom Facts .txt file extension clarification on data types.", "timeSpent": "PT0S", "updated": "2019-01-11T11:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [], "components": [ "Puppet Language" ], "created": "2018-11-15T18:06:00.000000", "creator": "623a4a598d8b9c0068b7e31a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@292845ca" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzr7fz:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_321148320_*|*_5_*:*_1_*:*_1892371885_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_2689130569" } ], "description": "[https://github.com/puppetlabs/puppet-docs/blob/master/source/puppet/6.0/lang_relationships.markdown] has an absolute link to 5.3 documentation:\n{quote}> Note: Most of the time, you should use relationship metaparameters, not chaining arrows. See the [Puppet Language Style Guide](https://puppet.com/docs/puppet/5.3/style_guide.html#chaining-arrow-syntax) for information on when and how to use chaining arrows.\n{quote}\nThat link also appears at the top of the file.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54207", "fixedVersions": [], "id": "54207", "issueType": "Bug", "key": "DOCUMENT-941", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a4a598d8b9c0068b7e31a", "resolution": "Fixed", "resolutionDate": "2018-12-20T14:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "6.0/lang_relationships.markdown links to 5.3 style guide", "timeSpent": "PT0S", "updated": "2019-01-11T11:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "70121:4084c786-3448-4ef8-8889-3c056e90bb64", "attachments": [], "comments": [], "components": [], "created": "2018-11-13T23:13:00.000000", "creator": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7f53e538" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzop53:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_140657062_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_22286462973" } ], "description": "We currently have [https://puppet.com/docs/pe/2018.1/config_java_args.html]\u00a0to configure java_args for PE services including PuppetDB. However, the steps do not work for PuppetDB service in Replica node as it is not classified under \"PE PuppetDB\" Node Group. That creates confusion as the Replica node should get the same setting as MoM.\n\nThis can be configured via Hiera or Data section in \"PE HA Replica\" node group, but we don't have such documentation for it.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54886", "fixedVersions": [], "id": "54886", "issueType": "Task", "key": "DOCUMENT-940", "labels": [ "ha", "pe" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:73641053-e19c-46a3-a060-6c9d43a6ed1a", "resolution": "Fixed", "resolutionDate": "2019-07-31T13:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add documentation to update java_args setting for HA Replica Node on Console UI", "timeSpent": "PT0S", "updated": "2019-07-31T13:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:520566be-dc64-492b-8de1-701eed347203", "attachments": [ { "attacher": "557058:35060490-aa27-40a2-b587-eca7672140c8", "created": "2018-10-31T09:47:00.000000", "name": "Screen Shot 2018-10-31 at 09.47.24.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14226" } ], "comments": [ { "author": "557058:520566be-dc64-492b-8de1-701eed347203", "body": "Thanks [~accountid:557058:35060490-aa27-40a2-b587-eca7672140c8]\u00a0\n\nDocumentation has now been updated:\u00a0https://puppet.com/docs/discovery/1.x/pd_requirements.html\u00a0\n\nFor reference, in the docs, we call out ingress.ipv6enabled config setting:\u00a0https://puppet.com/docs/discovery/1.x/pd_overrides.html", "created": "2018-11-01T05:12:00.000000" } ], "components": [], "created": "2018-10-31T09:48:00.000000", "creator": "557058:35060490-aa27-40a2-b587-eca7672140c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@340f5b64" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqwe7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_672599_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_508112072" } ], "description": "https://puppet.com/docs/discovery/1.x/pd_requirements.html#install-discovery\n\nThe table indicates a number of operating systems upon which one can install Puppet Discovery. In the far right, it indicates that a pre-requisite for all of them is IPv6 being enabled.\n\nThis would indicate that Discovery cannot be installed on a host that has IPv6 disabled, or that features would somehow be limited in a way not described on the page. \n\nI understand from my conversations with Discovery developers that IPv6 is not a requirement, therefore I suggest we clarify this in some other way. Perhaps \"IPv6 enabled on the environment.\" could be removed from each entry into the table and a sentence added, such as \"IPv6 must be enabled in the environment to use IPv6 features of Puppet Discovery\" or something like that?", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54205", "fixedVersions": [], "id": "54205", "issueType": "Improvement", "key": "DOCUMENT-938", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:35060490-aa27-40a2-b587-eca7672140c8", "resolution": "Fixed", "resolutionDate": "2018-11-06T06:08:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Discovery Installation process implies IPv6 is required", "timeSpent": "PT0S", "updated": "2018-11-06T06:08:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Thanks for spotting! This is now fixed.\u00a0", "created": "2018-11-05T07:26:00.000000" } ], "components": [ "Hiera" ], "created": "2018-10-31T07:17:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@63b30aee" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqwbr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "05/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_436142471_*|*_5_*:*_1_*:*_0" } ], "description": "The Hiera docs contain an example of configuring a hierarchy level, a bit below https://puppet.com/docs/puppet/6.0/hiera_config_yaml_5.html#specifying-file-paths. It contains what appears to be the literal text of some formatting tags {% raw %} and {% endraw %}. It's not such a big deal, except that it may mislead people who are not already familiar with Hiera into thinking that such tags should actually appear in their Hiera config files.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55105", "fixedVersions": [], "id": "55105", "issueType": "Bug", "key": "DOCUMENT-937", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Fixed", "resolutionDate": "2018-11-05T07:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Incorrect formatting of an example in Hiera docs", "timeSpent": "PT0S", "updated": "2018-11-05T07:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This will be updated in the next build.", "created": "2018-11-07T10:58:00.000000" } ], "components": [], "created": "2018-10-29T14:56:00.000000", "creator": "557058:ecdbe9d7-fd31-4136-80ae-15ac851f87fc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@484897f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzquvb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "07/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_594750435_*|*_10009_*:*_1_*:*_364143_*|*_3_*:*_1_*:*_22991200_*|*_5_*:*_2_*:*_169186139_*|*_10005_*:*_1_*:*_148835483" } ], "description": "SERVER-2130 suggests that `compile-mode` defaults to JIT for puppetserver 5.3.0 and above\u00a0 (which matches what the changelog shows; [https://puppet.com/docs/puppetserver/5.3/release_notes.html#puppet-server-530]\u00a0)\n\nHowever, in the 5.3 documentation, `compile-mode` is still listed as experimental, and apparently defaults to off? [https://puppet.com/docs/puppetserver/5.3/config_file_puppetserver.html]\n\nCan you update the documentation to indicate this is on by default (if that's the case), and suggest that it's recommended and not experimental?\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54608", "fixedVersions": [], "id": "54608", "issueType": "Bug", "key": "DOCUMENT-936", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ecdbe9d7-fd31-4136-80ae-15ac851f87fc", "resolution": "Fixed", "resolutionDate": "2018-11-07T10:58:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation around compile-mode is confusing", "timeSpent": "PT0S", "updated": "2018-11-09T09:58:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It looks like this just wasn't removed from the ToC in our CMS. I've removed it and think it will be gone on the next doc build. Marking it as ready for review to remind me to double check that it's gone.", "created": "2018-10-30T14:10:00.000000" } ], "components": [], "created": "2018-10-29T13:43:00.000000", "creator": "557058:3bbf1c83-df0e-4372-887d-cfc38dee9330", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7de40842" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hymb3r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_87988994_*|*_3_*:*_1_*:*_60313_*|*_10009_*:*_1_*:*_11934470_*|*_5_*:*_1_*:*_6290851991_*|*_6_*:*_1_*:*_0" } ], "description": "\nAs reported by [~accountid:557058:263afade-3e4f-46c6-b50a-cf2982192562] in PUP-7601: \n\n{quote}If you open up the tree on the left in https://puppet.com/docs/puppet/6.0/puppet_index.html there is an \"Extensions for assigning classes to nodes\" with a \"The LDAP node classifier\" underneath that has a dead link to https://puppet.com/docs/puppet/6.0/nodes_ldap.html\n{quote}\n\n*In scope:*\nUpdate the puppet 6.0 navigation tree to remove the dead link", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54655", "fixedVersions": [], "id": "54655", "issueType": "Task", "key": "DOCUMENT-935", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3bbf1c83-df0e-4372-887d-cfc38dee9330", "resolution": "Fixed", "resolutionDate": "2018-10-30T17:29:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Remove dead link related to Puppet 6.0 removal of LDAP node terminus", "timeSpent": "PT0S", "updated": "2019-01-11T11:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:79f2fdd6-baee-43c4-91af-c7e647173c95", "body": "The ability to remove mcollective with the absent command was added as part of PE-23939, in PE 2018.1.1.", "created": "2018-10-17T11:35:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This duplicates DOC-3791, which I have in my backlog. I'll make needed updates by the end of this week. Thanks for calling it to my attention, [~accountid:557058:97a3d564-f045-44ef-b504-f23937482ee5]", "created": "2018-10-17T11:43:00.000000" } ], "components": [ "PE" ], "created": "2018-10-17T10:56:00.000000", "creator": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@70521278" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqljz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1368715_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1430279" } ], "description": "[https://puppet.com/docs/pe/2019.0/upgrading_pe.html#task-2354]\u00a0 shows setting the mcollective\u00a0parameter to absent, but this wasn't present in 2018.1.0 when I was upgrading my demo environment.\u00a0 I'm not sure which .z version added it, but 2018.1.4 ran smoothly.\n\nIn general, I also had difficulty finding the steps for the .z upgrade.", "duedate": "2018-12-01T00:00:00.000000", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54391", "fixedVersions": [], "id": "54391", "issueType": "Improvement", "key": "DOCUMENT-932", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:97a3d564-f045-44ef-b504-f23937482ee5", "resolution": "Duplicate", "resolutionDate": "2018-10-17T11:43:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update upgrade requirements to be more specific on which .z version", "timeSpent": "PT0S", "updated": "2018-10-17T11:43:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] I'll adjust the wording of this. If you could provide more detail on what the pros and cons of each style are (with examples), that would be great, thanks!", "created": "2018-10-17T04:24:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Thanks [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1], I'll work on some draft language and then we can gather feedback from some other teams and the community on the proposed change.", "created": "2018-10-17T13:23:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] Sounds great! Keep me posted. Thanks!", "created": "2018-10-18T03:19:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "I've commented on the original pdk-planning thread, and can update the proposal with the new state, if required.", "created": "2018-10-19T02:44:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] I wrote up a draft proposal for updated language with the two options here:\u00a0\n\n[https://docs.google.com/document/d/1oIzh4FAzwVOn7BIWEFDAGxHnucaxv0I18J9j4tsVLwo/edit?usp=sharing]\n\nThe doc is open to commenting for anyone with the link (not just @puppet.com people), so once we are satisfied with the initial language we can circulate more widely for comment.", "created": "2018-10-19T11:51:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] Thanks! I made a few suggestions.\u00a0", "created": "2018-10-24T09:21:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Thanks [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1], I accepted/responded in the doc.", "created": "2018-10-25T14:03:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Great, thanks [~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7]! Happy with the wording if we want to start sharing it with others?", "created": "2018-10-29T05:25:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "Thanks Claire! I'll work with community to circulate the proposal and see what feedback we get. :)", "created": "2018-10-29T15:30:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:ad2090d1-8a61-4530-9228-7d89570c23b7] [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02] [~accountid:557058:80b1a2d0-6c75-4995-bdc3-c422bab7aabd]\u00a0Is there anyone else you want to take a look at this or are you happy with the doc? If so I can update the style guide. Thanks!\u00a0\n\n(https://docs.google.com/document/d/1oIzh4FAzwVOn7BIWEFDAGxHnucaxv0I18J9j4tsVLwo/edit)", "created": "2018-11-28T08:17:00.000000" }, { "author": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "body": "I'm\u00a0(y)", "created": "2018-11-28T12:38:00.000000" }, { "author": "557058:68216498-c6bf-4e8f-92c1-ac84887b7c02", "body": "make it happen. Thanks!", "created": "2018-11-29T03:48:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs updated:\u00a0https://puppet.com/docs/puppet/6.0/style_guide.html#quoting", "created": "2018-12-04T07:18:00.000000" } ], "components": [], "created": "2018-10-16T17:39:00.000000", "creator": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2d29b987" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hykrhz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_27392268_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4172546609" } ], "description": "(See renewed discussion here: [https://github.com/puppetlabs/pdk-planning/issues/17])\n\nPreferred quoting style is something that has evolved over time in the community. See also previous discussion in https://puppet.atlassian.net/browse/DOCUMENT-274\n\nI would like to propose that the official style guide recommendation be something more along the lines of \"pick a quoting style and use it consistently\" and maybe list some of the pros and cons and usage examples of each style.\n\nI also think it would be perfectly fine for us to still have a suggestion of which style to use, but the current language of \"All strings must be enclosed in single quotes, with some exceptions.\" is inflexible.\n\nWe could potentially update the puppet-lint check to detect inconsistent quoting style, at least in the scope of a single file/manifest. It may be more difficult to ensure consistent style across multiple files.\n\ncc: [~accountid:557058:c737f20a-b831-4320-b376-844fe0567ee8] [~accountid:557058:9524215b-1a7d-407b-b7d2-e020f3970c4d] [~accountid:557058:68216498-c6bf-4e8f-92c1-ac84887b7c02]\n\n\u00a0\n\nCurrent recommendation can be found here:\u00a0[https://puppet.com/docs/puppet/6.0/style_guide.html#quoting]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54097", "fixedVersions": [], "id": "54097", "issueType": "Task", "key": "DOCUMENT-931", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ad2090d1-8a61-4530-9228-7d89570c23b7", "resolution": "Fixed", "resolutionDate": "2018-12-04T07:18:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Proposal: Update Puppet language style guide to allow either quoting style", "timeSpent": "PT0S", "updated": "2018-12-04T07:18:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "The docs will be updated with this in the next build.\u00a0", "created": "2018-10-25T09:36:00.000000" } ], "components": [], "created": "2018-10-15T14:14:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@c3238bf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqjdr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "25/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_678911448_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_168405051" } ], "description": "Seemingly the `Puppet master config` command no longer exists this is a side note in the release notes [https://puppet.com/docs/puppet/6.0/release_notes.html#puppet-600]. under the following:\n{code}\u00a0Webrick support (previous deprecated) has been removed. This means that the puppet master command no longer exists. To run Puppet as a server you must use puppetserver. (PUP-8591){code}\nCan this be made more clear and called out in it's own line, as well as clarification that all it's supported sub commands are removed too, something that directs users to the puppet config command for config print/set would be useful ([https://puppet.com/docs/puppet/6.0/config_set.html]. and [https://puppet.com/docs/puppet/6.0/man/config.html] and or [https://puppet.com/docs/puppet/6.0/config_set.html]).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54997", "fixedVersions": [], "id": "54997", "issueType": "Improvement", "key": "DOCUMENT-929", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Fixed", "resolutionDate": "2018-10-25T09:36:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Changes to Puppet Master command have not been clearly captured in release notes or documented.", "timeSpent": "PT0S", "updated": "2018-10-25T09:36:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thanks, [~accountid:557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320]. Can you and/or [~accountid:557058:321c682e-6f37-4ab1-b708-223300ad29da] help me to narrow down what regex would be most helpful to provide in the docs? For instance, what are some situations users might be likely to encounter when using these parameters, and what regex they should use to handle them?\u00a0", "created": "2018-10-11T12:13:00.000000" }, { "author": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "body": "Honestly, I don't know too much about what's legal, which was a big reason I opened the ticket. [~accountid:557058:321c682e-6f37-4ab1-b708-223300ad29da] does the code implement a subset of LPeg or is the full library valid?\n\nWe had a customer open a ticket that prompted this one, in it we were having difficulty restricting PkgInclude to just the folder that we wanted, as it was pattern matching others. From that ticket, my random list of things that would be nice to have clarification on is:\n\n1. You can anchor a relative path with forward slash (this might be poor word choice on my part, and it's not in our current documentation), but not dot-forward slash (./) - if dot-forward slash does something I'd like to know what. Without the forward slash we'll descend into directories to search for the path set here. We may touch on part of this with the \"Include all files, but no subdirectories from subdirectory \"temp'\" example, but in my mind that's a very subtle allusion, as it involves noticing that temp is described as a subdirectory and using that to imply that the search will descend into subfolders and match them in order to return results.\n\n2. Matches are greedy, in that if the pattern matches multiple options it won't pick one but instead capture them all. We saw this in the ticket specifically, where three folders had a file with the same name in it and very similar paths, and all three files where being captured, which was not desired. The issue was exacerbated by using the array to move the file to a different location, causing all three files to be written out to the same location and overwrite each other. More concretely, if you set PkgInclude to [\"dir/example.txt\",\"foo\"] and you have a/dir/example.txt, b/dir/example.txt and dir/example.txt the final package will have a folder called foo with a file called example.txt, but the file from all three folders is collected and written over the top of itself to get the final result.\n\n3. If it is possible to do an absolute path, how?\n\nSome other questions I have after staring at the doc for a really long time:\n\n4. For this example: [\"dir/to/File.war\",\".\"] the description says \"Include a war file, but move it to the root of the tarball\"", "created": "2018-10-11T16:11:00.000000" }, { "author": "557058:321c682e-6f37-4ab1-b708-223300ad29da", "body": "The inclusion rules adhere to this document:\n\nhttps://ant.apache.org/manual/dirtasks.html#patterns\n\nUltimately, all of this came from the original Python implementation:\n\nhttps://pypi.org/project/formic/\n\nNote that the \"array\" syntax of PkgInclude simply allows one to match a set of files that are all placed into a single directory. For example, if you have files in the build/** subdirectory such as build/subdir/a.txt and build/b.txt, you can only \"flat map\" them into a directory. Specifically:\n\nPkgInclude:\n - [\"build/\", \"dest/\"]\n\nWith files build/subdir/a.txt and build/b.txt would result in:\n\ndest/a.txt\ndest/b.txt\n\n...and there is NO WAY to map them into:\n\ndest/subdir/a.txt\ndest/b.txt\n\n...without defining multiple mapping rules (note that ORDERING IS IMPORTANT!):\n\nPkgInclude:\n - [\"build/subdir/\", \"dest/subdir\"]\n - [\"build/\", \"dest\"]\n\nSome other notes about this mapping syntax:\n\n * The destination subdirectory can contain a slash at the end (or not).\n * The destination subdirectory can contain a slash at the start (or not).\n * Globbing patterns don't exist for the destination subdirectory. This is literally the location all files that match the pattern will be placed into.\n\nHowever, the patterns are different (first element of the mapping syntax):\n\n * A pattern that does NOT begin with \"/\" is exactly the same as \"**/\" prefixed.\n * A pattern that DOES end with \"/\" is exactly the same as \"/**\" postfix.\n\nI know this is all very confusing to me too :(. I'd be a fan of adopting the more flexible and intuitive approach that rsync patterns have:\n\nhttps://download.samba.org/pub/rsync/rsync.html (search for \"INCLUDE/EXCLUDE PATTERN RULES\")\n\n...but all of this was done to preserve backwards compatibility with the original python CLI.", "created": "2018-10-12T10:44:00.000000" }, { "author": "557058:321c682e-6f37-4ab1-b708-223300ad29da", "body": "[~accountid:557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320] Here are answers to your questions:\n\n\"\"\"does the code implement a subset of LPeg or is the full library valid?\"\"\"\n\nThe code is implemented USING LPeg, it doesn't \"implement\" LPeg.\n\n\"\"\"\n1. You can anchor a relative path with forward slash (this might be poor word choice on my part, and it's not in our current documentation), but not dot-forward slash (./) - if dot-forward slash does something I'd like to know what. Without the forward slash we'll descend into directories to search for the path set here. We may touch on part of this with the \"Include all files, but no subdirectories from subdirectory \"temp'\" example, but in my mind that's a very subtle allusion, as it involves noticing that temp is described as a subdirectory and using that to imply that the search will descend into subfolders and match them in order to return results.\n\"\"\"\n\nAll of these are equivalent patterns:\n\n lib/\n ./lib/\n **/lib/\n\nConclusion: Unless the pattern begins with \"/\", the pattern matches subdirectories on the left hand side of the pattern.\n\n\"\"\"\n3. If it is possible to do an absolute path, how?\n\"\"\"\n\nBegin the path with \"/\" and do NOT end it with a \"/\" (if a pattern ends with \"/\" it matches directories recursively.\n\n\"\"\"\n4. For this example: [\"dir/to/File.war\",\".\"] the description says \"Include a war file, but move it to the root of the tarball\"", "created": "2018-10-15T08:13:00.000000" } ], "components": [], "created": "2018-10-11T10:19:00.000000", "creator": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@97e83f6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqftb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_5208982_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_10710002743_*|*_10005_*:*_2_*:*_32236410340" } ], "description": "The documentation for PkgInclude (https://puppet.com/docs/pipelines-for-apps/enterprise/manifest-build.html#pkginclude) contains a couple examples about using this parameter, but it doesn't provide much detail beyond these handful of examples, which means it's really difficult to configure anything more complex than one of these examples or \"*\".\n\nIt would be great if we could expand this section to provide a clearer reference for the regex that can be used to configure different PkgInclude/Exclude parameters.\n\nThe PkgInclude parameter is based on this code: https://github.com/puppetlabs/DTK/blob/master/app/core/file_mapper.lua\n\nWhich in turn is based on LPEG: http://www.inf.puc-rio.br/~roberto/lpeg/\n\nWhich in turn is pattern matching library for Lua: https://www.lua.org/manual/5.2/manual.html#6.4.1", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54995", "fixedVersions": [], "id": "54995", "issueType": "Improvement", "key": "DOCUMENT-927", "labels": [ "pipelines" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "resolution": "Won't Fix", "resolutionDate": "2020-02-20T12:19:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Pipelines: PkgInclude/PkgExclude need more detail about pattern matching", "timeSpent": "PT0S", "updated": "2020-02-20T12:19:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Claire and I are working with the server team to fix the issues, since it's a blocker for users.\u00a0", "created": "2018-10-10T14:15:00.000000" } ], "components": [], "created": "2018-10-09T14:40:00.000000", "creator": "557058:c241032a-c552-4408-9a96-dcd5a643ff69", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3376c6c1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "Epic Color", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-color", "value": "ghx-label-2" }, { "fieldName": "Epic Name", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-label", "value": "Overhaul Puppet Server CA docs" }, { "fieldName": "Epic Status", "fieldType": "com.pyxis.greenhopper.jira:gh-epic-status", "value": "To Do" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "Issue color", "fieldType": "com.pyxis.greenhopper.jira:jsw-issue-color", "value": "dark_yellow" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqebb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_84015732_*|*_3_*:*_1_*:*_144638813241_*|*_4_*:*_1_*:*_1278668585_*|*_6_*:*_2_*:*_753147" } ], "description": "We need to do an audit and major update of all of the many scattered CA docs. Some of these haven't been updated since Puppet 4 and are quite out of date, particularly in light of all the CA revamping work that went into Puppet 6 and will be continuing in Puppet 7.\n\nWe should consider adding a dedicated CA landing page with brief summaries of the high-level concepts and clear links to more detailed relevant docs.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54654", "fixedVersions": [], "id": "54654", "issueType": "Epic", "key": "DOCUMENT-925", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:c241032a-c552-4408-9a96-dcd5a643ff69", "resolution": "Done", "resolutionDate": "2023-05-26T10:51:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "26/May/23 10:51 AM", "summary": "Overhaul Puppet Server CA docs", "timeSpent": "PT0S", "updated": "2023-05-26T10:51:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [ { "attacher": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "created": "2018-12-12T15:24:00.000000", "name": "tables.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14247" } ], "comments": [ { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "We should add\u00a0{{reserved_code_cache}} to\u00a0the table in tuning_monolithic2.html.\n\nWe should document it has a limit, based upon this user-submitted error message:\n\n{code:java}\npuppet puppetserver: Invalid ReservedCodeCacheSize=3072M. Must be at most 2048M\n{code}\n\n(See also: http://mail.openjdk.java.net/pipermail/hotspot-compiler-dev/2013-October/012161.html)\n\nDone: Addressed via PE-25321", "created": "2018-10-10T10:13:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Since tuning_monolithic includes compile masters, we could provide the same 4/8/16 table for them.\n\nDone: Addressed in Description of this ticket.", "created": "2018-10-10T15:14:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "2019.x includes PuppetDB 6.0 which no longer include\u00a0(PuppetDB broker memory) memory-usage:\n\nhttps://puppet.com/docs/pe/2019.0/component_versions_in_recent_pe_releases.html\nhttps://github.com/puppetlabs/puppetdb/blob/6.0.x/documentation/release_notes.markdown#upgrading\nhttps://github.com/puppetlabs/puppetdb/blob/6.0.x/test/puppetlabs/puppetdb/config_test.clj#L45\n\nIf true, the PuppetDB broker memory column should be removed from tuning_monolithic2, and the totals updated.\n\nHere is a proposed (WIP) table for 2018.x and 2019.x: \n\nhttps://docs.google.com/spreadsheets/d/1n2Z25bSTXlt_zDIhZYUCfYMMSrfWISO01F9JZps3KoY/edit?usp=sharing\n\n[~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100] ?\n\nDone: Addressed in Description of this ticket.", "created": "2018-10-11T09:29:00.000000" }, { "author": "557058:6fc1f430-f771-4686-a97e-21c5e35f9100", "body": "broker memory was removed when stockpile came along ", "created": "2018-10-11T10:54:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "But the documentation is still \"broker\" \ud83d\ude06", "created": "2018-10-11T11:18:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Other potential items:\n\nAdd Hiera keys to: https://puppet.com/docs/pe/2019.0/config_java_args.html (really, provide Console and Hiera instructions everywhere we document settings).\n\nReconcile and update https://puppet.com/docs/pe/latest/config_puppetserver.html with https://puppet.com/docs/puppetserver/latest/tuning_guide.html\n\nMove Config Database documentation from the Config Console document: https://puppet.com/docs/pe/latest/console_config.html#tuning-the-postgresql-buffer-pool-size to a new Config Database document: https://puppet.com/docs/pe/latest/database_config.html\n\nDone. These could/should be another ticket.", "created": "2018-10-12T11:06:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] The PRs for the `puppet infra tune` action have been merged into Irving/Johnson/Kearney, and I think the Google docs and sheets are ready for review. Could we work on this in time for the upcoming release(s)?", "created": "2018-12-04T16:14:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] Thanks for all of this detail. As you might know, we're fairly short-handed in Docs right now, so I apologize for the delay on this. \n\nWould you mind updating the ticket description with a numbered list of the changes mentioned here, including those tacked on in comments? This ticket has gotten fairly unwieldy and I don't want to miss anything. Thanks!", "created": "2018-12-06T09:32:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] I did not know, sorry. I've moved all the actionable items to the Description.", "created": "2018-12-06T14:17:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "1. Done in 2019+\n2. Done in 2019+. I'm assuming the GB notation in the Puppet Server line is an error and it should be MB.\n5. Done in 2019+\n\n[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] For 3 & 4, the tables in your spreadsheet contain more columns than we currently have documented. Are you proposing adding the extra columns to docs, or should I just update numbers for the existing columns?\n\nI'm also not totally clear what you mean by \"Since tuning_monolithic* references compile masters, we could provide the same 4/8/16 table for them.\" Can you elaborate?\n", "created": "2018-12-10T09:21:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "2: Yes, that GB notation should be MB, thanks.\n\n3 and 4: I propose we add columns, for two reasons: the additional columns define the footprint of tuning, and they contribute to the Totals column(s) ... and tuning includes CPU in addition to RAM and the CPU Totals make visible the need to not over-allocate CPU via JRubies and Command Processing Threads.\n\nCompile Masters: on this, I am looking for other opinions [~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100]? In my opinion, the tables reference \"Monolithic plus Compile Masters\" yet the document itself quietly fails to elaborate. I feel that a table for\u00a0Compile Masters is reasonable and helps clarify the dynamic (cpu vs ram) of tuning PuppetServer, and\u00a0Compile Masters are the preferred method for scaling Puppet Enterprise (instead of scaling via a Split Infrastructure) so adding that table covers all but the most exotic infrastructures.", "created": "2018-12-10T10:09:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "3 & 4 are now up on the preview server: \n\n* http://docs-internal.puppet.com/docs/pe/2018.1.z/tuning_monolithic.html\n* http://docs-internal.puppet.com/docs/pe/2019.0.z/tuning_monolithic.html\n\n[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] Let me know if everything looks good and I'll push this to production. ", "created": "2018-12-12T13:29:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Looks good!\n\n\u00a0\n\nCould we ...\n\n\u00a0\n\n1.\nChange all \"hardware requirements\" to \"system requirements\" ... except the link to hardware_requirements.html\n (\"hardware\" sounds out-of-date in a virtualized server world)\n\n\u00a0\n2.\nStart a new paragraph before \"Optimized settings vary ...\"\n\n\u00a0\n3.\nAdd a reference to include the optional replica master in:\n \"Master tuning\"\n \"These are the default and recommended tuning settings for your master or, if you use compile masters, your master of masters (MoM).\"\n\n\u00a0\n4.\nCenter and group the spanned column headers, such as \"Puppet Server\", in the tables:\n (see the boxes in the attached image for grouping, but not style)\n\n\u00a0\n5.\nEither delete the \"Default\" -> \"Memory per JRuby (MB)\" cell in the tables, or just delete the Memory per JRuby (MB) row.\n (memory per jruby isn't a setting per se, but is part of the calculation)\n (see red lines in the attached image)\n\n\u00a0\n6.\nClarify that you must run the command on the master, not a compile master and not a replica master:\n When you run puppet infrastructure tune on your master ...\"\n\n\u00a0\n7.\nMove \"Related information\" to the bottom of the page?\n\n\u00a0\n\n!tables.png!", "created": "2018-12-12T15:27:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "1. Done\n2. Done\n3. Done\n4. These are website CSS limitations/issues. I'll file separate tickets.\n5. I went with deleting the whole column, because the table is already too wide for the page.\n6. Added details to the paragraph about compatible infrastructures.\n7. Related links are associated with specific topics, not pages. In this case, I think it makes sense to associate those links with the overview. (I could also see a case for associating them with master tuning, but that would break up the tuning tables.)", "created": "2018-12-13T08:41:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Created WEB-3425 and DIP-117 to address the table formatting issues. ", "created": "2018-12-13T08:58:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "All good! I see all of these updated one on of the two documents and assume both will be synced.\n\nThanks so much!", "created": "2018-12-13T09:14:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Changes are live in production now. ", "created": "2018-12-13T09:53:00.000000" } ], "components": [], "created": "2018-10-09T11:57:00.000000", "creator": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3e8be0b0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqe5b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_92661002_*|*_3_*:*_1_*:*_187714816_*|*_10009_*:*_1_*:*_73428749_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_5258340540" } ], "description": "The following documents have minor issues and variations:\n\n*1)*\n\n[https://puppet.com/docs/pe/2019.0/hardware_requirements.html#hardware-requirements]\n\nMinimum hardware for compile masters should be 4/8 not 4/16. Even if you allocate 2 MB per JRuby (the default is 512 MB) a 4 core Compile Master would only require 6 MB of RAM for the Puppet Server service, and 8 MB would provide for that and overhead.\u00a0\n\n*Change*\u00a0\n|Each compile master (1500 - 3000 nodes)|4|16|\n\n*To*\n|Each compile master (1500 - 3000 nodes)|4|8|\n\n*2)*\n\n[https://puppet.com/docs/pe/2019.0/config_java_args.html]\n\nThe orchestration-services New Heap Size should be 768 MB not 1000 MB: 1000 MB is the only non-power-of-two number and higher than the highest value in tuning_monolithic. Or, all of the services new heap sizes could be consistent with one line from tuning_monolithic.\n\n*Change*\n||Service||Default heap size||New heap size||JSON string||\n|pe-console-services|256 MB|512 MB|{\"Xmx\": \"512m\", \"Xms\": \"512m\"}|\n|Puppet Server|2 GB|4 GB|{\"Xmx\": \"4096m\", \"Xms\": \"4096m\"}|\n|orchestration-services|192 MB|1000 MB|{\"Xmx\": \"1000m\", \"Xms\": \"1000m\"}|\n|PuppetDB|256 MB|512 MB|{\"Xmx\": \"512m\", \"Xms\": \"512m\"}|\n\n*To*\n||Service||Default heap size||New heap size||JSON string||\n|pe-console-services|256 MB|768 MB|{\"Xmx\": \"768m\", \"Xms\": \"768m\"}|\n|Puppet Server|2048 GB|3840 GB|{\"Xmx\": \"3840m\", \"Xms\": \"3840m\"}|\n|orchestration-services|192 MB|768 MB|{\"Xmx\": \"768m\", \"Xms\": \"768m\"}|\n|PuppetDB|256 MB|1024 MB|{\"Xmx\": \"1024m\" , \"Xms\": \"1024m\"}|\n\n*3)*\n\n[https://puppet.com/docs/pe/2018.1/tuning_monolithic.html]\n\nThe numbers are out of date.\n\n*Change*\n\nSee the \"Monolithic Master 2018.x\" sheet in\u00a0[https://docs.google.com/spreadsheets/d/1n2Z25bSTXlt_zDIhZYUCfYMMSrfWISO01F9JZps3KoY/edit#gid=0]\n\n*4)*\n\n[https://puppet.com/docs/pe/2019.0/tuning_monolithic2.html]\n\nIn 2019, the ActiveMQ Heap column was removed but the Total Fixed Memory Usage column was not updated ... and the Total Fixed Memory Usage column does not account for other configuration settings (for PostgreSQL) that allocate memory and so could be misleading and should be documented.\n\n*Change*\n\nSee the \"Monolithic Master 2019.x\" sheet in\u00a0[https://docs.google.com/spreadsheets/d/1n2Z25bSTXlt_zDIhZYUCfYMMSrfWISO01F9JZps3KoY/edit#gid=0]\n\nSince tuning_monolithic* references compile masters, we could provide the same 4/8/16 table for them.\n\n*Add*\n\nSee the \"Compile Masters\" sheet in\n [https://docs.google.com/spreadsheets/d/1n2Z25bSTXlt_zDIhZYUCfYMMSrfWISO01F9JZps3KoY/edit#gid=533966536]\n\n*Add*\n\n[https://docs.google.com/document/d/1la6G3ZmZRygr60soyLNWxuq970ZdvqCC4yHF52NNpGo/edit#gid=0]\n\n*5)*\n\n[https://puppet.com/docs/pe/2019.0/config_console.html#tuning-the-postgresql-buffer-pool-size]\n\nThe defaultis a range and subject to change.\n\n*Change*\n||Parameter||Value||\n|shared_buffers|Set at about 25 percent of your hardware's RAM.|\n|work_mem|In large or complex deployments, increase the value from the default 1MB.|\n\n*To*\n||Parameter||Value||\n|shared_buffers|Set at about 25 percent of your hardware's RAM.|\n|work_mem|In large or complex deployments, increase the value from the default.|", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54095", "fixedVersions": [], "id": "54095", "issueType": "Improvement", "key": "DOCUMENT-924", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "resolution": "Fixed", "resolutionDate": "2018-12-13T09:53:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Reconcile requirements, configuring, and tuning PE documents", "timeSpent": "PT0S", "updated": "2021-02-05T11:01:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:520566be-dc64-492b-8de1-701eed347203", "attachments": [], "comments": [ { "author": "557058:520566be-dc64-492b-8de1-701eed347203", "body": "[~accountid:5a53f77aeb8cdb7a2cb274b1] For review, the updated manage packages section:\n\n[https://docs-preview.webteam.puppet.com/docs/discovery/1.x-dev/pd_task.html#reference-1781]\n\nu/n: puppet.access\n\npw: fork.left.extra\n\n\u00a0", "created": "2018-10-09T07:44:00.000000" }, { "author": "5a53f77aeb8cdb7a2cb274b1", "body": "Thanks [~accountid:557058:520566be-dc64-492b-8de1-701eed347203].\u00a0 Looks good.", "created": "2018-10-09T23:47:00.000000" } ], "components": [], "created": "2018-10-08T12:19:00.000000", "creator": "5a53f77aeb8cdb7a2cb274b1", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@31cac352" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqd9j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_9364886_*|*_3_*:*_1_*:*_17204403_*|*_10009_*:*_1_*:*_75718442_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_43530788" } ], "description": "[~accountid:557058:520566be-dc64-492b-8de1-701eed347203] - think we should provide additional details/clarification that Windows package management requires Chocolately\u00a0in the package management task section found on [https://puppet.com/docs/discovery/1.x/pd_task.html#task-2737]\n\nAlso, should we call out that to install a new package, your configured repository on the host must support/contain the package? (better wording required)\n\n\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54516", "fixedVersions": [], "id": "54516", "issueType": "Improvement", "key": "DOCUMENT-922", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a53f77aeb8cdb7a2cb274b1", "resolution": "Fixed", "resolutionDate": "2018-10-10T04:49:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Discovery - Provide additional details/clarification that Windows package management requires Chocolately", "timeSpent": "PT0S", "updated": "2018-10-10T04:49:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "I updated the page with the missing example. Thanks for spotting!", "created": "2018-10-08T06:29:00.000000" } ], "components": [], "created": "2018-10-05T09:34:00.000000", "creator": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@50253786" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqc7b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_637306_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_247447813" } ], "description": " https://puppet.com/docs/puppet/6.0/hiera_intro.html ...\u2002\u2002Search for the phrase \"In the example above\".\u2002\u2002 The example referred to looks like it got lost.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54884", "fixedVersions": [], "id": "54884", "issueType": "Task", "key": "DOCUMENT-921", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:45fa3568-deb5-4da5-b894-a1ec07f1c138", "resolution": "Fixed", "resolutionDate": "2018-10-08T06:29:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Missing example in 6.0 docs", "timeSpent": "PT0S", "updated": "2018-10-08T06:29:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Fixed. Thanks for your help, Marc!\u00a0", "created": "2018-10-11T15:56:00.000000" } ], "components": [], "created": "2018-10-04T09:12:00.000000", "creator": "557058:d3c2994a-2b37-46bf-829d-68a3180161cf", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2e9cf7d0" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzqbif:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Bug Fix" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "11/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_366261711_*|*_3_*:*_1_*:*_4667431_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_258124056" } ], "description": "1. There a few key typos in the documentation that I've found over the past few days that will cause the integration fail at several stages.\n\nThe first script referenced in the section #jenkins-project-before-build-script has two mistakes.\n\n\u00a0\n\n*{color:#FF0000}DISTELLI_API_URL=\"http://api.distelli.com/$DISTELLI_USERNAME\"{color}*\n\nShould read:\n\n{color:#14892c}*DISTELLI_API_URL=\"https://api.distelli.com/$DISTELLI_USERNAME\"*{color}\n\n--------------------------------------------------------------------------------------------------------\n\n*{color:#FF0000}DISTELLI_TMP_FILENAME=\"DISTELLI.$JOB_NAME.$BUILD_NMUBER.tmp\"{color}*\n\nShould read:\n\n{color:#14892c}*DISTELLI_TMP_FILENAME=\"DISTELLI.$JOB_NAME.$BUILD_NUMBER.tmp\"*{color}\n\n\u00a0\n\n2. The \"Next\" section at the bottom of the page has a few references to links on other pages but it looks like they got formatted strangely and came through as text rather than hyperlinks.\n\n\u00a0\n\n{color:#333333}3. There is also one small inconsistency with the build script templates - It's not a huge deal because these details will be changed by the user but it would be nice for consistency if all 3 of the build scripts DISTELLI_USERNAME field read the same thing:\u00a0{color}\n\n{color:#14892c}*DISTELLI_USERNAME=jdoe*\u00a0{color}\n\nRather than two of them reading as:\n\n*{color:#d04437}DISTELLI_USERNAME=bmcgehee{color}*", "environment": "https://puppet.com/docs/pipelines-for-apps/team/integrate-jenkins.html#jenkins-project-before-build-script\nhttps://puppet.com/docs/pipelines-for-apps/enterprise/integrate-jenkins.html#jenkins-project-before-build-script\nhttps://puppet.com/docs/pipelines-for-apps/free/integrate-jenkins.html#jenkins-project-before-build-script", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54203", "fixedVersions": [], "id": "54203", "issueType": "Bug", "key": "DOCUMENT-920", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Critical", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d3c2994a-2b37-46bf-829d-68a3180161cf", "resolution": "Fixed", "resolutionDate": "2018-10-11T15:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Key typos in Pipelines Jenkins Integration docs", "timeSpent": "PT0S", "updated": "2018-10-11T15:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5d9f43aac62f840db2b6ee35", "attachments": [], "comments": [ { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "[~accountid:70121:73c013a0-69ab-43bb-9bda-8b20355387dc] It's trying to say the underlying tools like {{useradd}} generates the UID instead of puppet. Does that clarify? If so, we'll get the docs updated.", "created": "2021-01-27T18:29:00.000000" }, { "author": "5d9f43aac62f840db2b6ee35", "body": "Content clarified as per ticket notes.", "created": "2021-01-28T10:00:00.000000" } ], "components": [], "created": "2018-10-01T13:01:00.000000", "creator": "70121:73c013a0-69ab-43bb-9bda-8b20355387dc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@19f295f8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq8b3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Jan/21" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1207339709_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_72225362424" } ], "description": "In the documtation for the \"User\" resource type, the \"uid\" attribute description seems unfinished and is confusing\n\n\u00a0\n\n{quote}\nuid\n(Property: This attribute represents concrete state on the target system.)\n\nThe user ID; must be specified numerically. If no user ID is specified when creating a new user, then one will be chosen automatically. This will likely result in the same user having different UIDs on different systems, which is not recommended. This is especially noteworthy when managing the same user on both Darwin and other platforms, since Puppet does UID generation on Darwin, _but the underlying tools do so on other platforms_.\n\n{quote}\n\n\"_but the underlying tools do so on other platforms_\" -- do what? looks like a dangling dependent clause here.", "environment": "On the documentation for the \"User\" resource type, the description of the \"uid\" attribute seems unfinished and confusing. Found here: https://puppet.com/docs/puppet/5.5/types/user.html#user-attribute-uid\n\n{quote}\nuid\n(Property: This attribute represents concrete state on the target system.)\n\nThe user ID; must be specified numerically. If no user ID is specified when creating a new user, then one will be chosen automatically. This will likely result in the same user having different UIDs on different systems, which is not recommended. This is especially noteworthy when managing the same user on both Darwin and other platforms, since Puppet does UID generation on Darwin, _but the underlying tools do so on other platforms_.\n{quote}\n\n\"...but the underlying tools to do so on other platforms.\" -- do what? also do uid gen?\n\nthanks", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54653", "fixedVersions": [], "id": "54653", "issueType": "Bug", "key": "DOCUMENT-1184", "labels": [ "core", "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:73c013a0-69ab-43bb-9bda-8b20355387dc", "resolution": "Fixed", "resolutionDate": "2021-01-28T10:00:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Unfinished/confusing description of \"user\" resource type attribute", "timeSpent": "PT0S", "updated": "2021-01-28T10:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Docs updated. Thanks for spotting!\u00a0", "created": "2018-10-10T01:13:00.000000" } ], "components": [], "created": "2018-10-01T09:56:00.000000", "creator": "557058:ecdbe9d7-fd31-4136-80ae-15ac851f87fc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@36127b15" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq847:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_4270513_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_741960449" } ], "description": "Per [https://puppet.com/docs/puppetdb/6.0/configure.html#using-postgresql]\n\n>\u00a0At a minimum, you will need to ensure that you have PostgreSQL 9.6 or later running\n\nCurrently, due to\u00a0PDB-3857 *only* pgsql 9.6 will work.\u00a0 10 is not compatible.\n\nPlease update the documentation to reflect that you need to use 9.6.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54883", "fixedVersions": [], "id": "54883", "issueType": "Bug", "key": "DOCUMENT-918", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ecdbe9d7-fd31-4136-80ae-15ac851f87fc", "resolution": "Fixed", "resolutionDate": "2018-10-10T01:13:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation incorrectly indicates postgres >= 9.6 works", "timeSpent": "PT0S", "updated": "2018-10-10T01:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "attachments": [], "comments": [ { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Everything I can find about 2016.4 and Puppet 4.10 says that it goes with Puppet Server 2.6. So I changed the puppetserver associated with Puppet 4.10 from 2.8 (which doesn't exist as far as I can tell) to 2.6.\n\nBuilding.", "created": "2018-10-01T11:46:00.000000" }, { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "Fixed. Thank you!", "created": "2018-10-01T13:07:00.000000" }, { "author": "623c0cebbef8a60068c7977d", "body": "Woot! It works! Thank you!", "created": "2018-10-01T16:26:00.000000" } ], "components": [], "created": "2018-09-28T10:25:00.000000", "creator": "623c0cebbef8a60068c7977d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Clicking the \"Puppet Server 2.8 release notes\" link from (ideally) any other Puppet 4.10 doc page takes you to the documentation for Puppet Server 2.8." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@c3678da" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq6zb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_261743924_*|*_3_*:*_1_*:*_5676704_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1469760" } ], "description": "In our [2016.4 LTS Puppet Overview doc|https://puppet.com/docs/pe/2016.4/puppet_overview.html], there's a link to the [Puppet 4.10 docs|https://puppet.com/docs/puppet/4.10/index.html]. From there, I'm not able to successfully get to the [Puppet Server 2.8 release notes|https://docs.puppet.com/puppetserver/2.8/release_notes.html?_ga=2.180630055.1259787039.1538150033-276673459.1484846983].\n\nIf you checkout the page link, it seems that this link is still using the old docs.puppet.com domain, rather than the newer puppet.com/docs pattern. If I just switch out the URL part, I get a 404 message, so it doesn't seem that correcting the link pattern alone will fix it, however.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54202", "fixedVersions": [], "id": "54202", "issueType": "Bug", "key": "DOCUMENT-917", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0cebbef8a60068c7977d", "resolution": "Fixed", "resolutionDate": "2018-10-01T13:07:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "LTS Puppet Docs Link to Puppet Server Broken", "timeSpent": "PT0S", "updated": "2018-10-01T16:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "check index for list.", "created": "2018-11-16T14:53:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I've no doubt it wasn't showing up at the time, but this command is now listed on the man page index page.", "created": "2019-01-16T14:14:00.000000" } ], "components": [], "created": "2018-09-27T11:29:00.000000", "creator": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@b4b6ab3" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9txb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_344374146_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9259529535" } ], "description": "there is some info here: https://puppet.com/docs/puppet/6.0/services_commands.html#puppet-ssl\nand here:\nhttps://puppet.com/docs/puppet/6.0/ssl_certificates.html\n\nbut the ssl subcommand is missing from the manpage area (maybe this is intentional?):\nhttps://puppet.com/docs/puppet/6.0/man/index.html", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54606", "fixedVersions": [], "id": "54606", "issueType": "Bug", "key": "DOCUMENT-916", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "resolution": "Cannot Reproduce", "resolutionDate": "2019-01-16T14:14:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet ssl manpage missing", "timeSpent": "PT0S", "updated": "2019-01-16T14:14:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "It's listed on the index page:\u00a0https://puppet.com/docs/puppet/6.0/man/index.html", "created": "2018-11-16T14:53:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Doesn't this sound easy? :D WELL.\n\nThe trouble here is that the man index page is generated from Puppet code. It's 404ing because the man page has been removed", "created": "2019-01-16T14:54:00.000000" } ], "components": [], "created": "2018-09-27T11:24:00.000000", "creator": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@2aca97ee" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hz9txj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_344649129_*|*_3_*:*_1_*:*_160933549_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9101014142" } ], "description": "but it results in a 404.\n\nhttps://puppet.com/docs/puppet/6.0/man/cert.html\n\nthat subcommand still exists (for a while) but, when run, it just says to use {{puppetserver ca}}\n\nthe man page should probably be removed, or point users to puppetserver ca docs", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54390", "fixedVersions": [], "id": "54390", "issueType": "Bug", "key": "DOCUMENT-915", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "resolution": "Fixed", "resolutionDate": "2019-01-16T14:54:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet cert subcommand link still exists", "timeSpent": "PT0S", "updated": "2019-01-16T14:54:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [ { "attacher": "557058:35060490-aa27-40a2-b587-eca7672140c8", "created": "2018-09-26T16:55:00.000000", "name": "Screen Shot 2018-09-26 at 16.54.45.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14199" } ], "comments": [], "components": [], "created": "2018-09-26T16:55:00.000000", "creator": "557058:35060490-aa27-40a2-b587-eca7672140c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1585dd2c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq55b:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_411255511_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3991255184" } ], "description": "Navigate to https://puppet.com/docs/puppetdb/6.0/api/ext/v1/state-overview.html\n\nThe URL clearly indicates version 6.0, and the drop down box on the left indicates 6.0, but the heading indicates version \"PuppetDB 5.2\"\n\n(See attached image).\n\nIf the endpoint is somehow restricted to 5.2, then we need to remove or change it for 6.0. If the information is accurate for 6.0, we should remove the 5.2 designation.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54514", "fixedVersions": [], "id": "54514", "issueType": "Improvement", "key": "DOCUMENT-914", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:35060490-aa27-40a2-b587-eca7672140c8", "resolution": "Fixed", "resolutionDate": "2018-11-16T14:50:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Inconsistent version displayed on PuppetDB State Overview Endpoint page", "timeSpent": "PT0S", "updated": "2018-11-16T14:50:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [], "components": [ "PE" ], "created": "2018-09-25T13:08:00.000000", "creator": "5a1beaee4e565f43b031314d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@45cb29d4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq3uf:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "08/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_511289588_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_956461831_*|*_10005_*:*_1_*:*_24208662849" } ], "description": "A customer has called out a gap in our RSPEC and PDK documentation.\u00a0 They feel that the following links have just enough information to get them started but don't go into enough depth to troubleshoot their own development and testing issues:\n\n\u00a0\n [https://puppet.com/blog/unit-testing-rspec-puppet-for-beginners]\n [https://rspec-puppet.com/tutorial/]\n [https://github.com/puppetlabs/pdk-templates/]\n [https://github.com/puppetlabs/pdk-planning/]\n \u00a0\n\n \u00a0\n \u00a0\n \u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54513", "fixedVersions": [], "id": "54513", "issueType": "Improvement", "key": "DOCUMENT-913", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a1beaee4e565f43b031314d", "resolution": "Won't Fix", "resolutionDate": "2019-07-19T17:28:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Enhanced PDK and RSPEC documentation", "timeSpent": "PT0S", "updated": "2019-07-19T17:28:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5a46c85fe0a6f308201def98", "attachments": [], "comments": [ { "author": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "body": "[~accountid:5a46c85fe0a6f308201def98] looks good! I don't have any edits for it.", "created": "2018-10-02T01:32:00.000000" }, { "author": "5a46c85fe0a6f308201def98", "body": "New example published at [https://puppet.com/docs/bolt/0.x/inventory_file.html]\n\n\u00a0", "created": "2018-10-03T08:23:00.000000" } ], "components": [ "bolt" ], "created": "2018-09-25T08:04:00.000000", "creator": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@493719e2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq3ef:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_529633587_*|*_10009_*:*_1_*:*_151221772_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_11482822" } ], "description": "The example inventory file for Bolt on Docs could use some improvement. Please consider using the following example to showcase a more typical real world scenario:\n\n\u00a0\n{code:java}\ngroups:\n - name: ssh_nodes\n groups:\n - name: webservers\n nodes:\n - 192.168.100.179\n - 192.168.100.180\n - 192.168.100.181\n - name: memcached\n nodes:\n - 192.168.101.50\n - 192.168.101.60\n config:\n ssh:\n user: root\n config:\n transport: ssh\n ssh:\n user: centos\n private-key: ~/.ssh/id_rsa\n host-key-check: false\n - name: win_nodes\n groups:\n - name: domaincontrollers\n nodes:\n - 192.168.110.10\n - 192.168.110.20\n - name: testservers\n nodes:\n - 172.16.219.20\n - 172.16.219.30\n config:\n winrm:\n user: vagrant\n password: vagrant\n ssl: false\n config:\n transport: winrm\n winrm:\n user: DOMAIN\\opsaccount\n password: S3cretP@ssword\n ssl: true\n{code}\nThis showcases:\n * overrides at sub-group level\n * SSH and WinRM defaults for top-group levels\n * WinRM properties that are likely to be used\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54511", "fixedVersions": [], "id": "54511", "issueType": "Improvement", "key": "DOCUMENT-912", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b0000c48-c6a4-41b8-baf9-6d9c091a181c", "resolution": "Fixed", "resolutionDate": "2018-10-03T08:23:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Provide better Bolt inventory file example", "timeSpent": "PT0S", "updated": "2018-10-03T08:23:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "I've updated the code in the doc.\u00a0https://puppet.com/docs/continuous-delivery/1.x/example_jobs.html\n\nThanks for your help!\u00a0\n\n!https://media.giphy.com/media/lr2bkSkxMWFCo/giphy.gif!", "created": "2018-09-28T09:37:00.000000" } ], "components": [], "created": "2018-09-21T14:32:00.000000", "creator": "5b590061a3f8512ca5eb3be7", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@23825e84" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzq0vz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_246854601_*|*_3_*:*_1_*:*_56346933_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_283918892" } ], "description": "The bash examples on the [Testing Puppet code with jobs|https://puppet.com/docs/continuous-delivery/1.x/example_jobs.html] page could be improved in a few ways:\n * Enables globstar but doesn't use it. Instead uses find.\n * Any files with spaces (and possibly special characters) will fail because word splitting occurs inside bash for loops.\n * Doesn't quote variables or use [[ ]] in a few instances.\n\nI think this code would be more robust:\n\nFor parser validation:\n{code:sh}#!/bin/bash\n\nshopt -s globstar nullglob\ngreen=\"$(tput setaf 2)\"\nred=\"$(tput setaf 1)\"\nreset=\"$(tput sgr0)\"\n\nfor f in **/**pp; do\n [[ $f =~ plans/ ]] && continue\n\n if puppet parser validate \"$f\"; then\n echo \"${green}SUCCESS: $f${reset}\"\n else\n echo \"${red}FAILED: $f${reset}\"\n failures+=(\"$f\")\n fi\ndone\n\nif (( ${#failures[@]} > 0 )); then\n echo \"${red}Syntax validation on the Control Repo has failed in the following manifests:\"\n echo -e \"\\t ${failures[@]}${reset}\"\n exit 1\nelse\n echo \"${green}Syntax validation on the Control Repo has succeeded.${reset}\"\nfi\n{code}\nFor lint:\n{code:sh}#!/bin/bash\n\nshopt -s globstar nullglob\ngreen=\"$(tput setaf 2)\"\nred=\"$(tput setaf 1)\"\nreset=\"$(tput sgr0)\"\n\nsudo /opt/puppetlabs/puppet/bin/gem install puppet-lint || {\n echo \"${red}Failed to install puppet-lint gem\"\n exit 2\n}\n\nLINT_OPTS=(\"--fail-on-warnings\" \"--no-documentation-check\" \"--no-140chars-check\" \"--no-autoloader_layout-check\" \"--no-class_inherits_from_params_class-check\")\n\nfor f in **/**pp; do\n [[ $f =~ plans/ ]] && continue\n\n if /opt/puppetlabs/puppet/bin/puppet-lint \"${LINT_OPTS[@]}\" \"$f\"; then\n echo \"${green}SUCCESS: $f${reset}\"\n else\n echo \"${red}FAILED: $f${reset}\"\n failures+=(\"$f\")\n fi\ndone\n\nif (( ${#failures[@]} > 0 )); then\n echo \"${red}Puppet-lint validation on the Control Repo has failed in the following manifests:\"\n echo -e \"\\t ${failures[@]}${reset}\"\n exit 1\nelse\n echo \"${green}Puppet-lint validation on the Control Repo has succeeded.${reset}\"\nfi\n{code}\n\nThanks,\nAdrian", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54200", "fixedVersions": [], "id": "54200", "issueType": "Improvement", "key": "DOCUMENT-911", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5b590061a3f8512ca5eb3be7", "resolution": "Fixed", "resolutionDate": "2018-09-28T09:37:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve syntax validation example in Testing Puppet code with jobs", "timeSpent": "PT0S", "updated": "2018-09-28T09:37:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [ { "attacher": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "created": "2019-04-19T09:01:00.000000", "name": "Step 4.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14249" } ], "comments": [ { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Step 4 looks like this to me:\n !Step 4.png|thumbnail! \n\nThe command it's showing is:\n{code}\n puppetserver ca setup\n{code}\n\nSeems like this has already been fixed?", "created": "2019-04-19T09:03:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This issue has been fixed.\u00a0", "created": "2019-04-25T02:04:00.000000" } ], "components": [ "Puppet Server" ], "created": "2018-09-19T08:50:00.000000", "creator": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5110859f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpypb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Apr/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_176713491_*|*_3_*:*_1_*:*_145740841_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_18488426296" } ], "description": "When following the instructions in the Puppet documentation, the stated procedure does not work.\u00a0\u00a0\n\n\u00a0\n\nPage:\n\n[https://puppet.com/docs/puppetserver/6.0/install_from_packages.html#quick-start]\n\n\u00a0\n\nSection:\n\n4. Generate a root and intermediate signing CA for Puppet Server\n\nservice puppetserver ca generate\n\n\u00a0\n\nThis does not work.\u00a0 The returned result is:\n\n[root@server sysconfig]# service puppetserver ca generate\nUsage: /etc/init.d/puppetserver \\{start|stop|restart|condrestart|try-restart|reload|status}\n\nThe Init Script contents do not contain a \"ca\" option:\n\n\u00a0\n\nThe 'puppetserver'\u00a0_binary_ however does contain this function. Therefore the document should read:\n\n\u00a0\n\n4. Generate a root and intermediate signing CA for Puppet Server\n\npuppetserver ca generate\n\n\u00a0\n\nI would recommend the full path, as the puppetserver binary is not in the default path immediately post-install.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55104", "fixedVersions": [], "id": "55104", "issueType": "Bug", "key": "DOCUMENT-910", "labels": [ "puppetserver" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:3fde63ce-1af9-4657-8cf9-544754ab54a6", "resolution": "Fixed", "resolutionDate": "2019-04-25T02:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Procedure in documentation does not function", "timeSpent": "PT0S", "updated": "2019-04-25T02:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:09fbcf8b-9ff4-4dee-a188-c3fb45897af4] - this is where I could use your help.", "created": "2018-09-24T11:08:00.000000" } ], "components": [], "created": "2018-09-19T08:08:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@aad05b2" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpynj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_442793748_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4597026600" } ], "description": "On the main documentation site for Puppet 6, [https://puppet.com/docs/puppet/6.0/puppet_index.html,]\u00a0there is documentation for a \"major\" upgrade from version 3.8 and for a \"minor\" upgrade from version 5.x or within version 6, but there is no similar classification and no docs for an upgrade from v4 to v6.\u00a0 This was perhaps overlooked because the left-hand navigation pane still has a heading \"Minor upgrades: From Puppet 4 and within Puppet 5.x\", but the headline and introduction of the page to which that links, [https://puppet.com/docs/puppet/6.0/upgrade_minor.html,]\u00a0describe a minor upgrade differently, as from v5 to v6 and within v6.x.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54749", "fixedVersions": [], "id": "54749", "issueType": "Bug", "key": "DOCUMENT-909", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Fixed", "resolutionDate": "2018-11-16T15:05:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "No docs on the web site for upgrading from v4 to v6", "timeSpent": "PT0S", "updated": "2018-11-16T15:05:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Fixed in 5.5 forward", "created": "2019-01-14T17:56:00.000000" } ], "components": [], "created": "2018-09-17T14:24:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1f8bed14" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpx3z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_593066169_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9704821953" } ], "description": "The Puppet Language Reference contains a list of reserved words at [https://puppet.com/docs/puppet/5.5/lang_reserved.html.]\u00a0 It lists the word \"type\" as \"reserved for future use\", but in fact that word is _already_ in use as a keyword introducing the definition of a user-defined data type.\u00a0 The entry for \"type\" should therefore be updated to designate it a \"language keyword\".", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54881", "fixedVersions": [], "id": "54881", "issueType": "Bug", "key": "DOCUMENT-908", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623a46a67910a200718ac239", "resolution": "Fixed", "resolutionDate": "2019-01-14T17:56:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "The language reference incorrectly reserves the word \"type\" for future use", "timeSpent": "PT0S", "updated": "2019-01-14T17:56:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This table will be fixed in the 5.4 docs in the next build. Thanks for spotting this!\u00a0", "created": "2018-09-21T09:07:00.000000" } ], "components": [], "created": "2018-09-17T06:17:00.000000", "creator": "557058:ec12cc38-6f0b-4237-9378-deaa09414f4e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7a0fe913" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpw9z:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_17351715_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_338456872" } ], "description": "Page URL:\n\n[https://puppet.com/docs/puppet/5.4/hiera_intro.html]\n\nBadly formatted table:\n\n{{Lookup key\tRelevant module hierarchy ntp::servers\tntp jenkins::port\tjenkins secure_server (none)}}\n\nThat table is rendered correctly in version 5.5 of the same page:\n\n[https://puppet.com/docs/puppet/5.5/hiera_intro.html]\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54652", "fixedVersions": [], "id": "54652", "issueType": "Bug", "key": "DOCUMENT-907", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:ec12cc38-6f0b-4237-9378-deaa09414f4e", "resolution": "Fixed", "resolutionDate": "2018-09-21T09:07:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Formatting bug in Hiear intro 5.4 (fixed in 5.5 docs)", "timeSpent": "PT0S", "updated": "2018-09-21T09:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [], "components": [], "created": "2018-09-11T10:37:00.000000", "creator": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "* --waitforcert does not mention the boolean --no modifier\n* there is more clear summary of how to use --no\n* the boolean options mention their --no modifier" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@78fe0ee7" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpt4f:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_520188563_*|*_3_*:*_1_*:*_687268_*|*_10009_*:*_1_*:*_325687319_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_2_*:*_15652476_*|*_10005_*:*_1_*:*_45100320357" } ], "description": "in the puppet agent manpage there is a note on boolean options in the {{--waitforcert}} section:\n{quote}\nNote the special 'no-' prefix for boolean settings on the command line.\n{quote}\n\nthis is useful, but does not apply to --waitforcert (which is not a boolean option).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54993", "fixedVersions": [], "id": "54993", "issueType": "Improvement", "key": "DOCUMENT-906", "labels": [ "docs-hack", "generated-docs", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "resolution": "Fixed", "resolutionDate": "2020-02-25T08:59:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet agent manpage has confusing note on '--no' prefaces for boolean options", "timeSpent": "PT0S", "updated": "2020-02-25T08:59:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "attachments": [ { "attacher": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "created": "2018-09-06T14:29:00.000000", "name": "structured-params.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14245" } ], "comments": [ { "author": "5a46c85fe0a6f308201def98", "body": "May have been intended to redirect to [https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html#set-class-parameters]\n\n\u00a0", "created": "2018-09-06T14:33:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12] Could you fix this at the source?", "created": "2018-09-10T10:26:00.000000" }, { "author": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "body": "Yes, I can change the the url from the links.puppetlabs.com one to a direct (pe family versioned) link to the docs page.", "created": "2018-09-10T12:27:00.000000" } ], "components": [], "created": "2018-09-06T14:31:00.000000", "creator": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69421082" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpq3b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_1876661803_*|*_1_*:*_1_*:*_1443730_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_957240492" } ], "description": "In the Configuration tab of the Node Group detail screen, there's a popup that contains a link to the docs site:\n\n!structured-params.png|thumbnail!\n\nThe href of that link is: http://links.puppetlabs.com/structuredparams\nthat redirects to: https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html#setting-class-parameters\nit should redirect to: https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html#tips-for-specifying-parameter-and-variable-values", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54651", "fixedVersions": [], "id": "54651", "issueType": "Bug", "key": "DOCUMENT-905", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "resolution": "Fixed", "resolutionDate": "2018-10-09T10:07:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Structured Parameters Link (links.puppetlabs.com) incorrect", "timeSpent": "PT0S", "updated": "2018-10-09T10:07:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [ { "attacher": "557058:9479147e-472e-492f-9d5f-2788ee2dd8d0", "created": "2018-09-06T08:45:00.000000", "name": "Screen Shot 2018-09-06 at 09.44.43.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14262" } ], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Thanks! Markdown was trying to be helpful by reading that pipe character as an instruction to make a table. I have shown it the error of its ways.\u00a0\n\n\u00a0", "created": "2018-09-06T17:04:00.000000" } ], "components": [], "created": "2018-09-06T08:46:00.000000", "creator": "557058:9479147e-472e-492f-9d5f-2788ee2dd8d0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@455c7b40" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzppnj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_26083390_*|*_3_*:*_1_*:*_2990513_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_817999" } ], "description": "There is a typo in the documentation here:\nhttps://puppet.com/docs/pipelines-for-apps/enterprise/manifest.html\n\nmore specifically https://puppet.com/docs/pipelines-for-apps/enterprise/manifest.html#using-multilines-in-yaml\n\n{code}\n\u201d (pipe)\n{code}\n\nAlso see attached screenshot ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54093", "fixedVersions": [], "id": "54093", "issueType": "Bug", "key": "DOCUMENT-904", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9479147e-472e-492f-9d5f-2788ee2dd8d0", "resolution": "Fixed", "resolutionDate": "2018-09-06T17:04:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet pipelines for applications typo", "timeSpent": "PT0S", "updated": "2018-09-06T17:04:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [], "components": [], "created": "2018-09-05T15:20:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@332ae645" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzposv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "10/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_417018218_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_480292" } ], "description": "Install Razor docs https://puppet.com/docs/pe/2018.1/installing_razor.html would benefit from similar images to https://puppet.com/docs/pe/2018.1/system_configuration.html#firewall-configuration-for-monolithic-installs\n\nThey would also benefit from a link to the section on available repositories in the PE install docs https://puppet.com/docs/pe/2018.1/system_configuration.html#reference-7476 ", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54509", "fixedVersions": [], "id": "54509", "issueType": "Improvement", "key": "DOCUMENT-903", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Won't Fix", "resolutionDate": "2018-09-10T11:19:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "As a Razor admin I would appreciate a infrastructure diagram to illustrate the ports and connectivity to Puppet enterprise and my required Infrastructure (DHCP, TFTP,optional (HTTP,HTTPs))", "timeSpent": "PT0S", "updated": "2018-09-10T13:09:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [], "comments": [ { "author": "623a46a67910a200718ac239", "body": "This is of course not specific to PE.\u00a0 Open source Puppet is identically affected.", "created": "2018-09-18T09:17:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "This is fixed in PE. [~accountid:557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1] could you add a known issue to the Puppet 5.5 docs? Here's the text I used:\nh2. Puppet runs generate an autosign warning\u00a0\nDuring Puppet agent runs, a warning appears indicating that autosign is deprecated. We're un-deprecating autosign in a future release and you can ignore this warning.\u00a0", "created": "2018-09-20T15:17:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Added. should go live in the next hour or so.", "created": "2018-09-20T16:39:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Added to resolved issues for PE 2018.1.5. [~accountid:557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1], can you add a resolved issue for Puppet 5.5.7? Here's the text I used:\nh2. Puppet runs generated an autosign warning (2018.1.5)\nDuring Puppet agent runs, a warning appeared indicating that autosign was deprecated. We un-deprecated autosign and this warning no longer appears.", "created": "2018-09-24T13:59:00.000000" } ], "components": [ "Puppet Client/Agent", "Puppet Server" ], "created": "2018-09-04T13:08:00.000000", "creator": "557058:d6870b2a-8ac5-4232-984e-0a28f1b3fe28", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@15192506" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpnhb:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Sep/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_79168684_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_12013469012" } ], "description": "PE 2018.1.4 displays the following Warning during a puppet agent run:\n\n{{Warning: Setting autosign is deprecated.}}\n{{ (location: /opt/puppetlabs/puppet/lib/ruby/vendor_ruby/puppet/settings.rb:1169:in `issue_deprecation_warning')}}\n\nThis is warning us that with the new puppet ca that's going to be implemented, the autosign setting will be deprecated.\n\nThe thing is, this feature isn't yet implemented, so there is nothing we can do about the warning.\u00a0 What's worse, nothing about this warning and what to do about it can be found anywhere on the web site.\n\nI would like to request that information about this Warning be included in \"Known Issues\" for 2018.1.4 so that people wondering about the warning will know it can be safely ignored.\n\nAdd-on feature request:\u00a0 The ability to ignore / filter certain Warnings during puppet agent runs.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54091", "fixedVersions": [], "id": "54091", "issueType": "Improvement", "key": "DOCUMENT-902", "labels": [ "known-issue-added" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6870b2a-8ac5-4232-984e-0a28f1b3fe28", "resolution": "Fixed", "resolutionDate": "2019-01-22T11:12:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Add information about \"Warning: setting autosign is deprecated\" to Known Issues for 2018.1.4", "timeSpent": "PT0S", "updated": "2019-01-22T11:12:00.000000", "votes": "1", "watchers": [] }, { "affectedVersions": [], "assignee": "5a46c85fe0a6f308201def98", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Looks like bolt.yml is mentioned in these DITA topics on the Bolt 0.x branch:\n\n./bolt_configure_orchestrator.dita\n ./bolt_connect_puppetdb.dita\n ./bolt_new_features-019.dita\n ./bolt_resolved_issues-019.dita\n ./configuring_bolt.dita\n\nSpecifically:\n{code}./bolt_configure_orchestrator.dita\n You can also configure orchestrator in the Bolt configuration file (~/.puppetlabs/bolt.yml) or the configuration section of the inventory file (~/.puppetlabs/bolt/inventory.yaml).\n\n--\n\n./bolt_connect_puppetdb.dita\n

        To configure the client, add a\u00a0puppetdb\u00a0section to ~/.puppetlabs/bolt.yml with the following values:

        \n\n--\n\n./bolt_new_features-019.dita\n

        looks for config files called either bolt.yaml or bolt.yml. If both exist, you will get a warning.\n will load config options from a file ~/.puppetlabs/bolt.yml or the path specified on the command line with --configfile.

        \n\n--\n\n./bolt_resolved_issues-019.dita\n

        The PCP transport options token-file or service-url that you specify in the configuration file (bolt.yml) are recognized in Bolt. Previously, only the default token-file location was used and the service-url value was ignored.

        \n\n--\n\n./configuring_bolt.dita\n

        By default $HOME/.puppetlabs/bolt/\u00a0is the base directory for user-supplied data such as the configuration and inventory files or the\u00a0Boltdir. To set up a default global configuration for Bolt, create a ~/.puppetlabs/bolt.yml file with global options at the top level of the file. Configure transport specific options for each transport. If a config option is set in the config file and passed with the corresponding command-line flag, the flag takes precedence.

        \n{code}", "created": "2018-08-28T11:38:00.000000" }, { "author": "5a46c85fe0a6f308201def98", "body": "Some instances of bolt.yml are intentional. See related issue Bolt-259.\u00a0\n\n[~accountid:557058:fd17676f-b54f-4df6-b0e2-ce0f8a23c31e] has the introduction of Boltdir changed things?\u00a0", "created": "2018-08-30T13:36:00.000000" }, { "author": "557058:fd17676f-b54f-4df6-b0e2-ce0f8a23c31e", "body": "We want to encourage {{bolt.yaml}}. I'm comfortable having {{bolt.yml}} be undocumented.", "created": "2018-08-30T14:48:00.000000" } ], "components": [ "bolt" ], "created": "2018-08-28T05:31:00.000000", "creator": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a9abbc6" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzph7j:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "28/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_22060093_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_186731612" } ], "description": "At least two of the doc pages for bolt reference a {{bolt.yml}} file. The correct name to use is {{bolt.yaml}}:\n\n - https://puppet.com/docs/bolt/0.x/configuring_bolt.html\n - https://puppet.com/docs/bolt/0.x/bolt_configure_orchestrator.html#adjust-the-orchestrator-configuration-files\n\nBolt will ignore any {{bolt.yml}} file present in a Boltdir. The other docs pages should be audited for additional occurrences.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54746", "fixedVersions": [], "id": "54746", "issueType": "Bug", "key": "DOCUMENT-900", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "resolution": "Fixed", "resolutionDate": "2018-08-30T15:31:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Bolt configuration docs reference incorrect file name", "timeSpent": "PT0S", "updated": "2018-08-30T15:31:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "5a46c85fe0a6f308201def98", "attachments": [], "comments": [ { "author": "5a46c85fe0a6f308201def98", "body": "Added configuration code and value.\n\nhttps://puppet.com/docs/pe/2018.1/rbac_api_v1_password.html#post-users-sid-password-reset", "created": "2018-08-30T14:26:00.000000" } ], "components": [], "created": "2018-08-21T13:07:00.000000", "creator": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1d0fdbe4" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpcf3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_93121131_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_689249239" } ], "description": "The docs for [RBAC's password reset endpoint|https://puppet.com/docs/pe/2018.1/rbac_api_v1_password.html#post-users-sid-password-reset] mention \"The lifetime is based on a configuration value.\" but do not specify which one. We should add: {{puppet_enterprise::profile::console::rbac_password_reset_expiration}} (number of hours) and that the default value if that isn't set is 24 hours.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55103", "fixedVersions": [], "id": "55103", "issueType": "Improvement", "key": "DOCUMENT-898", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8db25e7a-4bdb-4fe2-af6b-f0a9bc714e12", "resolution": "Fixed", "resolutionDate": "2018-08-30T14:26:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "RBAC Password Reset docs should specify expiration setting", "timeSpent": "PT0S", "updated": "2018-08-30T14:26:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:3915718f-2673-45b3-a0a6-c7c03ef0754e", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Hey Zak - can you field this one for the DB docs?", "created": "2018-11-16T15:12:00.000000" }, { "author": "557058:3915718f-2673-45b3-a0a6-c7c03ef0754e", "body": "[~accountid:557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1] yep, I can take a look and update the docs. Thanks!", "created": "2018-11-16T15:15:00.000000" } ], "components": [ "PuppetDB" ], "created": "2018-08-21T06:57:00.000000", "creator": "6217ba0a71554c00695601a8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7f79de58" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpc5b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_527564326_*|*_10007_*:*_1_*:*_1812358426_*|*_3_*:*_1_*:*_243072792_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_7022811919" } ], "description": "The PQL Query Language documentation provides wrong examples on how to use url parameter. e.g.\n{code:java}\npuppet query '' \\\n --urls http://puppetdb.example.com:8080/pdb/query/v4 {code}\nThis example is wrong, as you may not provide the path. The correct example is:\n{code:java}\n puppet query '' \\ --urls http://puppetdb.example.com:8080{code}\nThis documentation error can be found at at least two locations:\n\n[https://puppet.com/docs/puppetdb/5.2/api/query/tutorial-pql.html]\n\n[https://puppet.com/docs/puppetdb/5.2/api/query/v4/pql.html]\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54650", "fixedVersions": [], "id": "54650", "issueType": "Bug", "key": "DOCUMENT-897", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "6217ba0a71554c00695601a8", "resolution": "Done", "resolutionDate": "2018-12-10T10:13:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "puppet query url parameter may not have path at url", "timeSpent": "PT0S", "updated": "2018-12-10T10:13:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:d3df6504-2a03-49ea-8d6b-9a18d77e1e85", "body": "Now that powershell external facts can return json it would be great to have this reflected in the documentation. ", "created": "2018-10-24T17:27:00.000000" }, { "author": "557058:bb372eb8-0089-49ba-8b22-213d5bf560f6", "body": "Big +1 to this ticket. Some simple examples of using BASH/Powershell to output arrays, hashes, and booleans would be good.\n\nCould start with simply documenting the tests used in Facter's acceptances tests: https://github.com/puppetlabs/facter/blob/master/acceptance/tests/external_facts/structured_executable_facts.rb\n\nA recent Slack conversation led me to providing this example:\n{code}\n[root@agent facts.d]# pwd\n/etc/puppetlabs/facter/facts.d\n\n[root@agent facts.d]# ls -l test.sh\n-rwxr-xr-x. 1 root root 62 Feb 19 22:50 test.sh\n\n[root@agent facts.d]# cat test.sh\n#!/bin/bash\necho '{ \"some_array\": [ \"foo\", \"bar\", \"baz\" ] }'\n\n[root@agent facts.d]# facter some_array\n[\n \"foo\",\n \"bar\",\n \"baz\"\n]\n{code}", "created": "2019-02-19T16:04:00.000000" }, { "author": "557058:aa277a93-6688-4f34-ad9d-e53477acf74b", "body": "This feature was added for UNIX executables in Facter 3.5.0 and for Windows executables in Facter 3.9.4", "created": "2019-06-13T15:12:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "The ask here is (I think) to document how custom executable facts can output structured fact data in json format. \n\nTo document this, we need some more information:\n* why might I, as the user, want structured fact data?\n* how do I get structured fact data in json format? There's an example above, but it's not clear to me what's happening in it or what the steps are to get this output.\n* examples for *nix and Powershell would be great.", "created": "2019-07-02T12:59:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "To resolve this, we've added statements to the executable fact sections based on the original release note for this feature:\n\nCustom executable external facts can return data in YAML or JSON format, and Facter parses it into a structured fact. If the returned value is not YAML, Facter falls back to parsing it as a key-value pair.", "created": "2020-01-31T17:11:00.000000" } ], "components": [ "Facter" ], "created": "2018-08-17T13:26:00.000000", "creator": "70121:b72c16a2-594d-45f8-90bc-c6bc6c9510a8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@10aa3d42" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzpa1b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "24/Oct/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_350134481_*|*_5_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_18421891847_*|*_10005_*:*_1_*:*_27209892686" } ], "description": "The documentation for external structured facts describes a top-level hash object containing keys that indicate facts to merge into the result:\n\nhttps://puppet.com/docs/puppet/6.4/external_facts.html\n\nThe sections for \"Executable facts on Unix\" and \"Executable facts on Windows\" don't reference this to explain how they behave when JSON/YAML output is desired. This should be improved so that it's clearer that one cannot use the {{key=value}} output format to create structured data in Facter.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54880", "fixedVersions": [], "id": "54880", "issueType": "Improvement", "key": "DOCUMENT-1017", "labels": [ "facter", "medium" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:b72c16a2-594d-45f8-90bc-c6bc6c9510a8", "resolution": "Fixed", "resolutionDate": "2020-01-31T17:11:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Provide better documentation on structured executable facts", "timeSpent": "PT0S", "updated": "2020-01-31T17:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Fix committed, will be included in the latest docs after merge and docs site build.\u00a0", "created": "2020-02-21T11:21:00.000000" } ], "components": [], "created": "2018-08-12T10:55:00.000000", "creator": "5a27386ae894cb132188f988", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@59126944" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzp50v:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "21/Feb/20" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_87060150_*|*_3_*:*_1_*:*_775371_*|*_5_*:*_1_*:*_0_*|*_10006_*:*_1_*:*_4114257_*|*_10005_*:*_1_*:*_48124444625" } ], "description": "This is related to\u00a0https://puppet.com/docs/puppet/5.5/lang_conditional.html#behavior-3\n\n{quote}\nIf none of the cases match, Puppet will\u00a0*fail compilation with an error.*\n{quote}\n\nThe example has a {{default}} case specified and the statement above implies that there will still be a compilation error if the fact is not matched. In actual fact a compilation error will occur if no cases match *and* the default case is not present.\n\nI recommend a clarification such as:\n\n{quote}\n\u00a0If none of the cases match, Puppet will\u00a0*fail compilation with an error* unless a {{default}} case is also provided.\n{quote}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54089", "fixedVersions": [], "id": "54089", "issueType": "Bug", "key": "DOCUMENT-896", "labels": [ "docs-hack", "lang", "puppet", "small" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a27386ae894cb132188f988", "resolution": "Fixed", "resolutionDate": "2020-02-21T11:22:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Behavior for Selectors in language conditionals is misleading", "timeSpent": "PT0S", "updated": "2020-02-21T11:22:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [ { "attacher": "557058:16f02053-bcf4-45a4-a7c7-c68ecce50db8", "created": "2018-08-08T09:35:00.000000", "name": "image-2018-08-08-16-34-59-873.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14244" } ], "comments": [], "components": [ "Puppet Client/Agent" ], "created": "2018-08-08T09:35:00.000000", "creator": "557058:16f02053-bcf4-45a4-a7c7-c68ecce50db8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@3a21451f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzp21z:" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_437521397_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_8230234487" } ], "description": "I'm looking at the component versions in the puppet-agent here https://puppet.com/docs/puppet/5.5/about_agent.html. It looks like there may be a typo in the version of puppet in the latest agent.\n\n\u00a0\n\n!image-2018-08-08-16-34-59-873.png|width=820,height=434!", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54992", "fixedVersions": [], "id": "54992", "issueType": "Bug", "key": "DOCUMENT-895", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:16f02053-bcf4-45a4-a7c7-c68ecce50db8", "resolution": "Fixed", "resolutionDate": "2018-11-16T16:17:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Error in contents of puppet-agent 5.5.3", "timeSpent": "PT0S", "updated": "2018-11-16T16:17:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:79a6b455-622c-4839-88ba-d3ee205f72b0] The pertinent information is still present on the Grouping and classifying nodes page. It was just rewritten and reorganized to be more direct and succinct. People hate paragraphs of info, so I tried to edit it down to just the key details.\n\nIf you haven't already, please have a read through the first three sections of [https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html]\u00a0(up to Create node groups), and let me know if there's specific info that you think is missing.", "created": "2018-08-06T10:25:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "I believe for PS general use case the first line just needs \"In Puppet Enterprise (PE), you configure your nodes by assigning classes, parameters, and variables to them. This is called\u00a0_classification_.\" restoring to and an anchor adding!\u00a0\n\nThe current first-line does\u00a0not clarify what classification is or what is meant by classifying it suggests it is an activity that includes the next three actions, PS use case is defining or telling customers exactly what we mean by a word, or objective. I was literally looking to be able to hyperlink the description from a leave behind doc as we always have done. i.e classification ([https://puppet.com/docs/pe/2017.1/console_classes_groups_getting_started.html#what-is-classification]\u00a0) ...\u00a0", "created": "2018-08-07T02:06:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Okay, I changed the first sentence on that page from:\n * _Classification_ involves assigning classes, parameters, and variables to nodes.\n\nto:\n * Configure nodes by assigning classes, parameters, and variables to them. This is called _classification_.\n\nThis explanation is part of the page-level overview, which by design doesn't have an anchor link. The link for the overview is the main page link, [https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html.]\n\nIf you want to link to a definition, perhaps the glossary would be helpful:\u00a0[https://docs.puppet.com/references/glossary.html#classify]\n(FYI, we have a ticket about updating and moving the glossary to puppet.com/docs.)", "created": "2018-08-07T10:16:00.000000" } ], "components": [], "created": "2018-08-06T05:40:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@b9bd12a" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzoow7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_17148734_*|*_3_*:*_1_*:*_963905_*|*_5_*:*_1_*:*_1216482853_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_84864798" } ], "description": "the following page [https://puppet.com/docs/pe/2017.1/console_classes_groups_getting_started.html#what-is-classification]\u00a0seems to be lost in 2018.1 ?\u00a0\nwe talk about classification trhough\u00a0out the docs but the definition of classification for context is not in the\u00a02018.1 docs or if it is it's lost/afloat.\nThe page should appear in context of [https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html|https://puppet.com/docs/pe/2018.1/grouping_and_classifying_nodes.html#concept-2930]", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55102", "fixedVersions": [], "id": "55102", "issueType": "Bug", "key": "DOCUMENT-894", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Classification page seems to have dropped out of context in 2018.1 docs", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "The work for this in Puppet Server is already complete: [https://github.com/puppetlabs/puppetserver/pull/1736]\n\nPlease assess this ticket for any potential PE docs impact as well. I don't know if the PE installer team is aware of the underlying issue and plans to address it differently. PE 2018.1.3 included support for Ubuntu 18.04.\n\nIf there were no plans to change the PE installer's behavior to address this, the most relevant PE doc to update when Ubuntu 18.04 support is added appears to be [https://puppet.com/docs/pe/2018.1/supported_operating_systems.html#ubuntu-dependencies], which would need to both note the\u00a0{{openjdk-8-jre-headless}} dependency and note that the universe repository is required to install that package.", "created": "2018-08-01T09:13:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Zak Kent filed a PR to resolve this on PDB: https://github.com/puppetlabs/puppetdb/pull/2529", "created": "2018-08-01T17:36:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Updated Ubuntu dependencies topic in PE docs.\u00a0\n\ncc [~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100] for visibility on the Installer team.\u00a0", "created": "2018-08-06T15:37:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "It looks like the PDB PR has been merged too, so I'm marking this resolved.", "created": "2018-08-06T15:38:00.000000" } ], "components": [], "created": "2018-08-01T09:09:00.000000", "creator": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Server, DB, and if necessary PE docs all note that the universe repository must be enabled prior to installing Puppet Platform or PE on Ubuntu 18.04." }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@536760f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzom9b:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "06/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_436777357_*|*_5_*:*_1_*:*_1283541813_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_18580565" } ], "description": "When installing the latest Puppet Platform 5.5.x products that require Java (Puppet Server, PuppetDB) on Ubuntu 18.04, the required {{openjdk-8-jre-headless}} package are not present in Ubuntu's default repositories if the universe repository isn't enabled during OS install.\n\nThis does not raise issues in tests because our testing images are deployed with universe enabled. However, this can block installation on some default Ubuntu installations (see SERVER-2266).\n\nNote in these products' documentation that the universe repository is required for installation on Ubuntu 18.04.\n\nIf necessary, also note [the {{openjdk-8-jre-headless}} dependency in PE 2018.1.3|https://puppet.com/docs/pe/2018.1/supported_operating_systems.html#ubuntu-dependencies] and that the universe repository is required to install it. It is currently unclear whether this is necessary, since PE should ship with its own vendored Java, but our docs suggest a current dependency.\n\nThis _does not_ affect prior versions of Ubuntu, Puppet, or PE.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54783", "fixedVersions": [], "id": "54783", "issueType": "Bug", "key": "DOCUMENT-893", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Ubuntu 18.04 needs universe repo to install Java dependencies", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [ { "attacher": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "created": "2018-08-30T13:15:00.000000", "name": "Screen Shot 2018-08-30 at 11.56.52 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14270" }, { "attacher": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "created": "2018-08-30T13:14:00.000000", "name": "Screen Shot 2018-08-30 at 11.57.23 AM.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14257" }, { "attacher": "557058:0ecc452a-d349-4da1-b879-da696febc871", "created": "2018-08-13T11:38:00.000000", "name": "image-2018-08-13-10-38-17-549.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14215" }, { "attacher": "557058:0ecc452a-d349-4da1-b879-da696febc871", "created": "2018-08-13T11:39:00.000000", "name": "image-2018-08-13-10-39-23-845.png", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14225" } ], "comments": [ { "author": "557058:0ecc452a-d349-4da1-b879-da696febc871", "body": "[~accountid:557058:8f1e0495-1d4a-4123-bbad-727b7f49f370] did you perhaps accidentally remove some directories with commit [ a963662,|https://github.com/puppetlabs/puppet-docs/commit/a963662765f682f5c10a3b58e26b84a1499d0483] made around 5 days ago?", "created": "2018-07-31T18:32:00.000000" }, { "author": "557058:8f1e0495-1d4a-4123-bbad-727b7f49f370", "body": "Hi [~accountid:557058:0ecc452a-d349-4da1-b879-da696febc871], it wasn't a mistake, they have all been migrated to puppet.com/docs\n\n\u00a0\n\n[~accountid:557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1] looks like you might've forgotten docs.puppet.com redirects?\n\n[~accountid:623a4bf0761efb0069cd36c2] I can navigate to 3.8 docs on puppet.com/docs if I know the URL, but they don't appear in the drop downs, is this on purpose? Users are trying to access these docs and they're not readily visible when browsing.", "created": "2018-08-01T07:30:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:8f1e0495-1d4a-4123-bbad-727b7f49f370] - Yes. I'll add them now.\u00a0\n\n[~accountid:623a4bf0761efb0069cd36c2] - I think we should go ahead and add the versions we moved over to puppet.com/docs to the version drop down, because there are still many thousands of hits on those pages.", "created": "2018-08-01T08:28:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:0ecc452a-d349-4da1-b879-da696febc871] - Thanks for the ticket!\n\nHere are links to those versions. We moved them because they are still actively used. However, we are still not updating them.\n\n\u00a0\n\n[https://puppet.com/docs/puppet/3.8/index.html]\n\n[https://puppet.com/docs/puppetdb/2.3/index.html]\n\n[https://puppet.com/docs/facter/2.4/index.html]\n\n\u00a0", "created": "2018-08-01T08:54:00.000000" }, { "author": "557058:0ecc452a-d349-4da1-b879-da696febc871", "body": "> Here are links to those versions. We moved them because they are still actively used.\n\nThanks. I understand what happened now-- they simply aren't in the dropdown menu.\n\n\u00a0\n\n> However, we are still not updating them.\n\nYup! Understood, thank you.", "created": "2018-08-01T15:42:00.000000" }, { "author": "557058:0ecc452a-d349-4da1-b879-da696febc871", "body": "Hi folks,\n\nI noticed that 3.8 still does not show up in the default dropdown menu, as shown in the screenshot below. Is that an oversight?\n\n\u00a0\n\n\u00a0\n\n!image-2018-08-13-10-39-23-845.png!\n\n\u00a0", "created": "2018-08-13T11:42:00.000000" }, { "author": "557058:0ecc452a-d349-4da1-b879-da696febc871", "body": "Oh whoops, I just noticed that Michelle closed this 35 minutes ago. Any recent change will take a bit of time to reach production. I'll re-close and will re-open if it's still an issue later. Sorry for the crossed wires.", "created": "2018-08-13T11:51:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:0ecc452a-d349-4da1-b879-da696febc871] - Puppet and PE 3.8 versions are now on the drop-down menu (version switcher). Not sure when this was added. But if you don't see it maybe try re-opening the site.", "created": "2018-08-13T14:06:00.000000" }, { "author": "557058:0ecc452a-d349-4da1-b879-da696febc871", "body": "The Puppet 3.8 software still does not appear in the menu, as shown in the screenshot above. I've tried three different browsers, including one that I never use (and thus no cache)\n\nSteps to reproduce:\n # Visit [https://puppet.com/docs/puppet/5.5/puppet_index.html] [https://puppet.com/docs/facter/3.11/index.html] & https://puppet.com/docs/puppetdb/5.2/index.html\n # Open the dropdown menu.\n # Notice that Puppet 3.8, Facter 2.4 & PuppetDB 3.3 are not listed.", "created": "2018-08-29T12:30:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "Hi [~accountid:557058:0ecc452a-d349-4da1-b879-da696febc871] - that is so weird! I can see these versions on the drop-down, but several of my team mates cannot, like you. I have filed a ticket with our web team, and will see what is causing this strange behavior. Thanks for reopening the issue! I attached some screen shots for demonstration.\n\n\u00a0", "created": "2018-08-30T13:16:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1] , ping!", "created": "2019-02-07T14:29:00.000000" }, { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:0ecc452a-d349-4da1-b879-da696febc871] - Sorry for the delay. Puppet 3.8 docs are purposely not included on the drop-down because they are technically not supported, and our site settings dictate this - we publish them because they're needed for upgrade purposes, but we don't update them. So I'm going to close as won't fix, because it's caused by a web site configuration.\u00a0", "created": "2019-02-11T12:59:00.000000" } ], "components": [], "created": "2018-07-31T18:30:00.000000", "creator": "557058:0ecc452a-d349-4da1-b879-da696febc871", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5526e65d" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzolwn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_2_*:*_1096639085_*|*_4_*:*_2_*:*_14348483557_*|*_5_*:*_1_*:*_6169_*|*_6_*:*_3_*:*_1386645216" } ], "description": "A number of docs for the legacy Puppet 3.8 are missing from [https://docs.puppet.com/] . They were present in early July, but are missing today.\n\n\u00a0\n\nHere are a list of top level pages which I believe are missing:\n * [https://docs.puppet.com/puppet/3.8/]\n * [https://docs.puppet.com/puppetdb/2.3/]\n * [https://docs.puppet.com/facter/2.4/]\n\nCuriously, the older docs for the previous release (for Puppet 3.7, PuppetDB 2.2, Facter 2.3 and older) are still present.\n\n\u00a0\n\nI realize that Puppet 3.8 was deprecated a while ago, and I realize that the new Documentation site for is at [https://puppet.com/docs]. However, the older Puppet 3.8 docs are still needed, especially by folks who want to upgrade from Puppet 3.x to Puppet 4 or 5.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54782", "fixedVersions": [], "id": "54782", "issueType": "Bug", "key": "DOCUMENT-892", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0ecc452a-d349-4da1-b879-da696febc871", "resolution": "Won't Do", "resolutionDate": "2019-02-11T13:00:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet 3.8 docs are missing", "timeSpent": "PT0S", "updated": "2019-02-11T13:00:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "623a4bf0761efb0069cd36c2", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:623a4bf0761efb0069cd36c2] - is this something you can handle on the web side?", "created": "2018-07-30T11:09:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Closing this ticket because a) it should be a WEB ticket, and b) the Web team is getting a new search provider which should hopefully resolve this issue.", "created": "2019-01-22T11:10:00.000000" } ], "components": [ "Hiera" ], "created": "2018-07-25T15:47:00.000000", "creator": "557058:d6870b2a-8ac5-4232-984e-0a28f1b3fe28", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@71273a25" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzohhj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "30/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_415304431_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_15210101050" } ], "description": "I needed information about hiera 5 lookups, so I went to puppet.com, clicked on the magnifying glass, and typed in \"hiera lookups\".\u00a0 I then clicked on the boxes next to \"Documenation\" and \"Hiera (PE and open source)\"\n\nThis produced 34 documents, none of them about Hiera 5.\u00a0 They were all Hiera 1 or Hiera 3 documents.\n\nI unchecked \"Hiera (PE and open source)\" and checked \"Puppet (PE and open source)\", and now I got all the Hiera 5 documentation I could ask for.\n\nIt would be nice if all Hiera 5 documentation was indexed as such so that selecting the \"Hiera (PE and open source)\" check box included Hiera 5 documentation as well.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54990", "fixedVersions": [], "id": "54990", "issueType": "Bug", "key": "DOCUMENT-891", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:d6870b2a-8ac5-4232-984e-0a28f1b3fe28", "resolution": "Incomplete", "resolutionDate": "2019-01-22T11:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Hiera 5 documentation not indexed as \"Hiera\" at puppet.com/search", "timeSpent": "PT0S", "updated": "2019-01-22T11:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "The info that Branan and I updated is now live here: [https://puppet.com/docs/facter/3.11/custom_facts.html#execution-timeouts]\n\nIn working on this issue, we identified a need for troubleshooting and API documentation that we are adding to the Facter product team plan.\u00a0", "created": "2018-08-16T17:11:00.000000" }, { "author": "70121:b72c16a2-594d-45f8-90bc-c6bc6c9510a8", "body": "I've filed FACT-1877 and FACT-1878 to track net-new docs for Facter that need to be written. These will likely need to be initially tackled by the Platform OS team engineers. They're on our triage board and will be prioritized soon.", "created": "2018-08-20T08:49:00.000000" } ], "components": [], "created": "2018-07-24T09:04:00.000000", "creator": "557058:35060490-aa27-40a2-b587-eca7672140c8", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@70404ddc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzofon:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_525903064_*|*_5_*:*_1_*:*_413931295_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1490523535" } ], "description": "I am a developer of non-trivial custom facts. When I follow the [execution timeouts example in the walkthrough|https://puppet.com/docs/facter/3.11/custom_facts.html#execution-timeouts], it results in error messages being provided as fact values in the case of an exception. (This is bad when the desire is to convey troubleshooting information)\n\nA general approach would be to add troubleshooting or debugging information to the rescue portion of the code. Here is a trivial example:\n\n{code:ruby}\nrescue Facter::Core::Execution::ExecutionFailure => exception\nputs \"#{puppet_module} ruby fact threw an exception: #{exception}\"\n{code}\nWhen I use puts (to print to the screen) it causes irregular data to appear in the facts, and will render broken JSON or YAML (if requested)\n\nThe documentation should provide some reasonable options for situations like this, which may include:\n\n1. Sending the error to STDERR\n2. Sending the error to syslog\n3. Sending the error to PuppetDB (assumes an easy way to retrieve failing fact runs)\n\nThis would make the facts easier to manage and maintain as my Puppet codebase grows and my puppet estate grows to include systems or edge cases that may not have been considered when the fact was written originally.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54505", "fixedVersions": [], "id": "54505", "issueType": "New Feature", "key": "DOCUMENT-890", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:35060490-aa27-40a2-b587-eca7672140c8", "resolution": "Done", "resolutionDate": "2018-08-21T12:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Troubleshooting options should be added to facts walkthrough", "timeSpent": "PT0S", "updated": "2018-08-21T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Linking SERVER-2253, which requests a change to the setting's behavior.\n\nServer docs updates often correspond to Server releases because the source of our docs site's content is the {{documentation}} directory in the Puppet Server code repository. I'll write up a PR for this ticket, but the results might not be published to the docs site until the next Server release.\n\nAlso, if the next Server release changes this setting's behavior to align with what's already documented, the docs changes requested here wouldn't be necessary (or might be made redundant by any docs changes required by SERVER-2253) and this ticket should be closed.", "created": "2018-07-23T11:59:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Filed [Server PR #1734 against the 5.3.x branch|https://github.com/puppetlabs/puppetserver/pull/1734].", "created": "2018-07-23T12:11:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "PR merged, should expect the change to go live within 24 hours pending the next docs build.", "created": "2018-08-10T13:51:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Confirmed live on the docs site at https://puppet.com/docs/puppetserver/5.3/config_file_puppetserver.html", "created": "2018-08-13T12:57:00.000000" } ], "components": [], "created": "2018-07-17T10:55:00.000000", "creator": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@21039cb1" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo9s7:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "23/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_255980154_*|*_1_*:*_1_*:*_519244256_*|*_10007_*:*_1_*:*_1561444141_*|*_3_*:*_1_*:*_2748_*|*_5_*:*_1_*:*_688437784_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_3415982" } ], "description": "After some research it turns out that this profiling option does not enable profiling all of the puppet-server jruby code. Instead, it only profiles the single thread that starts the puppet-server service and none of the child threads. After a quick hipchat discussion with puppet server team we decided for now we should just update the docs, and create SERVER-2253 to explore options with that setting in the future.\n\nhttps://puppet.com/docs/puppetserver/5.3/config_file_puppetserver.html\n\nThe descriptions for this option should be updated to something like:\n\nprofiling-mode: Optional. Used to enable JRuby\u2019s profiler for service startup and set it to one of the supported modes. The default value is off, but it can be set to one of api, flat, graph, html, json, off, and service. See ruby-prof for details on what the various modes do.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54388", "fixedVersions": [], "id": "54388", "issueType": "Improvement", "key": "DOCUMENT-889", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Puppet Server docs for jruby-settings 'profiling-mode'", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:79a6b455-622c-4839-88ba-d3ee205f72b0]\u00a0Is this just intended to be informational, or do users actually need to do anything with this list (e.g., add it to trusted sites in their browser or something)?\n\nAlso, could you clarify why you wanted to link to the OSP docs? I see only one mention of downloads.puppetlabs.com on that page and it's about verifying the tarball, which is documented in PE:\u00a0https://puppet.com/docs/pe/2018.1/installing_pe.html#download-an-installation-package", "created": "2018-07-16T12:56:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "OSP page documents the repos\u00a0too, which if a user can't provide a dedicated network outbound path to the list of urls\u00a0they will need to be able to recover the packages for Puppet agents, hence i suggested the link instead of duplicating\u00a0the urls.\n\nThe list was meant to be informational in the context of here is a list of URls that you may wish to ensure are reachable from your network provisioning for a puppet infrastructure and be aware Puppet calls them at various stages of the implementation and management of configuration.", "created": "2018-07-16T13:49:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:79a6b455-622c-4839-88ba-d3ee205f72b0] How's this?\u00a0\n\n[https://docs-preview.webteam.puppet.com/docs/pe/2018.1.z/system_configuration.html#reference-7476]\n\n(Credentials here:\u00a0https://confluence.puppetlabs.com/pages/viewpage.action?spaceKey=COM&title=Puppet.com+access)", "created": "2018-07-16T16:24:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] I'm going to ping Dylan on this as it was is want to compile the list :D [~accountid:557058:afa80a20-2814-4f2f-bbdd-ad5db4190123]^ take a look and see if this fulfills your want :D", "created": "2018-07-18T05:21:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] but works for me in the regard the request.\u00a0", "created": "2018-07-18T05:23:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "I'm going to merge this change and resolve the ticket tomorrow unless I hear otherwise that additional work is needed.\n\nThanks!", "created": "2018-07-19T14:00:00.000000" }, { "author": "557058:89652935-bbd6-4e26-afbf-0a04063f7db8", "body": "[~accountid:557058:c9b48d3b-3b16-4fba-80cb-daf19743b953] it should be rubygems.org, not rubugems.org\u00a0", "created": "2018-07-20T03:38:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Fixed.^\u00a0", "created": "2018-07-20T09:58:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Customer asks: This page suggests that there are five web sites it might be good to allow our installation to have access to through our firewall. I am being asked to justify these sites. Can you help me explain the use of these sites?\u00a0", "created": "2019-05-15T11:21:00.000000" }, { "author": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "body": "[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d]\n * [forgeapi.puppet.com|http://forgeapi.puppet.com/], if they want to autonomously deploy forge modules and not use a alternative mechanism to manually provide them\n * [pm.puppetlabs.com, required for upgrade and update, again can be wokred around by hand.\u00a0|http://pm.puppetlabs.com/]\n * [rubygems.org, dependency of external modules|http://rubygems.org/]\n * [github.com, source for external code|http://github.com/]\n * [s3.amazonaws.com, the actual service behind PM. and forge packages, so required to support those two.\u00a0|http://s3.amazonaws.com/]", "created": "2019-05-15T11:47:00.000000" }, { "author": "557058:ea8d8852-0291-4b62-9047-0e4b235efa5d", "body": "Thanks Adam!\n\nI've relayed the same and am hoping we can update the documentation to forestall future questions.\u00a0\u00a0", "created": "2019-05-15T11:53:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "[~accountid:557058:ea8d8852-0291-4b62-9047-0e4b235efa5d] Would you mind opening a new docs ticket to add the use/purpose for these sites? Thanks!", "created": "2019-05-15T11:58:00.000000" } ], "components": [], "created": "2018-07-12T03:39:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1575bd41" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo76v:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_26316080_*|*_10009_*:*_1_*:*_322406874_*|*_5_*:*_1_*:*_2772745212_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_8047399_*|*_10005_*:*_2_*:*_357141360" } ], "description": "[~accountid:557058:afa80a20-2814-4f2f-bbdd-ad5db4190123] compiled this list with PS from experience on deployment of desirable internet locations for Puppet deployment and management;\n * [forgeapi.puppet.com|http://forgeapi.puppet.com/]\n * [pm.puppetlabs.com|http://pm.puppetlabs.com/]\n * [rubygems.org|http://rubygems.org/]\n * [github.com|http://github.com/]\n * [s3.amazonaws.com|http://s3.amazonaws.com/]\n\nthe\u00a0The [https://puppet.com/docs/pe/2018.1/installing/system_configuration.html#system-configuration]\u00a0 page should be updated with an `optional` section listing these urls\u00a0and linking to\u00a0[https://puppet.com/docs/puppet/5.3/puppet_platform.html]\u00a0(as this provided documentation of downloads.puppetlabs.com).", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54088", "fixedVersions": [], "id": "54088", "issueType": "Improvement", "key": "DOCUMENT-888", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Done", "resolutionDate": "2018-08-21T12:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Has a puppet Infrastructure Admin I would like to know all the external web urls that should be available to Puppet Enterprise for deployment and use. ", "timeSpent": "PT0S", "updated": "2019-05-16T16:02:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": null, "attachments": [], "comments": [ { "author": "557058:7edde36a-845c-4e08-9172-c7b2f0265ea1", "body": "This is valid, but is a small part of a bigger project to move relevant content to our new multi-product architecture, source format, and build pipeline. I've created a ticket DIP-81 to size and assign that work, marking this as a dup of that.", "created": "2018-07-13T11:20:00.000000" } ], "components": [ "Website & IA" ], "created": "2018-07-10T17:38:00.000000", "creator": "5a6649d80f236c260941c7ee", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@16ec7447" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo5tj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "13/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_236526282_*|*_6_*:*_1_*:*_0" } ], "description": "\"Glossary Puppet Vocabulary\" still under our old URL:\n * [https://docs.puppet.com/references/glossary.html]\n\nOn this website we point to our updated Puppet Docs:\n * [https://puppet.com/docs]\n\nBut there, you cannot find the glossary at all. Wouldn't it make sense to move the glossary.html directly under the new puppet.com/docs?\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55101", "fixedVersions": [], "id": "55101", "issueType": "Improvement", "key": "DOCUMENT-886", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "5a6649d80f236c260941c7ee", "resolution": "Duplicate", "resolutionDate": "2018-07-13T11:20:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "\"Glossary Puppet Vocabulary\" still under our old URL. Move under Puppet.com/docs", "timeSpent": "PT0S", "updated": "2018-07-13T11:21:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:6fc1f430-f771-4686-a97e-21c5e35f9100", "body": "you can just divide the 16 cores by 32 GB RAM = 4000 to come to numbers in the middle. \n\nFor example, If you divide by 4 you can get 4 cores by 8 GB RAM = 1000 and that's roughly correct. Since 2 by 6 is the minimum obviously it doesn't divide much further. \n\nif you divide by 2 you can get 8 cores by 16 GB RAM = 2000. \n\nI wouldn't have any problems adding those two rows to the table however, I'm moderately sure recent numbers show that 16 by 32 GB RAM goes more like 6 or 7K. \n\n[~accountid:557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715] any reason we can't update the hardware reqs with our newer numbers? ", "created": "2018-07-16T17:07:00.000000" }, { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks for the numbers [~accountid:557058:6fc1f430-f771-4686-a97e-21c5e35f9100]. I added the following tip to the hardware requirements page:\n\nTip: For mid-sized deployments that fall between ranges, you can proportionately scale back the required cores and RAM. For example, internal testing shows that 16 cores and 32 GB RAM accommodates at least 4,000 nodes. You can divide these requirements by 4 to come to 4 cores and 8 GB RAM for 1,000 nodes, or by 2 to come to 8 cores and 16 GB RAM for 2,000 nodes.\u00a0", "created": "2018-07-20T10:32:00.000000" }, { "author": "557058:e346dd15-0cb4-4ff2-a5d8-46553d04e715", "body": "[~accountid:557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0] [~accountid:557058:45fa3568-deb5-4da5-b894-a1ec07f1c138] any opinions on these numbers and their publishing?", "created": "2018-07-23T12:28:00.000000" }, { "author": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "body": "I'm not sure that we have explicitly tested that, perhaps CS has tested it in the field though?", "created": "2018-07-23T12:53:00.000000" }, { "author": "557058:6fc1f430-f771-4686-a97e-21c5e35f9100", "body": "During the perf testing I helped with for OpsWorks, the numbers came out pretty much exactly as you'd expect using division like above. \n\nHowever, I think our most recent numbers show something closer to 6 or 7k for 16 cores by 32 GB RAM. That the question is if we can update to those numbers. ", "created": "2018-07-23T13:20:00.000000" } ], "components": [ "Configuration Management" ], "created": "2018-07-10T07:43:00.000000", "creator": "70121:c6af8dfb-036d-429f-a570-2b71c6c52c2d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5fd95c74" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo53b:" }, { "fieldName": "Release Notes", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "New Feature" }, { "fieldName": "Release Notes Summary", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "For a Customer (Penguin Random House) wanting to setup a small-ish PE Test environment with ca. 200 max Windows AWS nodes, what size AWS instance would we recommend?\nThe documentation page listed below provides indication for either \"fewer than 10\" or \"up to 4,000\" but 200 is nowhere near 4,000!\nhttps://puppet.com/docs/pe/2018.1/installing/hardware_requirements.html#monolithic-installation-hardware-requirements\n\nThe Puppet code will be relatively minimal to begin with and will mostly be tailored at AWS instances building/hardening.\n\nRecommendations from Puppet Professional Services is 4 or more vCPUs and 8GB of memory at least. Would it be possible to have a little more granularity on the minimal specs for a few varying volumes of manages nodes?\n\nMany thanks in advance\nDario" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_112501065_*|*_5_*:*_1_*:*_2770740252_*|*_6_*:*_1_*:*_0_*|*_10004_*:*_1_*:*_322594781_*|*_10005_*:*_1_*:*_439064622" } ], "description": "For a Customer (Penguin Random House) wanting to setup a small-ish PE Test environment with ca. 200 max Windows AWS nodes, what size AWS instance would we recommend?\nThe documentation page listed below provides indication for either \"fewer than 10\" or \"up to 4,000\" but 200 is nowhere near 4,000!\nhttps://puppet.com/docs/pe/2018.1/installing/hardware_requirements.html#monolithic-installation-hardware-requirements\n\nThe Puppet code will be relatively minimal to begin with and will mostly be tailored at AWS instances building/hardening.\n\nRecommendations from Puppet Professional Services is 4 or more vCPUs and 8GB of memory at least. Would it be possible to have a little more granularity on the minimal specs for a few varying volumes of manages nodes?\n\nMany thanks in advance\nDario", "environment": "any", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54387", "fixedVersions": [], "id": "54387", "issueType": "Improvement", "key": "DOCUMENT-885", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:c6af8dfb-036d-429f-a570-2b71c6c52c2d", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "More detail about minimal hardware requirements for monolithic PE deployments", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "The documentation has been updated:\u00a0[https://puppet.com/docs/puppet/5.5/config_file_device.html]\n\n\u00a0", "created": "2018-07-19T20:24:00.000000" } ], "components": [], "created": "2018-07-10T07:11:00.000000", "creator": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@67fe7a7f" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo533:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "20/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_532594039_*|*_5_*:*_1_*:*_2821556488_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_292613819" } ], "description": "[https://puppet.com/docs/puppet/5.5/config_file_device.html]\n\nIt specifies username:password@url format. If the password has an \"@\" character in it, the puppet device invocation will fail with this sort of thing:\n\n{code}\n$ puppet device -v --user=apiuser\nError: Could not run: https://apiuser:p@ssword@device.com is an invalid url\n{code}\n\nHowever we can url-encode the \"@\" to \"%40\" in the config file (\"p%40ssword\") which works, and that would be a snazzy addition to the docs.\n\n{code}\n[bigip]\ntype f5\nurl https://apiuser:p%40ssword@device.com/\n{code}\n\nFiling this as minor because people can figure out that since it's a url it might accept url encoding, but it's not really obvious so it's not trivial.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54317", "fixedVersions": [], "id": "54317", "issueType": "Improvement", "key": "DOCUMENT-884", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Minor", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "resolution": "Done", "resolutionDate": "2018-08-21T12:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "mention url encoding in device.conf docs", "timeSpent": "PT0S", "updated": "2018-08-21T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This was fixed a few days ago when that page was update. Thanks!", "created": "2018-07-09T11:12:00.000000" } ], "components": [], "created": "2018-07-04T09:34:00.000000", "creator": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@12c57a2c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzo2x3:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "09/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_437542259_*|*_5_*:*_1_*:*_3718727865_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_316254" } ], "description": "[https://puppet.com/docs/puppet/5.5/hiera_merging.html#lookup-options-format]\n\n\"This only reserved key in Hiera.\"\n\nThat should likely be:\n\n\"This is the only reserved key in Hiera.\"", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54649", "fixedVersions": [], "id": "54649", "issueType": "Bug", "key": "DOCUMENT-883", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "grammar in lookup_options format section", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "body": "Thanks for helping improve docs!\n\nThis is fixed in 2018.1 and later. I also tried to clarify our use of agent packages vs. agent tarball \u2013 hopefully I got it right.\u00a0", "created": "2018-07-19T16:22:00.000000" } ], "components": [], "created": "2018-06-28T03:54:00.000000", "creator": "557058:971ba3ac-d04a-4e49-98fa-a110b38e2528", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Acceptance Criteria", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "value": "Update the documents with the aforementioned suggestions and clarify the process\u00a0" }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@69df5472" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznywv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "19/Jul/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_115497950_*|*_3_*:*_1_*:*_402754_*|*_5_*:*_1_*:*_2836092003_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1743430776" } ], "description": "In the section to install the puppet agent by manually downloading the agent packages, the steps aren't really clear and caused me great confusion to get the process to work, I feel that there is a lot of room for improvement here and make it easier to understand for folks who have never used this method to install puppet\n\nFrom: [https://puppet.com/docs/pe/2018.1/installing/installing_agents.html#install-agents-without-curl-k]\n\n\u00a0\n{noformat}Install\u00a0*nix\u00a0agents without internet access\n\nIf you don't have access to the internet beyond your infrastructure, you can download the appropriate agent package from an internet-connected system and then install using the package management solution of your choice.\n\nBefore you begin\n\nDownload\u00a0the appropriate agent package.\n\nInstall\u00a0*nix\u00a0agents with\u00a0PE\u00a0package management without internet access\n\nUse\u00a0PE\u00a0package management to install agents when you don't have internet access beyond your infrastructure.\n\nNote:\u00a0You must repeat this process each time you upgrade your master.\n\nOn your master, copy the agent package to\u00a0/opt/puppetlabs/server/data/staging/pe_repo-.\n\nFollow the steps for\u00a0Install *nix agents with PE package management.{noformat}\nThis is very misleading to, in particular the copy the agent package to \n\n\u00a0\n\nI feel that there should be more clarity to the fact that you do not move the agent package to that directory, instead you copy the downloaded tarball of the agent package (the tarball contains the files that let filesync do its thing and copy the package to the right place, simply copying the agent package (which I assumed was the .rpm) does not work and will cause this step to fail\n\n\u00a0\n\nAlso - name it puppet version, this again is really really confusing, as the agents now use the puppet version, but before they had their own versions, and this is also confusing due to the fact that this isnt clarified as such, as a user may rename it as the puppet enterprise version\n\nALSO, this is still false as by calling it just by the agent version won't work, it needs to be pre fixed with puppet agent,\u00a0\n\nAND this document completely misses out the fact that you need to run puppet on your master after performing these steps\u00a0\n\n\u00a0\n\nhere is the steps we had to run through with a customer trying to use these docs, as you can see there are a lot of missing steps\n\n\u00a0\n{noformat}Downloaded the el 6 agent tarball from\u00a0https://puppet.com/misc/pe-files/pe_repo/2017.2.2\n\nEnsured the\u00a0/opt/puppetlabs/server/data/staging/pe_repo-puppet-agent-1.10.4/\u00a0directory exists on the MoM.\n\nCopied the tarball into\u00a0/opt/puppetlabs/server/data/staging/pe_repo-puppet-agent-1.10.4/\u00a0on the MoM.\n\nRan\u00a0puppet agent -t\u00a0on the MoM in order to build the distribution.\n\nDownload and ran the installer from the MoM by running\u00a0curl -k https://us01vlpm0001.bottomline.tech:8140/packages/current/install.bash | sudo bash\u00a0on the agent.{noformat}\nSo in summary\n\n\u00a0\n # need to clarify that the whole tarball is copied over\n # need to give more clarification on to what to actually name the tarball (I think an example would be great)\n # explicitly state that you need to run puppet on the master after this, for this to work\u00a0\n\n\u00a0\n\nIf you need suggestions on wording, I am always available to help with this so please don't hesitate to get in touch!\u00a0\n\nThank you!\n\n\u00a0\n\nNicky\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54315", "fixedVersions": [], "id": "54315", "issueType": "Improvement", "key": "DOCUMENT-882", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Major", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:971ba3ac-d04a-4e49-98fa-a110b38e2528", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Improve the installing Puppet docs section", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "I don't see any duplication, so this may have been fixed coincidentally along the way. I did lint and fix the Puppet code this morning though, and that change should be live on the docs site sometime today. Thank you for the ticket!", "created": "2019-02-01T11:57:00.000000" } ], "components": [ "Puppet Client/Agent" ], "created": "2018-06-27T08:11:00.000000", "creator": "557058:e6726ff0-7a50-486d-b5db-41043ba64e4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7ae3e0bf" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznxzr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_442317385_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_18496453847" } ], "description": "On this page:\u00a0https://puppet.com/docs/puppet/5.5/lang_lambdas.html\n\n\u00a0\n * It looks like the \"general form of a lambda\" description has some duplication in the description\n * ALSO, the puppet code in the examples should be lint(ed)\n ** Single quotes for strings without variable interpolation\n ** Curly braces around variables in strings (at least)\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54603", "fixedVersions": [], "id": "54603", "issueType": "Bug", "key": "DOCUMENT-881", "labels": [ "puppet" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e6726ff0-7a50-486d-b5db-41043ba64e4d", "resolution": "Fixed", "resolutionDate": "2019-02-01T11:57:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Fix style and content in Lambda documentation for Puppet ", "timeSpent": "PT0S", "updated": "2019-02-01T11:57:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "[~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] - this one is for you.", "created": "2018-11-16T15:44:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "The docs will be updated in the next build.\u00a0", "created": "2018-11-21T09:25:00.000000" } ], "components": [], "created": "2018-06-27T02:01:00.000000", "creator": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@e9ce696" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznxuv:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "16/Nov/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_464522741_*|*_3_*:*_1_*:*_188870581_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_12077655153" } ], "description": "the page documenting mountpoints [https://puppet.com/docs/puppet/5.5/file_serving.html#whats-a-mount-point-in-a-puppet-uri]\n\ndoes not include a refernce to the fact there is now a tasks mountpoint\u00a0this is discussed in https://puppet.atlassian.net/browse/PUP-8961\u00a0for reference.\u00a0\n\nPlease add an additional bullet point to document tasks mountpoint as a standard mountpoint", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54781", "fixedVersions": [], "id": "54781", "issueType": "Improvement", "key": "DOCUMENT-880", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:79a6b455-622c-4839-88ba-d3ee205f72b0", "resolution": "Fixed", "resolutionDate": "2018-11-21T09:25:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "update the mountpoints documentation to document the existence of the Tasks mountpoint", "timeSpent": "PT0S", "updated": "2018-11-21T09:25:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "attachments": [], "comments": [ { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "This will be fixed in the next build. Thanks for spotting!\u00a0", "created": "2019-02-01T10:15:00.000000" } ], "components": [], "created": "2018-06-26T13:03:00.000000", "creator": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@64ed94cb" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznxbj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_511198682_*|*_10007_*:*_1_*:*_342436573_*|*_3_*:*_1_*:*_520950183_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_17626966580" } ], "description": "The documentation for the jruby profiling output file setting is incorrect. The current documentation shows profiling-output-file while the actual setting name is profiler-output-file. https://puppet.com/docs/puppetserver/5.3/config_file_puppetserver.html\n\nThis has not changed since it was added, and should be updated for all versions that include it.\n\nLink to the setting implementation: https://github.com/puppetlabs/jruby-utils/blob/d8a8f9be9499f78356f5874d41b16cbeb65cc758/src/clj/puppetlabs/services/jruby_pool_manager/jruby_core.clj#L167", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54601", "fixedVersions": [], "id": "54601", "issueType": "Bug", "key": "DOCUMENT-879", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:a69e978d-6cea-49f9-9227-3a3ef8a776c0", "resolution": "Fixed", "resolutionDate": "2019-02-01T10:15:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "profiler-output-file setting incorrectly documented as profiling-output-file in Server docs", "timeSpent": "PT0S", "updated": "2019-02-01T10:15:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "attachments": [], "comments": [ { "author": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "body": "So I think [https://ruby-doc.org/core-2.5.1/Kernel.html]\u00a0is the right link, although [https://idiosyncratic-ruby.com/49-what-the-format.html]\u00a0is actually imminently more readable and useful for mere mortals", "created": "2018-06-21T02:47:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Linking DOC-3488, which was filed internally in February, as a duplicate, and moving to Ready to Merge. [PR #6985 on puppetlabs/puppet|https://github.com/puppetlabs/puppet/pull/6985] should add a link.\n\nThese docs are generated from Puppet code and are a little more complicated to update than other docs, and depend on a Puppet release containing the code changes.", "created": "2018-08-14T10:25:00.000000" }, { "author": "557058:91233464-4152-4228-81dd-172d43a52a03", "body": "Merged in https://github.com/puppetlabs/puppet/commit/bd1656e34250dbf88dc711876cf3867e8f2dbcbf", "created": "2018-08-30T13:31:00.000000" } ], "components": [], "created": "2018-06-21T02:45:00.000000", "creator": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@7671bf77" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznt07:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/Aug/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_6748720416_*|*_1_*:*_1_*:*_375646770_*|*_10007_*:*_1_*:*_1393582972_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_4317530233" } ], "description": "This page: [https://puppet.com/docs/puppet/5.5/function.html#sprintf]\u00a0makes reference to ruby documentation for details about sprintf but does not actually contain a link. You could probably google it but a link is always more precise and quicker.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54878", "fixedVersions": [], "id": "54878", "issueType": "Improvement", "key": "DOCUMENT-877", "labels": [ "generated-docs" ], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "resolution": "Fixed", "resolutionDate": "2018-11-16T15:10:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Documentation refers to ruby Kernel::sprintf documentation but contains no link", "timeSpent": "PT0S", "updated": "2018-11-16T15:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It sure does! Nice catch, thank you for the ticket.", "created": "2019-01-29T14:45:00.000000" } ], "components": [], "created": "2018-06-20T07:44:00.000000", "creator": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@43ccfbb9" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzns2f:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "29/Jan/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_444253862_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_18851801778" } ], "description": "[https://puppet.com/docs/puppet/5.5/lang_type_aliases.html#organizing-type-alias-defintiions]\n\nSeems like that should be \"definitions\", not \"defintiions\".", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54599", "fixedVersions": [], "id": "54599", "issueType": "Improvement", "key": "DOCUMENT-876", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Trivial", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:0fdf0960-cf49-4a2e-b42d-ea0c53f80453", "resolution": "Fixed", "resolutionDate": "2019-01-29T14:45:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Organizing type alias defintiions", "timeSpent": "PT0S", "updated": "2019-01-29T14:45:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "It looks like this was corrected along the way somewhere.", "created": "2019-02-01T11:44:00.000000" } ], "components": [], "created": "2018-06-18T13:14:00.000000", "creator": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1651cb14" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznqbz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "01/Feb/19" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_597275801_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_19100113902" } ], "description": "This may need to be corrected in other versions of the documentation, but I noticed it on the 5.5 version specifically.\n\nOn https://puppet.com/docs/puppet/5.5/dirs_vardir.html we list the vardir path for agents as being /var/opt/puppetlabs/puppet/cache\n\nHowever, on a test agent with no additional configuration, the vardir is identified as /opt/puppetlabs/puppet/cache:\n\n{noformat}\n[root@pe-201810-agent /]# puppet config print vardir\n/opt/puppetlabs/puppet/cache\n[root@pe-201810-agent /]# ls /opt/puppetlabs/puppet/cache/\nclientbucket/ client_data/ client_yaml/ facts.d/ lib/ locales/ preview/ state/\n{noformat}", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54086", "fixedVersions": [], "id": "54086", "issueType": "Bug", "key": "DOCUMENT-874", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "resolution": "Fixed", "resolutionDate": "2019-02-01T11:44:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Vardir path incorrect on Puppet 5.5 documentation", "timeSpent": "PT0S", "updated": "2019-02-01T11:44:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "attachments": [], "comments": [ { "author": "557058:0a2bfc9c-1912-49b1-9776-665ef20c8769", "body": "Integrate with PE doc updated. Thanks!\u00a0", "created": "2018-06-18T16:58:00.000000" } ], "components": [], "created": "2018-06-15T11:29:00.000000", "creator": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@1a348769" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hziskn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "18/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_10572953_*|*_3_*:*_1_*:*_4455894_*|*_5_*:*_1_*:*_5512334162_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_263954143" } ], "description": "https://puppet.com/docs/continuous-delivery/1.0/integrate_with_puppet_enterprise.html\n\nStep 5 says:\n\n{noformat}\n5. Enter the endpoints for your PuppetDB, Code Manager, orchestrator, and node classifier. You can locate these endpoints with the PE console.\na. In the PE console, click Overview, then click Puppet Services status. \nb. Copy the endpoints from the Puppet Services status monitor and paste them into the appropriate fields on the New Puppet Enterprise Credentials page.\n{noformat}\n\nHowever the console lists the addresses with https:// prefixes. When setting the endpoints in CD4PE it should not include http:// or https:// as the https:// is implicit. The documentation should be updated to clarify.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54085", "fixedVersions": [], "id": "54085", "issueType": "Bug", "key": "DOCUMENT-873", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:de0e2f80-1ec2-47f2-8b6b-f1c0efbde320", "resolution": "Done", "resolutionDate": "2018-06-18T16:58:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "CD4PE PE Endpoint instructions correction", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Great catch, [~accountid:557058:b5baf531-c3a9-49d0-b512-74aaa6e4335d], thank you! Fix should be live Real Soon Now.", "created": "2018-06-04T12:16:00.000000" } ], "components": [], "created": "2018-06-04T12:00:00.000000", "creator": "557058:b5baf531-c3a9-49d0-b512-74aaa6e4335d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@51b4e404" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hznavj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_976111_*|*_5_*:*_1_*:*_6738913799_*|*_6_*:*_1_*:*_0" } ], "description": "The Code Manager code snippit is missing an end quote\n\n[https://puppet.com/docs/pe/2018.1/code_management/code_mgr_config.html#ariaid-title5]\n\nStep 1 code block\n{noformat}\"puppet_enterprise::profile::master::r10k_remote\": \"git@:puppet/control.git\n{noformat}\nshould be\n{noformat}\"puppet_enterprise::profile::master::r10k_remote\": \"git@:puppet/control.git\"\n{noformat}\n\u00a0\n\nSetting code_manager_auto_configure should also probably be more specific (although that I'm not certain about)\n\u00a0\n{noformat}\npuppet_enterprise::profile::master::code_manager_auto_configure\n{noformat}\n\n{noformat}\n\"puppet_enterprise::profile::master::code_manager_auto_configure\": true\n{noformat}\n", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54497", "fixedVersions": [], "id": "54497", "issueType": "Bug", "key": "DOCUMENT-871", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b5baf531-c3a9-49d0-b512-74aaa6e4335d", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Enable Code Manager during installation code block", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:42d70835-e409-40a1-a502-741cb41b7074", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "[~accountid:557058:468002b0-7677-4624-b195-4b7b813f8dc1] or [~accountid:557058:42c68e91-7f1c-4767-895c-70596db6f3d8], can you verify this?", "created": "2018-06-04T11:07:00.000000" }, { "author": "557058:0b2a0f29-3749-4fc3-9772-13ad025585de", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79], looks like the README is incorrect. The parameter, as found in manifests/vhost.pp, defaults to false: https://github.com/puppetlabs/puppetlabs-apache/blob/master/manifests/vhost.pp#L39", "created": "2018-06-04T11:25:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Great, thank you [~accountid:557058:42c68e91-7f1c-4767-895c-70596db6f3d8]. [~accountid:557058:42d70835-e409-40a1-a502-741cb41b7074], thanks for looking at this. When you submit the PR, please ping [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1] for a doc review on it. And thanks for catching this!", "created": "2018-06-04T11:44:00.000000" }, { "author": "557058:42d70835-e409-40a1-a502-741cb41b7074", "body": "Thanks all and the PR is here for you too look at [~accountid:557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1].", "created": "2018-06-04T12:01:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "[~accountid:557058:42d70835-e409-40a1-a502-741cb41b7074] could you send me the link to the PR? Thanks!", "created": "2018-06-04T12:13:00.000000" }, { "author": "557058:42d70835-e409-40a1-a502-741cb41b7074", "body": "[https://github.com/puppetlabs/puppetlabs-apache/pull/1798]\u00a0Here you go. I meant to include it before.", "created": "2018-06-04T12:17:00.000000" }, { "author": "557058:468002b0-7677-4624-b195-4b7b813f8dc1", "body": "Looks like the puppet code has always defaulted to false and was at one time documented as the default, but was accidentally flipped in the Great Apache Readme War of '16 https://github.com/puppetlabs/puppetlabs-apache/pull/1358/files#diff-04c6e90faac2675aa89e2176d2eec7d8L3249", "created": "2018-06-04T16:03:00.000000" }, { "author": "557058:9f6ff9a9-4f34-4d8d-a759-5b36bf88ecd1", "body": "Readme updated. See above.\u00a0", "created": "2018-09-24T10:46:00.000000" } ], "components": [], "created": "2018-06-01T13:23:00.000000", "creator": "557058:42d70835-e409-40a1-a502-741cb41b7074", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@37d31928" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzn27r:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_251106307_*|*_5_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_9675462877" } ], "description": "On the GitHub Readme at [https://github.com/puppetlabs/puppetlabs-apache/blob/master/README.md,]\u00a0it says that ssl_proxyengine defaults to true. Apache's documentation says it defaults to false. My investigations show that it does default to false when not included in the puppet module's config.\nh5. {{ssl_proxyengine}}\n\nSpecifies whether or not to use [SSLProxyEngine|https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine].\n\nBoolean.\n\nDefault: {{true}}.\n\n\u00a0\n\nI can update the README.md with a pull request if someone else can verify my finding.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55100", "fixedVersions": [], "id": "55100", "issueType": "Bug", "key": "DOCUMENT-870", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:42d70835-e409-40a1-a502-741cb41b7074", "resolution": "Fixed", "resolutionDate": "2018-09-24T10:46:00.000000", "status": "Resolved", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update docs to reflect correct default for ssl_proxyengine", "timeSpent": "PT0S", "updated": "2018-09-24T10:46:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Including this edit in the next Server z release's docs updates.", "created": "2018-06-04T11:33:00.000000" } ], "components": [], "created": "2018-05-31T14:54:00.000000", "creator": "70121:73c013a0-69ab-43bb-9bda-8b20355387dc", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@a4ef536" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzmrjr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_332024954_*|*_10007_*:*_1_*:*_4855838827_*|*_5_*:*_1_*:*_1885673812_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1447448" } ], "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:\n\nAny 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.\n\nI'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]\u00a0uses the word \"solidus\" when the word \"slash\" would be much better.\n\nRecommendation: Change word \"solidus\" to \"slash\"", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54988", "fixedVersions": [], "id": "54988", "issueType": "Bug", "key": "DOCUMENT-869", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "70121:73c013a0-69ab-43bb-9bda-8b20355387dc", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Puppet Server documentation uses needlessly confusing terms", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "attachments": [ { "attacher": "623c0a859b54ec0068b13f88", "created": "2018-05-29T05:53:00.000000", "name": "patch", "uri": "https://puppet.atlassian.net/rest/api/3/attachment/content/14261" } ], "comments": [ { "author": "623c0a859b54ec0068b13f88", "body": "I've attached a patch with a proposed fix that changes this for 5.5.\u00a0 Perhaps it should be changed for older versions as well?", "created": "2018-05-29T05:53:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Thanks [~accountid:623c0a859b54ec0068b13f88], I've applied the change to puppetlabs/puppet-docs (commit 77fd786c) to the docs for all versions of Puppet 5.", "created": "2018-06-04T11:38:00.000000" } ], "components": [], "created": "2018-05-29T05:52:00.000000", "creator": "623c0a859b54ec0068b13f88", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@61c9afbc" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzmcpr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "10008_*:*_1_*:*_4855525161_*|*_1_*:*_1_*:*_537392080_*|*_5_*:*_1_*:*_1885674704_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_1718235" } ], "description": "Let me quote [https://puppet.com/docs/puppet/5.5/config_important_settings.html:]\n\n\u00a0\n{quote}These are used when running Puppet master as a Rack application (e.g. under Passenger), which you should definitely be doing.\n{quote}\nHowever, Rack is deprecated.\u00a0 I think this should instead tell me to use Puppet Server,\n\nand this text (about\u00a0ssl_client_header and\u00a0ssl_client_verify_header) should say that\n\nthis is a legacy feature, or used in a deprecated mode.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54084", "fixedVersions": [], "id": "54084", "issueType": "Bug", "key": "DOCUMENT-868", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "623c0a859b54ec0068b13f88", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "config_important_settings tells me I should run Puppet master as a Rack application", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Duplicate/symptom of DOCUMENT-848.", "created": "2018-06-04T11:15:00.000000" } ], "components": [], "created": "2018-05-24T06:24:00.000000", "creator": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@60674cdd" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzmapr:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_967538941_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_341130" } ], "description": "Inbetween [https://puppet.com/docs/puppet/5.3/types/exec.html]\u00a0and [https://puppet.com/docs/puppet/5.5/types/exec.html]\u00a0some attribute documenation has gone missing. Specifically *onlyif* but there is other attributes that is missing too.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54507", "fixedVersions": [], "id": "54507", "issueType": "Bug", "key": "DOCUMENT-866", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:8b8ee68d-9213-4499-8e76-36a21cb10c37", "resolution": "Duplicate", "resolutionDate": "2018-06-04T11:15:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Missing documentation for exec resource ", "timeSpent": "PT0S", "updated": "2018-06-04T11:16:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:c9b48d3b-3b16-4fba-80cb-daf19743b953", "attachments": [], "comments": [ { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "Page affected: [https://puppet.com/docs/pe/2017.1/install_eos.html]\n\nStep 2.c:\n{quote}c. On the *[EOS download page|http://downloads.puppetlabs.com/eos/4/PC1/i386/]*, determine the most recent {{.swix}} package for the agent. For example, {{puppet-agent-.eos4.i386.swix}}.\n{quote}\nBolded link is the link in question.\n\n\u00a0", "created": "2018-06-04T11:14:00.000000" } ], "components": [], "created": "2018-05-22T09:11:00.000000", "creator": "557058:b5baf531-c3a9-49d0-b512-74aaa6e4335d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@34e88040" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzm6vz:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "04/Jun/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_1130378437_*|*_5_*:*_1_*:*_6055239320_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_687579684" } ], "description": "Currently the documentation for Arista EOS agents includes a link to PC1 Agent (1.10.x)\n\nWe should update the documentation to reference the Puppet5 agents.\n\n[http://downloads.puppetlabs.com/eos/puppet5/4/i386/]\n{noformat}\ncopy http://downloads.puppetlabs.com/eos/puppet5/4/i386/puppet-agent-.eos4.i386.swix extension:\n{noformat}\n\u00a0\n\n\u00a0\n\n\u00a0\n\n\u00a0", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54083", "fixedVersions": [], "id": "54083", "issueType": "Bug", "key": "DOCUMENT-865", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:b5baf531-c3a9-49d0-b512-74aaa6e4335d", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update Arista EOS Agent Installation instructions", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Hey [~accountid:557058:9524215b-1a7d-407b-b7d2-e020f3970c4d], this is great, thank you!\n\nYeah, can't PR to these, sadly", "created": "2018-05-17T17:25:00.000000" }, { "author": "557058:9524215b-1a7d-407b-b7d2-e020f3970c4d", "body": "[~accountid:557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79] Yep, didn't even notice that typo, it should be standard_content. That single line it {} block is fine, the others are only split up because they were starting to get a bit long.", "created": "2018-05-17T19:14:00.000000" }, { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Awesome, then this is fixed. Yay!", "created": "2018-05-18T10:52:00.000000" } ], "components": [], "created": "2018-05-14T20:21:00.000000", "creator": "557058:9524215b-1a7d-407b-b7d2-e020f3970c4d", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@48d3efa8" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlzrj:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "17/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_246310825_*|*_3_*:*_1_*:*_65147958_*|*_5_*:*_1_*:*_8212734142_*|*_6_*:*_1_*:*_0" } ], "description": "A user reported that the Ruby code for the spec test in [https://puppet.com/docs/pe/2017.3/quick_start_guides/writing_modules_nix_getting_started_guide.html] doesn't pass `pdk validate`. \n\nThe restyled code should be\n\n{code:java}\nrequire 'spec_helper'\n\ndescribe 'pe_getstarted_app', type: :class do\n let(:facts) do\n {\n operatingsystemrelease: '14.04',\n osfamily: 'Debian',\n operatingsystem: 'Ubuntu',\n lsbdistrelease: 'Trusty',\n\n }\n end\n\n describe 'stardard content' do\n it { is_expected.to contain_class('apache').with('mpm_module' => 'prefork') }\n\n it {\n is_expected.to contain_apache__vhost('pe_getstarted_app').with(\n 'port' => '80',\n )\n }\n\n it {\n is_expected.to contain_file('/var/www/pe_getstarted_app/index.php').with(\n 'ensure' => 'file',\n 'content' => \"\\n\",\n 'mode' => '0644',\n )\n }\n end\n\n describe 'custom content' do\n let(:params) do\n { 'content' => \"custom\\n\" }\n end\n\n it {\n is_expected.to contain_file('/var/www/pe_getstarted_app/index.php').with(\n 'ensure' => 'file',\n 'content' => \"custom\\n\",\n 'mode' => '0644',\n )\n }\n end\nend\n{code}\n\nI wasn't sure where these docs are generated from, or I would have submitted a PR for the change :)", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54386", "fixedVersions": [], "id": "54386", "issueType": "Bug", "key": "DOCUMENT-864", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:9524215b-1a7d-407b-b7d2-e020f3970c4d", "resolution": "Done", "resolutionDate": "2018-08-21T12:11:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "Update code style of \"Getting started: Writing modules for *nix\"", "timeSpent": "PT0S", "updated": "2018-08-21T12:11:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "attachments": [], "comments": [ { "author": "557058:1b9bde12-f0a1-4355-ab73-7fc4ec69ba79", "body": "Good catch, thank you so much [~accountid:557058:e5c2c9fc-de9a-4d21-ad10-bea9c1774c07]! I've fixed it now, and should be live within an hour or so.", "created": "2018-05-14T18:05:00.000000" } ], "components": [], "created": "2018-05-10T16:17:00.000000", "creator": "557058:e5c2c9fc-de9a-4d21-ad10-bea9c1774c07", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@b4e5671" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzlxmn:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "15/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_326293989_*|*_5_*:*_1_*:*_8532339929_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_1_*:*_25743005" } ], "description": "In the documentation for the Puppet Development Kit command reference, the examples for the git template URL are pointing to the old GitHub repository\n\n[https://puppet.com/docs/pdk/1.x/pdk_reference.html]\n\n\u00a0\n\nThe examples should point to the current GitHub repository https://github.com/puppetlabs/pdk-templates", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "55098", "fixedVersions": [], "id": "55098", "issueType": "Bug", "key": "DOCUMENT-863", "labels": [], "originalEstimate": "PT0S", "parent": null, "parentSummary": null, "priority": "Normal", "projectDescription": null, "projectKey": "DOCUMENT", "projectLead": "5f35c4af8d89e300463337a9", "projectName": "Documentation (Archived)", "projectType": "software", "projectUrl": null, "reporter": "557058:e5c2c9fc-de9a-4d21-ad10-bea9c1774c07", "resolution": "Done", "resolutionDate": "2018-08-21T12:10:00.000000", "status": "Closed", "statusCategory": "Done", "statuscategorychangedate": "11/Mar/23 10:16 AM", "summary": "PDK git template URL is outdated", "timeSpent": "PT0S", "updated": "2018-08-21T12:10:00.000000", "votes": "0", "watchers": [] }, { "affectedVersions": [], "assignee": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "attachments": [], "comments": [ { "author": "557058:745e5b4d-58ed-48ed-8daa-afe8b66453a1", "body": "This might be a duplicate of another ticket you're working on, but this is in the public facing Jira, so might be worth including any progress info here.", "created": "2018-05-14T10:57:00.000000" }, { "author": "557058:836ef76e-8051-48a3-8dc7-005f79695b0e", "body": "There are two fixes for this that I'm working on today:\n * A manual correction of these docs, which are generated from code.\n * Fixes to the reference docs generation tools.\n\nDOCUMENT-847 is the duplicate. DOCUMENT-848 is the best ticket to follow for progress.", "created": "2018-05-14T11:01:00.000000" } ], "components": [], "created": "2018-05-08T16:17:00.000000", "creator": "623a46a67910a200718ac239", "customFieldValues": [ { "fieldName": "Sub-team", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Approvals", "fieldType": "com.atlassian.servicedesk.approvals-plugin:sd-approvals", "value": "com.atlassian.servicedesk.plugins.approvals.internal.customfield.ApprovalsCFValue@5f317b3c" }, { "fieldName": "Epic/Theme", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:labels", "value": [] }, { "fieldName": "Capitalized?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Yes" }, { "fieldName": "People Involved", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "value": [] }, { "fieldName": "Flagged", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "value": [] }, { "fieldName": "Free ?", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "value": "Yes" }, { "fieldName": "QA Risk Assessment", "fieldType": "com.atlassian.jira.plugin.system.customfieldtypes:select", "value": "Needs Assessment" }, { "fieldName": "Rank", "fieldType": "com.pyxis.greenhopper.jira:gh-lexo-rank", "value": "0|hzluun:" }, { "fieldName": "[CHART] Date of First Response", "fieldType": "com.atlassian.jira.ext.charting:firstresponsedate", "value": "14/May/18" }, { "fieldName": "[CHART] Time in Status", "fieldType": "com.atlassian.jira.ext.charting:timeinstatus", "value": "1_*:*_1_*:*_499138847_*|*_6_*:*_1_*:*_0_*|*_10005_*:*_2_*:*_329458" } ], "description": "In the type reference, the _Description_ of the Exec resource type goes into some detail about the {{creates}}, {{onlyif}}, and {{unless}} attributes of that type, but they are not documented in the _Attributes_ section. They used to be, and they still should be. Note in particular that despite sometime user misconceptions, they are not metaparameters, and therefore are not documented among those, either.", "epicLinkSummary": null, "estimate": "PT0S", "externalId": "54874", "fixedVersions": [], "id": "54874", "issueT