restify/node-restify

[Docs Site] Remove search bar

Open

#1539 opened on Oct 23, 2017

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (10,695 stars) (983 forks)batch import
CriticalDocsHelp Wanted

Description

Site: http://restify.com/ Browsers tested:

  • Chrome (62.0.3202.62 (Official Build) (64-bit))
    • Chrome private browsing
  • Firefox Developer Ed.
  • Safari (Version 11.0 (11604.1.38.1.7)) OS: macOS 10.11.6 El Capitan

Repro steps:

  • Navigate to http://restify.com/ in your browser
  • Type text into searchbox in upper right
  • press enter/return on keyboard, or
  • click magnifying glass icon

unable to search docs with searchbox

Expected result:

  • search is initiated by pressing enter/return on keyboard while search input field is focused
  • search is initiated by clicking on magnifying glass icon

Actual result:

  • enter/return on keyboard does nothing - search not initiated

Contributor guide

Tech stack
javascripthtmlcssnodejs
Domain
frontenddocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic HTMLBasic JavaScriptFamiliarity with browser developer tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the documentation site's search bar implementation. Look for JavaScript files handling the search input and ensure that keyboard 'Enter' press and click on the magnifying glass icon trigger a search function. The issue is located in the docs site source, likely in an HTML or JS file. Check the repository's documentation directory or the gh pages branch.