search

pulumi / templates

Templates used by `pulumi new`
Apache License 2.0
100 stars 66 forks source link

Link to language docs pages from templates #163

Open clstokes opened 3 years ago

clstokes commented 3 years ago

The various language pages have details about how the runtimes work and available configuration options. The templates should include a link to these pages in the project yaml file to make them more discoverable.

For example, for the aws-python template (https://github.com/pulumi/templates/blob/master/aws-python/Pulumi.yaml):

name: ${PROJECT}
description: ${DESCRIPTION}
# See https://www.pulumi.com/docs/intro/languages/python/ for more details and configuration options.
runtime: python 
template:
  description: A minimal AWS Python Pulumi program
  important: true
  config:
    aws:region:
      description: The AWS region to deploy into
      default: us-east-1
scottslowe commented 9 months ago

As opposed to linking to language pages, we feel it might be better to link to the Registry page for the specific resource being created in the program.