docs icon indicating copy to clipboard operation
docs copied to clipboard

Add ESC TypeScript & Python SDK API reference docs

Open justinvp opened this issue 1 year ago • 1 comments

This PR adds API reference docs for the ESC TypeScript and Python SDKs.

Notes:

  • The Python docs are based on the latest published version on PyPi. (We'll want to regen when the latest version is available).
  • The Python docs are currently showing everything that's exported from the module -- we may want to filter it down to only certain set of APIs
  • The TypeScript docs are based on what's currently in https://github.com/pulumi/esc-sdk/tree/main/sdk/typescript/esc
  • We'll definitely want to link to these from the ESC docs.
  • We may want to also include links to these at the bottom of https://www.pulumi.com/docs/languages-sdks/javascript/ and https://www.pulumi.com/docs/languages-sdks/python/
  • We'll likely want to add some kind of workflow, that will generate these automatically when there is a new release for https://github.com/pulumi/esc-sdk, like what we do for new releases of pulumi/pulumi.

justinvp avatar Jun 04 '24 21:06 justinvp

Your site preview for commit a89452f2 is ready! :tada:

http://www-testing-pulumi-docs-origin-pr-11957-a89452f2.s3-website.us-west-2.amazonaws.com.

Direct Links

pulumi-bot avatar Jun 04 '24 21:06 pulumi-bot

@justinvp this is a pretty old draft. Is this ready to merge? If not, what is required to get it to the finish line?

thoward avatar Nov 09 '24 06:11 thoward

The team plans to take this on this quarter

On Fri, Nov 8, 2024, 10:08 PM Troy Howard @.***> wrote:

@justinvp https://github.com/justinvp this is a pretty old draft. Is this ready to merge? If not, what is required to get it to the finish line?

— Reply to this email directly, view it on GitHub https://github.com/pulumi/docs/pull/11957#issuecomment-2466070641, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABJAMINRDOLLM7KXCKCEKQLZ7WREXAVCNFSM6AAAAABIZNB3B2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINRWGA3TANRUGE . You are receiving this because your review was requested.Message ID: @.***>

cleverguy25 avatar Nov 09 '24 18:11 cleverguy25