hound-search/hound

Documentation for url-pattern

Open

#325 ouverte le 16 oct. 2019

Voir sur GitHub
 (1 commentaire) (4 réactions) (0 assignés)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

Guide contributeur

Stack technique
javascriptgo
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of HoundAbility to read configuration code
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.