hound-search/hound

Documentation for url-pattern

Open

#325 aberto em 16 de out. de 2019

Ver no 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

Guia do colaborador

Pilha de tecnologia
javascriptgo
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic understanding of HoundAbility to read configuration code
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.