Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do Google.
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 (3 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 "Architecture Fundamentals" em uma introdução abrangente aos tutoriais do PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Possíveis coisas a expandir são a arquitetura cliente-servidor, o psql como exemplo de cliente a ser usado neste tutorial, a terminologia ""cluster"" no contexto do PostgreSQL, usuários de banco de dados vs. sistema operacional e propriedade.
Tutorial de instalação de atualização (https://www.postgresql.org/docs/current/tutorial-install.html).
- Anuncie as opções de instalação de origem e binária. Adicione a referência a https://www.postgresql.org/download/ (link em inglês), que oferece o mínimo de instruções de instalação binária.
- Identifique lacunas nas instruções de instalação binária, se houver, e expanda o site ou as resolva na documentação.
- Não dependa que os usuários leiam o capítulo completo da instalação do código-fonte e o descubram. Defina as principais etapas necessárias após a instalação, como inicializar o cluster e iniciar o servidor automaticamente. Forneça links para capítulos de documentação específicos para mais detalhes, quando aplicável.
- Adicione links do recurso "Ver também" para recursos relevantes que se expandem sobre os padrões e as práticas recomendadas para um sistema operacional específico, se houver algum reconhecido pela comunidade.
Melhore https://www.postgresql.org/docs/current/tutorial-createdb.html
- Livre-se das instruções de ""consultar o administrador"" sempre que possível; forneça soluções acionáveis partindo do princípio de que o usuário seguiu o tutorial passo a passo.
Melhore https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Explicar os problemas básicos relacionados à autenticação e a exemplos triviais do pg_hba.conf
Para fornecer esse patch de documentação, pretendo experimentar o tutorial atual no Windows e Ubuntu, procurar fóruns para problemas frequentes de configuração e consultar mentores para garantir que eu aplico as práticas recomendadas corretamente e que os conceitos mais importantes sejam explicados sem simplificação excessiva.