examples
examples copied to clipboard
Improve navigating experience with our /examples repo
Hello!
- Vote on this issue by adding a 👍 reaction
- If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)
Issue details
Problem:
- Navigating the landing page for our
github.com/pulumi/examples
repo is a less than ideal experience as the user must scroll past 100s of examples before getting to theREADME.md
instructions.
Potential Solution:
- Update any existing
github.com/pulumi/examples
reference links togithub.com/pulumi/examples#readme
.
Affected area/feature
Any existing redirects to the /examples repo.
Definitely much we could do here! Looking forward to talking through it.
As discuss on X with @cnunciato 😉, here are my ideas : It could be interesting to split the repo in several ones to help the user find his way. Two possible splitting in my mind:
- by target (aws, gcp, ...): it follows the current naming structure
- by langage (go, ts, ...): it would be the one I prefer, because I first choose my language
Or a more complex one but that is the most complete:
|_ platform
|_ language
After though, a less intrusive one, would be to just "de-flatten" the current one with the approach platform / langage / sample
: it will avoid the long list and ease to find our path to the sample we need
Hi @cnunciato @desteves @dirien
i've tried to initialize something : https://github.com/yodamad/pulumi-examples/tree/master
🚧 Work is in progress, I've just done the job for AWS.
Let me know what you do think about it, if it looks ok for you, I can do the other providers 😉
PR associated (marked as WIP) : https://github.com/pulumi/examples/pull/1630