search

carvel-dev / ytt

YAML templating tool that works on YAML structure instead of text
https://carvel.dev/ytt
Apache License 2.0
1.65k stars 135 forks source link

[ytt playground] Add searchable tags to examples and example sets #409

Open gcheadle-vmware opened 3 years ago

gcheadle-vmware commented 3 years ago

Describe the problem/challenge you have When using the playground, I have to load an example to see the contents. Since the titles of certain examples can be misleading, searching by hand for the example I want is challenging.

Describe the solution you'd like Add a search bar for the playground. This search bar would filter out examples based on the contents of the example, or the tags that we assign the example. This would allow a user to look for something like missing_ok=True and find an example rather quickly

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible" 👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

pivotaljohn commented 3 years ago

We've received countless reports of users learning themselves on ytt largely on the examples. Adding the ability to search the contents of examples means (at least) two things:

  1. we can add more examples / example groups with less concern about overwhelm, knowing that the examples are searchable
  2. users can pin-point examples faster which could improve their productivity with the tool.

==> "carvel accepted"

pivotaljohn commented 3 years ago

Questions to initiate elaboration:

Q: What would the UX be? would non-matching examples fade to grey? would they be eliminated? would the display of examples switch from groups to a list of matches? Q: Should searches be deep-linkable / sharable? Q: Should this feature be available through the website command? Q: What's possible with off-the-shelf embedded text search libraries? How does that compare with a simple home-spun solution?