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

Finalize resource-oriented API doc generation #2264

Closed
4 tasks done
justinvp opened this issue Jan 16, 2020 · 1 comment
Closed
4 tasks done

Finalize resource-oriented API doc generation #2264

justinvp opened this issue Jan 16, 2020 · 1 comment
Assignees
Labels
docs/api Relates to API documentation size/M Estimated effort to complete (up to 5 days).
Milestone

Comments

@justinvp
Copy link
Member

justinvp commented Jan 16, 2020

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
  • Show how to read an existing resource (i.e. static get function)

A few remaining layout-specific questions remain:

  • Import an existing resource on the bottom of the page
    • We will not do this for Q1. Based on the final docs experience, we will see how this can be best documented.
    • In Pulumi, a resource can be imported by passing the custom resource option import with the appropriate resource ID as its value.
  • How do we handle rendering of Comment for each language? (see Add place to hold examples in schema pulumi-terraform-bridge#122)
    • 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.
@justinvp justinvp added the docs/api Relates to API documentation label Jan 16, 2020
@justinvp justinvp added this to the 0.32 milestone Jan 16, 2020
@justinvp justinvp self-assigned this Jan 16, 2020
@justinvp justinvp assigned praneetloke and unassigned justinvp Feb 24, 2020
@praneetloke praneetloke added the size/M Estimated effort to complete (up to 5 days). label Feb 28, 2020
@praneetloke
Copy link
Contributor

Closing this issue as the outstanding questions have been resolved. I will open separate work items for the applicable ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/api Relates to API documentation size/M Estimated effort to complete (up to 5 days).
Projects
None yet
Development

No branches or pull requests

2 participants