search

ayrtonteshima / ead-api

API da plataforma de ensino a distância desenvolvida junto ao canal do YouTube Programador a Bordo
MIT License
196 stars 34 forks source link

Site para documentação #6

Open ribafs opened 5 years ago

ribafs commented 5 years ago

Olá a todos!

Gostaria de colaborar com a criação de um site para a documentação aqui mesmo neste repositório. Pode ser feito facilmente na pasta docs.

Pesquisei bastante sobre estes geradores de sites estáticos que podem ser hospedados no GitHub. O que mais gostei foi do mkdocs, mas se alguém conhecer outro que seja melhor vamos trocar ideia. https://www.mkdocs.org/

Ele trabalha com markdown e gera em HTML.

ribafs commented 5 years ago

Com o intuito de melhorar um debate... Estudando o material que tenho sobre o MkDocs acabei criando um repositório para mostrar como fica um site estático criado com ele. Apenas um teste não acabado. Em especial veja a seção PHP e o tutorial. https://ribafs.github.io/mkdocs/

orodrigogo commented 5 years ago

Com o intuito de melhorar um debate... Estudando o material que tenho sobre o MkDocs acabei criando um repositório para mostrar como fica um site estático criado com ele. Apenas um teste não acabado. Em especial veja a seção PHP e o tutorial. https://ribafs.github.io/mkdocs/

Interessante essa ferramenta ein. Uma boa ideia ir documentando o projeto. Não rola usar a Wiki do próprio Github aqui?

programadorabordo commented 5 years ago

Boa pessoal! Vou caçar mais alguns também para olharmos. Gostaria de fazer um site também para promover a plataforma, ter a documentação e futuramente até uma área de blog

nelsonmfinda commented 5 years ago

Acho uma boa ideia @ribafs

ribafs commented 5 years ago

Também. :)

Em ter, 3 de set de 2019 às 12:18, Nelson Mfinda notifications@github.com escreveu:

Acho uma boa ideia @ribafs https://github.com/ribafs

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/programadorabordo/ead-api/issues/6?email_source=notifications&email_token=AAGQZIBL7OAQU26XV2QZFK3QHZ53NA5CNFSM4IFSJ342YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5YRUAA#issuecomment-527505920, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGQZIFCE7IDECY62Y4F7VTQHZ53NANCNFSM4IFSJ34Q .

-- Colaborar é ser humano

             Ribamar FS - http://ribafs.org
programadorabordo commented 5 years ago

Aqui tem uma boa relação de tools para documentar API: https://nordicapis.com/ultimate-guide-to-30-api-documentation-solutions/

Estou pensando, depois que adotarmos uma e começar a documentar, vou hospedar em algum lugar (google cloud, aws, digital ocean...) e todo commit no master, vai fazer o deploy automático de toda aplicação (containers) e podemos ficar brincando com a API :)