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

Searching the documentation for "bundles" doesn't suggest the actual docs on bundles #6986

Open
anderseknert opened this issue Sep 3, 2024 · 1 comment

Comments

@anderseknert
Copy link
Member

I wanted to look something up in the OPA docs on bundles today, and so I searched for “bundle” and “bundles” to get there quickly. But.. neither of these terms actually provide a link to the canonical page on bundles. Instead the items in the list link to:

  1. Ecosystem page on bundles
  2. Configuration section on bundles
  3. Ecosystem page on discovery bundles
  4. A sub-section of the Envoy tutorial
  5. The “external data” page

As someone else observed, this is likely due to the heading on that page being a <span> rather than a proper h1/h2 heading.

Additionally, the search results would be greatly improved if some descriptive text was placed under each item, as 3 items all saying "Bundles" doesn't tell me much about which one I should click.

Screenshot 2024-09-03 at 12 44 03

Copy link

stale bot commented Oct 5, 2024

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days. Although currently inactive, the issue could still be considered and actively worked on in the future. More details about the use-case this issue attempts to address, the value provided by completing it or possible solutions to resolve it would help to prioritize the issue.

@stale stale bot added the inactive label Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant