Skip to content

Commit 43e2f9c

Browse files
docs: possibilitar a alteração da documentação para todos os colaboradores
1 parent 0d4c421 commit 43e2f9c

File tree

6 files changed

+5234
-88
lines changed

6 files changed

+5234
-88
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Você pode contribuir de várias maneiras, sendo as mais conhecidas as seguintes
3636
- [💥💻 Lint](#-lint)
3737
- [💥💻 Commit](#-commit)
3838
- [Publicação das releases](#publicação-das-releases)
39-
- [Documentação (serverest.dev)](#documentação-serverestdev)
39+
- [Documentação](#documentação)
4040
- [Reconhecimento de contribuição](#reconhecimento-de-contribuição)
4141
- [Execução do projeto via Makefile](#execução-do-projeto-via-makefile)
4242
- [Build](#build)
@@ -143,17 +143,13 @@ A publicação de novas versões no [NPM](https://www.npmjs.com/package/serveres
143143

144144
Para aprofundar sobre como é feita a publicação do _ServeRest_, leia o texto '[Entrega contínua no ServeRest](https://github.com/PauloGoncalvesBH/entrega-continua-no-serverest)'.
145145

146-
## Documentação (serverest.dev)
146+
## Documentação
147147

148-
[![Deploy docs on serverest.dev](https://github.com/ServeRest/ServeRest/workflows/Deploy%20docs%20on%20serverest.dev/badge.svg)](https://github.com/ServeRest/ServeRest/actions)
149-
150-
A documentação, disponibilizada na url <https://serverest.dev>, é editada no [apiary](https://apiary.io/home) e gerada a partir do [aglio](https://www.npmjs.com/package/aglio).
148+
A documentação, disponibilizada nas URLs <https://serverest.dev> e <http://localhost:3000>, é editada no arquivo `serverest.apib` e gerada a partir do [aglio](https://www.npmjs.com/package/aglio).
151149

152150
Para atualizar:
153-
1. Acesse o [editor do ServeRest no Apiary](https://app.apiary.io/serverest/editor) e faça as alterações necessárias.
154-
- É preciso ter permissão de edição.
155-
2. Realize o download do arquivo `serverest.apib` e salve esse arquivo na raiz do _ServeRest_.
156-
3. Execute o comando `npm run generate-doc`
151+
1. Acesse o arquivo `serverest.apib` que está dentro de _docs_ e o edite de acordo com sua necessidade.
152+
1. Execute o comando `npm run generate-doc:AMBIENTE` para gerar o HTML final.
157153

158154
## Reconhecimento de contribuição
159155

.github/mlc_config.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
},
1212
{
1313
"pattern": "https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional"
14+
},
15+
{
16+
"pattern": "http://localhost:3000"
1417
}
1518
]
1619
}

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ node_modules/
33
reports/
44

55
coverage.lcov
6-
serverest.apib
76
# stryker temp files
87
.stryker-tmp
98
stryker.log

0 commit comments

Comments
 (0)