Jira (PDOC-96) Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

[William Hopper (JIRA)]

William Hopper created an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc) Issue Type: New Feature Assignee: Unassigned Created: 2016/09/15 4:52 PM Priority: Normal Reporter: William Hopper `puppet doc` provided a facility for creating reference docs from lib/puppet/reference. That includes the following: [16:46:24] whopper:~/Coding/puppet ‹master*› » bundle exec puppet doc --list configuration - A reference for all settings function - All functions available in the parser indirection - Indirection types and their terminus classes metaparameter - All Puppet metaparameters and all their details providers - Which providers are valid for this machine report - All available transaction reports type - All Puppet resource types and all their details Strings currently handles functions, providers, and types. The others live at https://docs.puppet.com/puppet/latest/reference (example, https://docs.puppet.com/puppet/latest/reference/indirection.html) Strings has never supported indirection, metaparameters, reports or configuration docs. The docs team will need these to be functional to populate the site. Add Comment

This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)

[Henrik Lindberg (JIRA)]

Henrik Lindberg updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Henrik Lindberg Sprint: PDOC - Triage

Add Comment

[Eric Putnam (JIRA)]

Eric Putnam commented on PDOC-96

Re: Strings needs to document core puppet references (indirection, configuration, metaparameter, etc) Maybe something for the future?

Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[Jean Bond (JIRA)]

Jean Bond updated an issue

Puppet Strings / PDOC-96

Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jean Bond Labels: generated-docs

Add Comment

[Jean Bond (JIRA)]

Jean Bond updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc) Change By: Jean Bond

`puppet doc` provided a facility for creating reference docs from {{lib/puppet/reference}}. That includes the following: {code}

[16:46:24] whopper:~/Coding/puppet ‹master*› » bundle exec puppet doc --list configuration - A reference for all settings function - All functions available in the parser indirection - Indirection types and their terminus classes metaparameter - All Puppet metaparameters and all their details providers - Which providers are valid for this machine report - All available transaction reports type - All Puppet resource types and all their details

{code} Strings currently handles functions, providers, and types. The others live at https:// docs. puppet.com/ docs/ puppet/latest/ reference (example, https:// docs. puppet.com/ docs/ puppet/latest/ reference/ indirection.html)

Strings has never supported indirection, metaparameters, reports or configuration docs. The docs team will need these to be functional to populate the site.

Add Comment

[Jean Bond (JIRA)]

Jean Bond updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc) Change By: Jean Bond

`puppet doc` provided a facility for creating reference docs from {{lib/puppet/reference}}. That includes the following: {code} [16:46:24] whopper:~/Coding/puppet ‹master*› » bundle exec puppet doc --list configuration - A reference for all settings function - All functions available in the parser indirection - Indirection types and their terminus classes metaparameter - All Puppet metaparameters and all their details providers - Which providers are valid for this machine report - All available transaction reports type - All Puppet resource types and all their details {code}

Strings 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 edited by Jean Bond 12 August 2019)

Strings has never supported indirection, metaparameters, reports or configuration docs. The docs team will need these to be functional to populate the site.

Add Comment

[Jean Bond (JIRA)]

Jean Bond commented on PDOC-96

Re: Strings needs to document core puppet references (indirection, configuration, metaparameter, etc) Update! Some of these generated docs no longer need to be generated, because: they are not useful for most users (indirection) they are stable docs and can be handled as more-or-less static docs (metaparameter, report) they aren't in the docs repo or recent docs memory at all (providers). The docs that we WOULD like Strings to handle are: *configuration: Strings does NOT generate this, and tech pubs would love for Strings to do this. function: Strings generates this, but may have some issues? I need to look at a diff, it might be fine actually. type: Strings generates this, but with numerous problems. *

Add Comment

[Jean Bond (JIRA)]

Jean Bond updated an issue

Puppet Strings / PDOC-96

Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jean Bond

`puppet doc` provided a facility for creating reference docs from {{lib/puppet/reference}}. That includes the following: {code} [16:46:24] whopper:~/Coding/puppet ‹master*› » bundle exec puppet doc --list configuration - A reference for all settings function - All functions available in the parser indirection - Indirection types and their terminus classes metaparameter - All Puppet metaparameters and all their details providers - Which providers are valid for this machine report - All available transaction reports type - All Puppet resource types and all their details {code}

Strings 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 edited updated by Jean Bond 12 August 2019)

Strings has never supported indirection, metaparameters, reports or configuration docs. The docs team will need these to be functional to populate the site.

Add Comment

[Jesse Scott (JIRA)]

Jesse Scott updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jesse Scott Priority: Normal Minor

Add Comment

[Jesse Scott (JIRA)]

Jesse Scott updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jesse Scott Priority: Minor Normal

Add Comment

[Jesse Scott (JIRA)]

Jesse Scott updated an issue

Puppet Strings / PDOC-96

Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jesse Scott Team: Puppet Developer Experience Epic Status: In Progress Epic Name: Strings should document core puppet references Status: Accepted Developing Workflow: Scrum Team Engineering Epic Workflow Issue Type: New Feature Epic

Add Comment

[Jean Bond (JIRA)]

Jean Bond updated an issue

Puppet Strings / PDOC-96 Strings needs to document core puppet references (indirection, configuration, metaparameter, etc)

Change By: Jean Bond Component/s: DOCS

Add Comment