Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- PostgreSQL
- Redator técnico:
- lu
- Nome do projeto:
- Tutorial introdutório
- Duração do projeto:
- Duração padrão (três meses)
Project description
Atualize o tutorial introdutório para melhorar a instalação e a experiência de configuração do PostgreSQL para iniciantes. (https://www.postgresql.org/docs/current/tutorial-start.html)
Converta o capítulo "Fundamentos de arquitetura" em uma introdução abrangente aos tutoriais do PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). As possíveis ampliações são a arquitetura cliente-servidor, o psql como um exemplo de cliente a ser usado neste tutorial, a terminologia "cluster" no contexto do PostgreSQL, os usuários e a propriedade do DB em comparação com o SO.
Atualize o tutorial de instalação (https://www.postgresql.org/docs/current/tutorial-install.html).
- Anunciar as opções de instalação binária e de origem. Adicione uma referência a https://www.postgresql.org/download/ (link em inglês) que oferece instruções mínimas de instalação binária.
- Identifique lacunas nas instruções de instalação binária, se houver, e expanda o site ou aborde-as na documentação.
- Não dependa de que os usuários leiam o capítulo completo de instalação da fonte e descubram como fazer: descreva as principais etapas necessárias após a instalação, como inicializar o cluster e iniciar (automaticamente) o servidor. Forneça links para capítulos específicos da documentação para mais detalhes, quando aplicável.
- Adicione links de recursos relevantes que expandem os padrões e as práticas recomendadas para um SO específico, se houver algum reconhecido pela comunidade.
Melhoria https://www.postgresql.org/docs/current/tutorial-createdb.html
- Elimine as instruções "consulte o administrador" sempre que possível. Forneça soluções práticas com base na suposição de que o usuário seguiu o tutorial passo a passo.
Melhoria https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Explicar problemas básicos relacionados à autenticação e exemplos triviais de pg_hba.conf
Para fornecer este patch de documentação, pretendo testar o tutorial atual no Windows e no Ubuntu, procurar problemas de configuração frequentes em fóruns e consultar mentores para garantir que eu siga as práticas recomendadas e que os conceitos mais importantes sejam explicados sem simplificação excessiva.