linkerd / linkerd/website

Add search functionality to the documentation section

Open
#1,156 4 comments 0 reactions 0 assignees View on GitHub
docs enhancement help wanted
Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

The [documentation](https://linkerd.io/2.10/overview/) section of the website contains drop-down menus with links to various sections. It would be nice if there was a way of searching through the documentation without having to click on the drop-downs and manually looking for a specific section. Maybe a search bar that dynamically filters the results as the user enters text?

Contributor guide

Open the contributing guide

Research direction

Start at the linked documentation section on linkerd.io and inspect how its drop-down navigation exposes documentation links. Determine how search should cover those sections and how results should be filtered as text is entered. Done means users can search the documentation without manually opening each drop-down.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.