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

[New Feature] Command Bar in Docs #11

Open
leecalcote opened this issue Oct 27, 2023 · 0 comments
Open

[New Feature] Command Bar in Docs #11

leecalcote opened this issue Oct 27, 2023 · 0 comments
Labels
issue/design required Design specification needed kind/enhancement Improvement in current feature kind/feature New major feature or request language/javascript Javascript related

Comments

@leecalcote
Copy link
Member

Current Behavior

Layer5 has a number of products. Each product has many resources. Each project site has a site search for that specific project. Visitors cannot search across all products at the same time. time.

Desired Behavior

In MeshMap, there needs to be a command palette to search through all the possible available resources and MeshMap, that can be designs, filters and applications, that also can be components on the MeshMap from any number of registered components, that could be components from Visualizer.

Priority: start with Designer, move to Visualizer.

Implementation

  1. Research the following two open source libraries:
  1. Support the following resources in Designer:
    (Resource type: what to display in the search preview)
    1. Meshery Catalog Design filenames: display owner and last modified date
    2. Meshery Catalog WASM Filter names: display owner and last modified date
    3. Meshery Integrations Models Names: display first portion of description
    4. Meshery Integrations Model Component Names: display first portion of description
    5. Meshery Integrations Model Policy Names: display first portion of description

Acceptance Criteria

  1. Light and dark modes are supported.
  2. On press of hotkey CMD+K (mac), CTL+K (win / lnx), the command bar is surfaced and displayed to the user.

Reference Implementations

  • Spotlight search on Mac (CMD+spacebar)
  • Google Drive's desktop app (OPTION+ALT+G)
  • Search bar on Linux (alt+spacebar)
  • ClickUp command bar (CMD+K)
  • GitHub Command Palette (CMD+K)
Screen Shot 2022-09-14 at 2 55 22 PM Screenshot 2023-03-12 at 6 55 08 PM Screenshot 2023-03-12 at 7 01 22 PM

Contributor Guide

@leecalcote leecalcote added issue/design required Design specification needed kind/enhancement Improvement in current feature kind/feature New major feature or request language/javascript Javascript related labels Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue/design required Design specification needed kind/enhancement Improvement in current feature kind/feature New major feature or request language/javascript Javascript related
Development

No branches or pull requests

1 participant