pulumi-community #docs

docs

big-piano-35669

07/11/2019, 3:24 PM

set the channel description: To provide feedback on Pulumi documentation, and/or to brainstorm topics and ideas

important-leather-28796

07/11/2019, 3:43 PM

https://github.com/pulumi/kubernetes-the-prod-way was the most valuable walkthrough when I started out - would be nice to see it get the attention in docs that it deserves. Granted it is more advanced, but it might be nice to have the typical short/simple samples and then contrast it to more of a flagship project.

👍 3

cool-egg-852

07/11/2019, 4:54 PM

That’s awesome to hear. Are the upgrades to bring the documentation more inline with what terraform has? At this point I basically just use terraform’s documentation for everything as it’s much easier and more well documented.

swift-painter-31084

07/11/2019, 5:43 PM

This is mostly a nit: I've found several links inside of docs and JSdocs that lead to dead links on GitHub. It looks like the path changed at some point to include /reference/

important-leather-28796

07/11/2019, 7:22 PM

I’d like to see more best practices docs. One item I just bumped into - we export whole pulumi objects from each stack for convenience when reviewing what the config is/was in the pulumi console. Is this a bad practice? security concern?

swift-painter-31084

07/11/2019, 7:32 PM

It would be really helpful to see how one might organize a repo for large projects. The repo strategies documentation is helpful, but more detail or examples of folder structures for large projects with multiple services and custom components/resources, tests, etc. would be very enlightening.

billowy-garage-68819

07/12/2019, 4:25 PM

Hey guys , was just looking for reference to generate an IAM Service Account on GCP browsing the API reference this is linked as a child object, however, when clicked comes up as a 404 https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/gcp/serviceAccount

cool-egg-852

07/29/2019, 2:44 PM

It would be good if the GitHub repo URL that you can configure next to the description would link to the docs for the repository. For example pulumi-mysql could go to the mysql provider docs.

cool-egg-852

07/29/2019, 3:14 PM

Another thing that would be beneficial is adding more of the docs into the typescript types. Having to look up the docs online when I could see them in place isn’t as efficient

👍🏽 1

billions-fall-36374

08/11/2019, 3:39 PM

Is there any other pulumi provider that has been written other than the pulumi-kubernetes provider? It's not the most friendly provider to get started (https://www.pulumi.com/docs/reference/faq/#how-can-i-add-support-for-my-favorite-cloud)

damp-salesmen-75182

09/18/2019, 9:07 AM

ole, there is a “bug” in this sections first code example https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/awsx/ec2/#subnets

damp-salesmen-75182

09/18/2019, 11:04 AM

if I may recommend something on this page https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/aws/ it states the following

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn't turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

it would be great if it mentioned the version of terraform aws driver and pulumi, I know it says this in change log, but it would be really beneficial to show it right away in docs as it help in understanding to search in which version for bugs, and for someone coming from terraform like me its important to see how polumi maps to aws driver

acceptable-army-69872

09/25/2019, 9:21 PM

I normally just fire these at Cameron Stokes when I see them, but since you have this nice slack, and a whole channel for doc feedback.... https://github.com/pulumi/pulumi-awsx/tree/master/nodejs/awsx/apigateway "complete example" links to https://github.com/pulumi/pulumi-awsx/blob/master/nodejs/awsx/examples/api/index.ts (404), maybe should link to https://github.com/pulumi/examples/blob/master/aws-ts-apigateway/index.ts?

👋 1

acceptable-army-69872

09/25/2019, 9:22 PM

A better Patrick would do a pull request...but my suggested fix may be wrong.

lemon-librarian-43470

11/13/2019, 11:26 AM

Hey all… a quick observation on the documentation for

pulumi up

… I don’t think it is particularly clear on how to get logging to appear. I think I expected it to appear on the console but the correct pattern is

pulumi -v=10 --logtostderr up 2> somefile.log

lemon-librarian-43470

11/13/2019, 11:28 AM

And the docs say

pulumi up [template|url] [flags]

but putting flags between

pulumi

and the command also seems to work?

lemon-librarian-43470

11/13/2019, 11:29 AM

