pulumi / registry

The global index of everything you can do with Pulumi.
https://www.pulumi.com/registry
Apache License 2.0
27 stars 120 forks source link

Add how to get GCP config value to the Documentation #833

Open v-hunt opened 2 years ago

v-hunt commented 2 years ago

Hello!

Issue details

Section Installation & Configuration describes pretty well how to set a config value to the GCP section of a stack YAML file. But how to get a config value is not quite obvious. A new user usually tries to use a variation of this way described in Pulumi documentation:

config = pl.Config()
config.require('gcp:my_config')

and this way leads to an error.

But for GCP section we should use this:

pulumi_gcp.config.my_config

To discover this way a new user should go to the source code.

I think it would be good to write some short instructions with a code snippet on how to get a config value from a GCP section of the YAML to the provider documentation.

Affected area/feature

This should affect the documentation only.

susanev commented 2 years ago

@v-hunt thx for opening up this issue! gonna move this over to registry which is where this file lives. if you'd be open to contributing a pr, wed super appreciate it!

https://github.com/pulumi/registry/edit/master/themes/default/content/registry/packages/gcp/installation-configuration.md