docs(yaml): reconcile YAML config schema with project file reference#18971
docs(yaml): reconcile YAML config schema with project file reference#18971rshade wants to merge 1 commit into
Conversation
Docs review — PR #18971Reviewed both modified files against Issues
Things that look good
Checklist
Mention me (@claude) if you would like a follow-up pass after revisions, or if you want me to dig into the deprecation-warning behavior question. |
|
Your site preview for commit 475ed11 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-18971-475ed11f.s3-website.us-west-2.amazonaws.com |
- Aligns the YAML language reference with the canonical project-level `config` schema documented in `project-file.md`, resolving the long-standing inconsistencies flagged in #12417 (mismatched type names, drifted property tables, and a stale anchor link). - Replaces the YAML page's Title-Case type list (`String`, `Number`, `List<String>`, etc.) with the lowercase types the engine actually accepts today: `string`, `integer`, `boolean`, `array`, and `object`, plus the `items` form that replaces `List<T>`. - Moves the legacy `configuration` key guidance into a warning callout that documents the full deprecated schema, so existing users can still recognize their programs while new programs get steered to the supported form. - Adds a note on `project-file.md` clarifying that the `config` schema there is the canonical, engine-parsed schema used by every language (including YAML), with a cross-link to the YAML page for YAML-flavored examples. - [ ] `make lint` clean (project's markdownlint-cli2 over built output) - [ ] Visual spot-check via `make serve`: rendered `{{% notes %}}` callouts on both pages, in-page `#config` anchor from the top property table, and cross-links between the two pages - [ ] Spot-check that the example YAML program still parses with `pulumi preview` against a scratch project - `content/docs/iac/languages-sdks/yaml/yaml-language-reference.md` — Fix the top-of-page `config` link to use the in-page `#config` anchor; rewrite the Config section to mirror the project-level schema (lowercase types, `items` row, secret guidance); move the `configuration` deprecation into a warning callout with the full legacy type list; refresh the example program to use the supported schema and add a `boolean` example. - `content/docs/iac/concepts/projects/project-file.md` — Add a note above `### config options` clarifying that this schema is parsed by the engine and applies to every language, with a link to the YAML reference. Closes #12417
59eaf4a to
475ed11
Compare
Summary
configschema documented inproject-file.md, resolving the long-standing inconsistencies flagged in Inconsistencies in YAML config docs #12417 (mismatched type names, drifted property tables, and a stale anchor link).String,Number,List<String>, etc.) with the lowercase types the engine actually accepts today:string,integer,boolean,array, andobject, plus theitemsform that replacesList<T>.configurationkey guidance into a warning callout that documents the full deprecated schema, so existing users can still recognize their programs while new programs get steered to the supported form.project-file.mdclarifying that theconfigschema there is the canonical, engine-parsed schema used by every language (including YAML), with a cross-link to the YAML page for YAML-flavored examples.Test plan
make lintclean (project's markdownlint-cli2 over built output)make serve: rendered{{% notes %}}callouts on both pages, in-page#configanchor from the top property table, and cross-links between the two pagespulumi previewagainst a scratch projectChanges
Modified files
content/docs/iac/languages-sdks/yaml/yaml-language-reference.md— Fix the top-of-pageconfiglink to use the in-page#configanchor; rewrite the Config section to mirror the project-level schema (lowercase types,itemsrow, secret guidance); move theconfigurationdeprecation into a warning callout with the full legacy type list; refresh the example program to use the supported schema and add abooleanexample.content/docs/iac/concepts/projects/project-file.md— Add a note above### config optionsclarifying that this schema is parsed by the engine and applies to every language, with a link to the YAML reference.Closes #12417
Proposed changes
Unreleased product version (optional)
Related issues (optional)