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

Inconsistencies in YAML config docs #12417

Open
thomas11 opened this issue Jul 31, 2024 · 0 comments
Open

Inconsistencies in YAML config docs #12417

thomas11 opened this issue Jul 31, 2024 · 0 comments
Labels
area/docs Improvements or additions to documentation

Comments

@thomas11
Copy link
Contributor

Problem description

I noticed a few inconsistencies in our YAML docs about the project-level config.

  • Pulumi YAML reference right at the top links to config options, which says that the type property can be “either string, boolean, integer, or array.” But the “Config” section on Pulumi YAML reference says “It can be one of: String, Number, List, or List.”
    • Note the capitalization, too.
  • Also, config options lists type as required whereas Pulumi YAML reference doesn’t (“Either type or default is required.“). Nevertheless the description says “Type is the (required) data type …”
  • The “Config” section on Pulumi YAML reference doesn’t mention the variant where a config key maps directly to a value (foo: bar) instead of a structured object, which is documented on config options.

Suggestions for a fix

Apart from fixing the issues above, I wonder if we could avoid having two sections on config on two different pages? It's YAML either way.

@thomas11 thomas11 added the needs-triage Needs attention from the triage team label Jul 31, 2024
@thoward thoward added area/docs Improvements or additions to documentation and removed needs-triage Needs attention from the triage team labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

2 participants