And this page https://www.pulumi.com/docs/reference/cli/pulumi_up/ talks about options, but the sample command line talks about flags… yeah, both the same I guess but consistent language would be great! Thanks 👍

cool-egg-852

11/20/2019, 5:24 PM

Why is

Vault

listed under

Cloud Providers

on https://www.pulumi.com/docs/reference/pkg/?

cool-egg-852

11/20/2019, 5:41 PM

On https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/vault/identity/#Group it says it’s work is derived from an invalid url. It should be

.md

but it’s

.markdown

cool-egg-852

11/20/2019, 6:03 PM

https://github.com/pulumi/pulumi-vault/issues/11 - though this one is provider specific.

colossal-ram-89482

01/16/2020, 2:07 PM

Quick question about the bots I see in the

pulumi/docs

repo. The github-actions and pulumi bots seem to be active on some pull requests, but not all. For example, they did not comment on my recent PR (https://github.com/pulumi/docs/pull/2247). I don't see anything obvious in

.github

that would explain this. In which scenarios are these bots active? Thanks.

colossal-ram-89482

01/23/2020, 12:09 AM

Do you have any plans for version-aware documentation? If Pulumi already has this feature, my apologies for missing it. I find this incredibly useful, especially for emerging projects which are advancing rapidly, introducing significant new features (often independently transitioning from preview mode to GA), making selected backwards-incompatible changes, and so on. There is no substitute for direct navigation to e.g. the 1.7.1 Python SDK or 1.9.0 TS SDK, etc.

☝️ 1

white-balloon-205

01/27/2020, 8:09 PM

https://pulumi-community.slack.com/archives/CB36DSVSA/p1580155630013000

colossal-ram-89482

02/23/2020, 8:34 PM

Question about the usability of the Python API reference docs. Will https://github.com/pulumi/docs/issues/1595 include providing a table-of-contents at or near the top of the page, similar to the TS/JS reference? The current state is a significant source of friction ... I end up searching the page for the resource I want to find. For example searching for "Function(" on the lambda page.

early-apple-25248

03/03/2020, 5:36 PM

Question: Is https://github.com/pulumi/pulumi-aws/blob/master/sdk/nodejs/sns/topicSubscription.ts#L84 accurate? The docs say it should be an ARN, but the actual code looks like its using

pulumi.Output<Topic>

, not the ARN. I stumbled across this looking at this section of the lambda docs: https://www.pulumi.com/docs/reference/pkg/nodejs/pulumi/aws/lambda/#usage-with-sns - the example code passes

topic: defaultTopic.arn,

but this causes errors in my IDE (as well as at compile time)

white-airport-48392

03/06/2020, 10:15 AM

Hi I have a question about resources managed by a pulumi project Is there a way that a project can be renamed without impacting the resources in the project or for example is there a way in which a resource inside a project can be moved or re organized to a different project

white-airport-48392

03/12/2020, 10:53 AM

Hi all , Is the pulumi CLI exposed in SDK flavor ? or is it only cli ? Could not find anything related to this in the docs.

white-balloon-205

03/31/2020, 11:13 PM

https://pulumi-community.slack.com/archives/CB36DSVSA/p1585696360024400

🎉 3

stocky-island-3676

04/01/2020, 7:39 AM

Very neat the new resource-oriented docs. How could you link to a section with a specific language pre-selected? For example if I want to point to a “supporting type” down below the page but with Go language selected (as example the `InstanceMetadataOptions` of an EC2-instance)?

cool-egg-852

04/01/2020, 2:39 PM

https://www.pulumi.com/docs/reference/pkg/gcp/container/cluster/ vs https://www.terraform.io/docs/providers/google/r/container_cluster.html for example is different in that TF has a recommended example and Pulumi has the default example only.

Title

cool-egg-852

04/01/2020, 2:39 PM

Any reason to not include all of the doc from TF?

white-balloon-205

04/01/2020, 3:03 PM

We are working on being able to add the rest of the examples. The primary reason they are missing today is if the examples uses TF 0.12 syntax. We will be landing support for TF 0.12 in tf2pulumi in the next week or two.

cool-egg-852

04/01/2020, 3:04 PM

Gotcha

View count: 1