Introdução
Status: Finalizado ✅
Bem vindo à documentação do Obraplay! Aqui você encontrará:
- as etapas para onboarding de novos desenvolvedores
- padrões de projeto utilizados no desenvolvimento
- descrição de conceitos importantes que são utilizados no dia a dia
O que deve ser documentado
Basicamente tudo que estiver na lista acima. A ideia dessa documentação é centralizar as principais informações/processos que são utilizados no dia a dia. Sempre que for adotado uma nova ferramenta/processo/informação que seja importante o seu conhecimento é bem provável que a próxima tarefa a se fazer é coloca-la na documentação.
Como deve ser documentado
O tutorial de como inserir novas informações na documentação está na página de manutenção
Esse site é o resultado de um gerador de site estático chamado Docusaurus.
Com ele é possível escrever apenas em arquivos de markdown e
ele gera tudo para nós de acordo com as marcações feitas nesses arquivos.
Resumindo, o markdown é uma linguagem de marcação de texto. Se abrir um arquivo de extensão md, você verá que o texto tem algunas marcações,
e são elas que o Docusaurus pega como base para formatar aquele texto seguindo as convenções do markdown.
Links importantes
Ambientes
Frontend
Produção: https://app.obraplay.com/
Staging: https://app-staging.obraplay.com/
Desenvolvimento: https://app-dev.obraplay.com/
Backend
Produção: https://api.obraplay.com/
Staging: https://api-staging.obraplay.com/
Desenvolvimento: https://api-dev.obraplay.com/
Documentações
Geral
Rotas da API
Produção: https://api.obraplay.com/apidocs
Staging: https://api-staging.obraplay.com/apidocs
Desenvolvimento: https://api-dev.obraplay.com/apidocs