hound-search/hound

Documentation for url-pattern

Open

#325 opened on Oct 16, 2019

View on GitHub
 (1 comment) (4 reactions) (0 assignees)JavaScript (5,470 stars) (606 forks)batch import
documentationhelp wanted

Description

Hi, I'm using private bitbucket and url-pattern has to be used.

The example in config-example.json doesn't work for me. I need to customize my own.

But I don't find any document explaining this config. I don't understand the relationship between url, base_url and url-pattern, and what parameters can be used like {path}, {filename}, etc. (is there a {branch}?)

Hope the answer is added into a document so that others can benefit from that.

Thanks

Contributor guide

Tech stack
javascriptgo
Domain
documentation
Issue type
documentation
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.
1-3 hours
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.
clear
Prerequisites
Basic understanding of HoundAbility to read configuration code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the config example.json file and the Go source code that processes url pattern (likely in backend). Look for any comments or documentation in the repository about the config keys. Also, check the existing issue comment for guidance from maintainers. The goal is to produce a clear explanation of url, base url, url pattern, and the available placeholders like {path}, {filename}, etc., and whether {branch} is supported.