Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve navigating experience with our /examples repo #1575

Open
desteves opened this issue Jan 17, 2024 · 4 comments
Open

Improve navigating experience with our /examples repo #1575

desteves opened this issue Jan 17, 2024 · 4 comments
Labels
kind/enhancement Improvements or new features

Comments

@desteves
Copy link
Contributor

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 desteves added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Jan 17, 2024
@desteves desteves changed the title Improve experience with our /examples repo Improve navigating experience with our /examples repo Jan 17, 2024
@cnunciato
Copy link
Contributor

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

@cnunciato cnunciato removed the needs-triage Needs attention from the triage team label Jan 18, 2024
@cnunciato cnunciato transferred this issue from pulumi/pulumi-hugo Feb 6, 2024
@yodamad
Copy link
Contributor

yodamad commented Apr 7, 2024

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
Copy link
Contributor

yodamad commented Apr 7, 2024

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
Copy link
Contributor

yodamad commented Apr 12, 2024

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) : #1630

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement Improvements or new features
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

3 participants