Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference docs are often wrong #9312

Open
joshcooper opened this issue Apr 3, 2024 · 1 comment
Open

Reference docs are often wrong #9312

joshcooper opened this issue Apr 3, 2024 · 1 comment
Labels
accepted Valid issue that we intend to work on when we have the bandwidth bug Something isn't working triaged Jira issue has been created for this

Comments

@joshcooper
Copy link
Contributor

joshcooper commented Apr 3, 2024

Describe the Bug

For "reasons" our configuration refererence docs are often incorrect, especially when a setting's default value is different between 7.x and 8.x. For example, the default value of strict_variables is correct in 7.x, but wrong in 8.x.

Expected Behavior

The reference documentation should be accurate for each branch.

I would like to see the configuration reference pages generated in CI and checked into the repo, similar to how we handle man pages. That way the list of settings and default values are guaranteed to be accurate for each branch.

This is mostly an issue with the configuration reference, but also includes other documentation like the type & provider docs, which providers support which features, etc. Other changes may be required to puppet-strings for that. See PDOC-262

Additional Context

https://perforce.atlassian.net/browse/PUPDOC-5594
https://perforce.atlassian.net/browse/PUPDOC-5591
https://perforce.atlassian.net/browse/PUPDOC-5562
https://perforce.atlassian.net/browse/PUPDOC-5491
https://perforce.atlassian.net/browse/PUPDOC-5481

@joshcooper joshcooper added the bug Something isn't working label Apr 3, 2024
@joshcooper joshcooper added the accepted Valid issue that we intend to work on when we have the bandwidth label Apr 4, 2024
@joshcooper joshcooper added the triaged Jira issue has been created for this label Apr 24, 2024
Copy link

Migrated issue to PUP-12039

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Valid issue that we intend to work on when we have the bandwidth bug Something isn't working triaged Jira issue has been created for this
Projects
None yet
Development

No branches or pull requests

1 participant