O serviço tem por objetivo reunir e manter atualizadas as documentações de referência dos serviços que compõem o eco-sistema de micro-serviços do PJe, bem como as documentações relevantes para a implantação e referência das equipes que utilizam o sistema.

1. Tecnologias empregadas

O serviço de documentações utiliza o processador de textos AsciiDoctor o qual permite a converção de textos com conteúdo AsciiDoc em HTML5, PDF, DocBook e outros formatos.

Como referência rápida de sintaxe pode-se utilizar este guia: AsciiDoc Syntax Quick Reference

2. Quick start

$ git clone git@git.cnj.jus.br:pje2/pje2-documentacao.git
$ ./mvnw clean package spring-boot:run

Em um browser acesse o endereço http://localhost:9876. Caso tudo tenha dado certo você verá um índice com a documentação disponível.

3. Como colaborar com este projeto

Na pasta src/main/aciidoc estão os arquivos de documentação do projeto. Cada pasta representa uma categoria. Para produzir uma nova documentação crie uma pasta dentro de uma das categorias. Dentro da nova pasta crie seu arquivo com extensão .adoc e uma outra pasta para guardar suas imagens, se for o caso. Pronto! Você ja pode elaborar sua documentação. Não esqueça de adicionar a entrada no índice, que está no arquivo index.adoc.

4. Release notes