Documentação

Esse documento é referente ao mapeamento e organização da documentação do projeto. Contém: proposta da arquitetura da documentação, anotações e links.

Arquitetura da documentação

A documentação tem como base duas raízes, sendo uma focada para usuários da plataforma (sejam administradores ou não) e outra focada no Desenvolvimento, com orientações técnicas e para colaboração da comunidade.

• Para ambos, a documentação final fica disponível para navegação em http://localhost:8000/docs
• O layout da home esta em https://invis.io/S2O0MT3NBYA e com toggle aberto https://invis.io/CXO2AR58WMS
• Estilo de formatação para escrever a documentação em RST -> https://documentation-style-guide-sphinx.readthedocs.io/en/latest/_sources/style-guide.txt

Logo abaixo você encontra uma estrutura inicial para nossa documentação do projeto, ainda esta pendente organizar a parte de Desenvolvimento. Na parte do Guia de Uso, estamos unindo esforços para escrever, revisar (entende-se por realizar o procedimento descrito em uma documentação, não somente a parte da qualidade de escrita) e traduzir.

User Guide / Guia de Uso - en - pt_BR

• en - pt_BR - Criando um cadastro e começando a usar
• en - pt_BR - Como criar ou participar das conversas?
• en - pt_BR - Como funciona o sistema de votação?
• en - pt_BR - Como tornar minha conversa popular?
• en - pt_BR - Como buscar ou organizar minhas conversas?
• en - pt_BR - Denunciando uma conversa ou perfil
• en - pt_BR - Saiba mais sobre sua privacidade e termos de uso
• en - pt_BR - Conheça os recursos de Acessibilidade da plataforma

Guia de Desenvolvimento (em organização)

• Quick Start
• Contribuindo
• Architecture Overview
• Preparing the Development Environment
• Design Guide
• Devel Community
• Integrations
• Best Practices
• Repositório de código
• Collaborating with documentation
• Internationalization

Demandas ou documentação legado

• Criar as guidelines para contribuição de código no EJ #407
• Organizar a documentação de deploy #285
• #174 Documentação boogie
• #220 Guia de aplicação do tema
• #234 Documentação da customização do rocket
• #40 Inv tasks das alterações do rocket
• #166 Estimativa do consumo de infra do EJ
• #170 Readthedocs
• #168 Repositório da documentação
• #171 Estilos no sphinx