Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organização e atualização de arquivos da documentação #189

Merged
merged 15 commits into from
Nov 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .gitbook.yaml

This file was deleted.

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ db/
### PyCharm ###
.idea/

### GitBook ###
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boa!

_book/

# Created by https://www.gitignore.io/api/vim,linux,macos,python
### Linux ###
*~
Expand Down
66 changes: 64 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ conectores, onde ele identifica a *intent*, e responde pelo Rasa Core, de acordo
As *models* utilizadas para a conversação foram geradas pelo módulo *trainer* e depois transferidas para o bot, estes
modelos podem ser versionados e evoluídos entre bots.
Os notebooks avaliam o funcionamento de acordo com o formato das *intents* e *stories*.
O elasticsearch coleta os dados da conversa e armazena para a análise feita pelo kibana, que gera gráficos para
O ElasticSearch coleta os dados da conversa e armazena para a análise feita pelo Kibana, que gera gráficos para
avaliação das conversas dos usuários e do boilerplate.

### Bot

Este script foi configurado para construir as imagens genéricas necessárias para execução deste ambiente.
Caso seu projeto utilize este boilerplate e vá realizar uma integração contínua ou similar, é interessante
criar um repositório para as imagens e substitua os nomes das imagens "lappis/bot", e "lappis/botrequirements" pelas suas respectivas novas imagens, por exemplo "<organização>/bot" em repositório público.
criar um repositório para as imagens e substituir os nomes das imagens "lappis/bot", e "lappis/botrequirements" pelas suas respectivas novas imagens, por exemplo "<organização>/bot" em repositório público.


### Treinamento
Expand Down Expand Up @@ -151,6 +151,68 @@ make run-notebooks

Acesse o notebook em `localhost:8888`

## Documentação

A documentação do projeto pode ser executada localmente utilizando o [GitBook](https://www.gitbook.com/).
Para instalar o gitbook via npm, é preciso ter instalado no computador [Node.js e npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).


Para conferir a versão do npm:

```sh
npm -v
```

Agora instale o [gitbook](https://til.secretgeek.net/gitbook/use_gitbook_locally.html):

```sh
npm install -g gitbook
```

Agora instale o pacote `cli`:

```sh
npm install -g gitbook-cli
```

Depois de instalado, na pasta raíz do projeto, execute:

```sh
gitbook build .
```

E para rodar localmente execute:

```sh
gitbook serve .
```

E acesse:

```
http://localhost:4000/
```

Você também pode rodar o projeto em uma porta diferente:

```sh
gitbook serve . --port 4003
```



#### Observações

Quando executa o comando `gitbook build .` é criado uma pasta `_book` que contém o arquivo `index.html` e os outros htmls da documentação. Desta forma também é possível visualizar o arquivo `_book/index.html` diretamente em um navegador.


Caso na hora de instalar o gitbook a versão do npm estiver desatualizada, você pode atualizar para a [versão mais recente](https://docs.npmjs.com/try-the-latest-stable-version-of-npm) ou uma versão específica.


Na raíz do projeto tem o arquivo `SUMMARY.md`, e é importante se atentar a ele pois o que não estiver mapeado nele, não será possível abrir como uma página html no gitbook.

**Contribuição**: Para contribuir com a documentação do projeto leia [como contribuir para a documentação](docs/Tutoriais/tutorial-como-contribuir-com-documentacao.md)

# Como conseguir ajuda

Parte da documentação técnica do framework da Tais está disponível na
Expand Down
26 changes: 26 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Summary

* [Introdução](README.md)
* [Qualidade do bot](docs/pipeline-de-qualidade.md)

* [Tutoriais]()
* [Configuração de pipeline de bot](docs/Tutoriais/tutorial-pipeline-de-bot.md)
* [Criação de utter](docs/Tutoriais/tutorial-como-fazer-uma-utter.md)
* [Criação de testes automatizados](docs/Tutoriais/tutorial-testes-automatizados.md)
* [Primeira conversa](docs/Tutoriais/tutorial-primeira-conversa.md)
* [Configuração da Policy do chatbot](docs/Tutoriais/tutorial-como-treinar-o-modelo.md)
* [Criação de visualizações no Kibana](docs/Tutoriais/tutorial-criar-BI.md)
* [Adicionar bot ao RockectChat](docs/Tutoriais/tutorial-add-bot-rocketchat.md)
* [Contribuir com a Documentação](docs/Tutoriais/tutorial-como-contribuir-com-documentacao.md)

* [Setup]()
* [Setup do bot no Telegram](docs/Setup/setup_telegram.md)
* [Configurando os usuários](docs/Setup/setup_user_elasticsearch.md)
* [Setup Analytics](docs/Setup/setup_analytics.md)


# English Summary

* [English]()
* [Introduction](docs/README-en.md)

240 changes: 0 additions & 240 deletions docs/README.md

This file was deleted.

File renamed without changes.
Loading