Handbook Diretoria Central de Transparência Ativa

O objetivo deste repositório é documentar alguns trabalhos/achados na Diretoria Central de Transparência Ativa - DCTA/CGE-MG

Setup :open_book:

O setup windows poderá ser realizado via:

$ git clone https://github.com/transparencia-mg/handbook.git
$ cd handbook  
$ python -m venv venv
$ source venv/Scripts/activate
$ pip install -r requirements.txt

O setup linux poderá ser realizado via:

$ git clone https://github.com/transparencia-mg/handbook.git
$ cd handbook  
$ make setup
$ source venv/bin/activate

Obs.: Usuários linux poderão utilizar comandos make, consulte as opções disponíveis em via comando make help. Check automated tasks with make or make help comands.

Comando mkdocs serve cria servidor local para visualização, em tempo real, das modificações realizadas no documento.

Publicações de novas versões do documento

Versionamento desta documentação foi criada utilizando a biblioteca mike, conforme orientações material mkdocs. Exemplo de implementação e o repositório de origem também podem ser utilizados como referência. Actions para publicação da documentação dev foi criado para facilitar o processo de deploy da documentação que está sendo constantemente atualizada. Ao final de toda sprint publicação da nova versão (latest) deverá ser realizada manualmente via:

$ git checkout gh-pages
$ git pull origin gh-pages
$ mike deploy --push --update-aliases <minor>.<major> latest

Confira também esta issue utilizado para documentar processo de versionamento.

Visualização local da documentação versionada poderá ser feita via comando mike serve

Contribuições

Encontrou algo errado ou gostaria de enviar alguma sugestão. Abra um Issue para nós.