doks
0.9.3
Si tiene documentación extendida por todo el lugar (GitHub, Google Drive, etc.) y desea una herramienta de búsqueda centralizada sobre ella, entonces doks es para usted.
DOKS es una herramienta CLI que agrega documentos provenientes de múltiples fuentes (GitHub, Google Drive, etc.) en un motor de búsqueda (Lucene se usa de forma predeterminada para una configuración local mínima, pero ElasticSearch se puede usar en su lugar).
El procedimiento de instalación se puede encontrar en Docs/Install.md.
La documentación se puede encontrar en la carpeta Docs.
Seleccione un archivo de configuración que se use con doks (por defecto: $HOME/.doks/config/default.yml ):
❯ export DOKS_CONFIG_FILE=docs/examples/config/simple.yml Aquí estamos utilizando un archivo de configuración simple de docs/ejemplos/config/sencillo.yml. En la práctica, no necesita esta exportación, solo necesita colocar su configuración en la ruta esperada predeterminada $HOME/.doks/config/default.yml .
El siguiente paso es indexar los documentos a los que se hace referencia en el archivo de configuración para que se puedan buscar:
❯ doks index
14:23:58 INFO - [wlezzar/jtab] cloning into ' /tmp/doks1910419821411559250 '
14:24:00 INFO - [wlezzar/jtab] 1 documents found !
14:24:00 INFO - [wlezzar/doks] cloning into ' /tmp/doks8654245137262434689 '
14:24:02 INFO - [wlezzar/doks] 0 documents found !
14:24:02 INFO - [adevinta/zoe] cloning into ' /tmp/doks756581970042346717 '
14:24:04 INFO - [adevinta/zoe] 36 documents found !Realizar una consulta de búsqueda:
❯ doks search ' aws kafka ' | jq ' . 'Los resultados están en JSON y se verían como los siguientes:
[
{
"link" : " https://github.com/adevinta/zoe/blob/master/docs/advanced/runners/lambda.md " ,
"score" : 3.4977975 ,
"matches" : {
"content" : [
" # Lambda runner nn The lambda runner triggers lambda functions to read / produce to the <B>Kafka</B> " ,
" using CloudFormation (an S3 bucket, <B>AWS</B> roles, etc.). For more details on the resources deployed " ,
" into <B>AWS</B> and registering the lambda within <B>AWS</B>. Zoe jar path needs to be set and must point to a valid zoe "
]
}
},
...
]También puede usar JTAB para imprimir los resultados de JSON como una tabla:
❯ doks search ' documentation search ' | jtab | less -S
┌────────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬────────────┐
│ link │ matches │ score │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/wlezzar/doks/blob/master/README.md │ content: │ 6.044318 │
│ │ - " <B>documents</B> coming from multiple sources (github, google drive, etc.) into a <B>search</B> engine (Lucene " │ │
│ │ - " - [adevinta/zoe] 36 <B>documents</B> found!n ` ` ` nn Make a < B > search < /B > query: nn ` ` ` bashn❯ doks <B>search</B> 'aws kafka' | jq " │ │
│ │ - " # DoksnnIf you have <B>documentation</B> spread all over the place (github, google drive, etc.) and you " │ │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/adevinta/zoe/blob/master/docs/basics/consume.md │ content: │ 3.2647414 │
│ │ - " will discard the message or not.nnThis feature can be used to perform <B>searches</B> into Kafka topics. It is one " │ │
│ │ - " ` ) and parallel execution ( ` --jobs 20 ` to spin up 20 pods), we can perform expensive < B > searches < /B > " │ │
│ │ - " execution in the advanced section of the < B > documentation < /B > . nn Filters are enabled with the ` --filter ` option " │ │
└────────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴────────────┘DOKS también tiene un modo de interfaz de usuario para enemigos de CLI;)
❯ doks serve
23:16:10 INFO - listening on port: 8888
Ahora puede abrir su navegador en: http: // localhost: 8888.
DOKS está en sus primeras etapas. Se deben esperar errores;). Si encuentra algo o necesita ayuda, no dude en abrir un problema de GitHub.
