docs
docs copied to clipboard
pulumi
All things related to docs generation for the Pulumi CLI, SDK, and tutorials.
Given the interest in https://github.com/pulumi/pulumi/issues/3507 we should document what you can already do with PS (and any potential issues you might run into).
File: [docs/reference/pkg/gcp/storage/notification.md](https://www.pulumi.com/docs/reference/pkg/gcp/storage/notification/) Hi, the doc suggests an example for granting permissions for the Storage project Service Account to publish to Pub/Sub. I suggest such an example, which is currently missing,...
Most deprecated APIs are now using the DeprecationMessage field, but some are still using the Comment field as well, leading to duplication: https://www.pulumi.com/docs/reference/pkg/aws/cognito/userpool/#userpooladmincreateuserconfig  We should ensure that all APIs...
### Problem description When a user tries to use assume role with https://github.com/pulumi/pulumi-eks, they get an error message about the cluster being "unreachable". We added support for assume role with...
Related to https://github.com/pulumi/docs/issues/2137. We are going to be generating .NET API docs using the `docfx` tool. We want to see if we can adjust the layouts to somewhat match our...
File: [docs/reference/pkg/kubernetes/yaml/configfile.md](https://www.pulumi.com/docs/reference/pkg/kubernetes/yaml/configfile/) First time user, first time bug reporter - so thanks for your patience. Super minor thing. The online Python documentation for `kubernetes.yaml.ConfigFile()` lists `file` as an argument --which...
File: [docs/reference/pkg/nodejs/pulumi/aws/eks/_index.md](https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/aws/eks/) The "Enabling Control Plane Logging" example in this file is incorrect, as AWS manages the log group and logs for the control plane. User's cannot provide their own...
https://www.pulumi.com/docs/reference/pkg/aws/dynamodb/table/#tablepointintimerecovery File: [docs/reference/pkg/aws/dynamodb/table.md](https://www.pulumi.com/docs/reference/pkg/aws/dynamodb/table/)
### Problem description For resource property descriptions that have inline code blocks, the rendered code block is wrong / meaningless. Example: https://www.pulumi.com/docs/reference/pkg/gcp/logging/projectsink/#inputs  This is true in the API-style documentation...
### Problem description Documentation is missing for properties on interfaces/types that are extended using [`utils.Overwrite`](https://github.com/pulumi/pulumi-aws/blob/4348fc520e13aa38c29422befda6223ef64ad738/sdk/nodejs/utils.ts#L29-L31). As one example, [`CallbackFunctionArgs`](https://github.com/pulumi/pulumi-aws/blob/4348fc520e13aa38c29422befda6223ef64ad738/sdk/nodejs/lambda/lambdaMixins.ts#L201-L219) extends [`BaseCallbackFunctionArgs`](https://github.com/pulumi/pulumi-aws/blob/4348fc520e13aa38c29422befda6223ef64ad738/sdk/nodejs/lambda/lambdaMixins.ts#L157-L192) and our [docs](https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/aws/lambda/#CallbackFunctionArgs) show all the expected properties from...