docs
docs copied to clipboard
pulumi
All things related to docs generation for the Pulumi CLI, SDK, and tutorials.
### Problem description The main project README is being used to publish to https://pypi.org/project/pulumi/ which is showing JavaScript examples. ### Suggestions for a fix Publish a Python-specific README for the...
The [`SelfSignedCert.privateKeyPem`](https://github.com/pulumi/pulumi-tls/blob/master/sdk/nodejs/selfSignedCert.ts#L72) and [`CertRequest.privateKeyPem`](https://github.com/pulumi/pulumi-tls/blob/master/sdk/nodejs/certRequest.ts#L57) outputs are both documented as: > PEM-encoded private key that the certificate will belong to Similarly, the [`LocallySignedCert.caPrivateKeyPem`](https://github.com/pulumi/pulumi-tls/blob/master/sdk/nodejs/locallySignedCert.ts#L54) output is documented as: > PEM-encoded private key...
We've seen at least one case where a nested output property is including the subsequent bullet as part of its docs. https://github.com/pulumi/pulumi-aws/blob/ed4659e42c6700e442c578be9f6fa1537f16a801/sdk/nodejs/types/output.ts#L600-L635 ```typescript export interface TargetGroupHealthCheck { /** * Indicates...
The styles for the API docs could use another round of refinement: fixing font sizes, indentation, etc., so it is more obvious where you on the page and the hierarchy...
We seem to use `[Type]` and `[Method(func)]` annotations in some of our API documentation, presumably hoping that these will get rendered as hyperlinks. For example, see [Output](https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/pulumi/#Output): > At ‘deployment...
This API is listed at https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/closure/#serializeFunction, even though it is actually available at https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/pulumi/runtime/.
In the API docs, we had clear package installation instructions at the top of the page (for Node.js, at least). I find this helpful otherwise it's not exactly clear the...
Today, we don't provide information on the default timeouts for a resource/provider. We should include a section on the create, update, delete timeouts for resources.
### Problem description - There is nothing in the documentation about what permissions should be used for service principal. It's something that's quickly come when setting up Continuous Delivery through...
We are missing valid values for the `mfaConfigurations` options on this resource: https://www.pulumi.com/docs/reference/pkg/aws/cognito/userpool/#inputs. It trails off after _"Valid values:"_:  The corresponding source documentation is here: https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/cognito_user_pool.markdown: ``` * `mfa_configuration`...