You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Finalize resource-oriented doc gen, with any follow-ups that came out of #2263 (e.g. missing data in schema, refinements to the style/design of page, etc.).
The final page anatomy is as follows:
Generate real docs pages for Data Sources (prototype was focused on Resources only)
Declarations in each language
Call into individual language generators to generate these declarations in each language
Emit nested types inline
Linking of types within declarations
Make the declaration gen smarter to include links
Linking within the page (e.g. anchor links to nested structures)
i.e. if the “comment” for a resource’s property contains symbols, how do we “fix-up” the symbol to have the correct casing for the specified language?
Do we need any special handling of aliases?
Aliases will be added to the docs after Q1.
How do we handle language-specific overlays? (e.g. NodeJS-specific functions like onObjectCreated on Bucket):
With the "old way", we show these in the docs, since they are members on the resource class.
For Q1, we decided this is not essential. However, certain types of overlays are necessary for language-specific things such as enums, which we plan on including in the resource-level docs. For that see Add enum support to the schema and code generators pulumi#4003.
The text was updated successfully, but these errors were encountered:
Finalize resource-oriented doc gen, with any follow-ups that came out of #2263 (e.g. missing data in schema, refinements to the style/design of page, etc.).
The final page anatomy is as follows:
pulumi.Input
to their associated SDK doc link https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/pulumi/#Input)get
function)A few remaining layout-specific questions remain:
import
with the appropriate resource ID as its value.Comment
for each language? (see Add place to hold examples in schema pulumi-terraform-bridge#122)onObjectCreated
onBucket
):The text was updated successfully, but these errors were encountered: