Open aaronkao opened 3 years ago
Indeed. If we're going to have a TOC in the README we should probably consider generating it, since it'll so easily fall out of date.
Additionally it might be nice to start filing these examples into folders (aws
, azure
, etc.) so the README itself is more discoverable.
I see three options:
I'm inclined to suggest either (1) or (3), with a preference for the former. Ctrl-f search is quite effective on this repo currently - and I fear (2) would net hurt this, and be duplicative of the automatic TOC generation in the tutorials docs.
Option (1) makes sense to me too, yeah. We'll probably want to do a bit more work to make the website's representation of these examples more complete (there are things in the repo that aren't on the website -- cloud, policy, etc.), but that does seem like the better longer-term approach. I'll chat with @davidwrede and see what we can do to move this forward.
Related to option 2 is this discussion: https://github.com/pulumi/examples/issues/908.
Affected feature
The following examples don't seem to be reflected in the main README table of contents:
aws-go-slackbot aws-py-slackbot aws-py-apigateway-lambda-serverless aws-ts-apigateway-lambda-serverless