-
Task
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
False
-
-
False
-
None
-
None
-
None
-
None
-
None
Resolve the TODO that appears in the generated docs/content/reference/api.md at line 3251: "TODO: Can we explain where a user might find this value" for the Azure publisher field.
The docs file is auto-generated by make api-docs, so the TODO originates in the API Go type definitions under api/. The fix must be made in the API type comments, then regenerated with make api-docs.
Why
Users reading the API reference for Azure node pool images have no guidance on where to find valid publisher IDs. This leads to confusion and trial-and-error when configuring specs.
Acceptance Criteria
- Locate the TODO in the API Go type definition under api/ that produces this generated doc text
- Update the Go type comment to document where to retrieve Azure publisher IDs (e.g., Azure Portal, az vm image list-publishers CLI command)
- Add an example publisher value so readers can understand the expected format
- Remove the TODO comment from the API source
- Run make api-docs to regenerate the documentation
Technical Details
- Generated file: docs/content/reference/api.md line 3251
- Source: API Go type definitions under api/ (find the TODO matching this field)
- TODO text: "TODO: Can we explain where a user might find this value"
- Context: Azure publisher field in the API spec
- Regenerate: make api-docs