hound-search/hound

Add option for alternative link (docs, for example)

Open

#212 opened on Jun 4, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (606 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,470 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hound seems like it would be a great fit for my organization, but one feature which would be awesome to have would be the ability to link not just back to github/bitbucket/etc, but to generated docs or other resources derived from the source.

For example, when Hound links to this location:

https://github.com/ros/ros_comm/blob/kinetic-devel/clients/roscpp/include/ros/publisher.h

It could also provide links to the following locations:

http://docs.ros.org/api/roscpp/html/publisher_8h_source.html

http://docs.ros.org/api/roscpp/html/publisher_8h.html

And with a bit more contextual information, even this page:

http://docs.ros.org/api/roscpp/html/classros_1_1Publisher.html

Obviously these URLs would be pretty difficult to derive given no additional information, but I could easily have a Jenkins job generate some metadata for Hound, like a list of regexes for "if the file matches X, show URL Y as an alternate link".

This could also be done as a post-load thing using JavaScript, but it would be neat to have it as a native feature.

Contributor guide

Research direction
Investigate how to add a configuration option for custom link templates that map file paths to external URLs, possibly using regex patterns or a plugin system.
Tech stack
javascript
Domain
backendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50