examples icon indicating copy to clipboard operation
examples copied to clipboard

Improve navigating experience with our /examples repo

Open desteves opened this issue 1 year ago • 4 comments

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 the README.md instructions.

Potential Solution:

  • Update any existing github.com/pulumi/examples reference links to github.com/pulumi/examples#readme.

Affected area/feature

Any existing redirects to the /examples repo.

desteves avatar Jan 17 '24 15:01 desteves

Definitely much we could do here! Looking forward to talking through it.

cnunciato avatar Jan 18 '24 18:01 cnunciato

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

yodamad avatar Apr 07 '24 20:04 yodamad

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

yodamad avatar Apr 07 '24 20:04 yodamad

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

yodamad avatar Apr 12 '24 07:04 yodamad