https://github.com/pulumi/pulumi-terraform-bridge/pull/2068 adds the ability to emit the upstream index.md file, where top-level provider information lives, into a docs folder in the Pulumi provider, which is where the registry can find the file if it exists, exactly as we are doing for third party providers today.
To emit these docs properly, the following requirements must be met before emitting this file:
[ ] Apply default doc edit rules
[ ] Convert examples
[ ] Add Hugo shortcodes to any examples so we can obtain the code chooser
[ ] Transform TF names to Pulumi names
[ ] Ability to skip irrelevant sections (e.g. terraform-specific logging, contributing) via docs edit rules
Part of https://github.com/pulumi/registry/issues/4749.
https://github.com/pulumi/pulumi-terraform-bridge/pull/2068 adds the ability to emit the upstream
index.mdfile, where top-level provider information lives, into adocsfolder in the Pulumi provider, which is where the registry can find the file if it exists, exactly as we are doing for third party providers today.To emit these docs properly, the following requirements must be met before emitting this file:
[ ] Apply default doc edit rules
[ ] Convert examples
[ ] Add Hugo shortcodes to any examples so we can obtain the code chooser
[ ] Transform TF names to Pulumi names
[ ] Ability to skip irrelevant sections (e.g. terraform-specific logging, contributing) via docs edit rules
[ ] Include
pulumi config set... instructions[ ] Nice-to-have: Show provider config file