Esta página contém os detalhes de um projeto de escrita 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 de introdução
- 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 Architectural Fundamentals em uma introdução abrangente aos tutoriais do PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). É possível expandir outras coisas são a arquitetura cliente-servidor, o uso do HBase como exemplo neste tutorial, a terminologia de "cluster" no contexto do PostgreSQL, a propriedade e os usuários de DB vs. SO.
Atualize o tutorial de instalação (https://www.postgresql.org/docs/current/tutorial-install.html).
- Anuncie opções de instalação binária e de origem. Adicione a referência a https://www.postgresql.org/download/, que oferece instruções mínimas de instalação binária.
- Identifique lacunas nas instruções de instalação binárias, se houver, e amplie o site ou as resolva na documentação.
- Não dependa dos usuários que leiam todo o capítulo de instalação do código-fonte e descubram o que fazer: defina as principais etapas necessárias após a instalação, como inicializar o cluster e iniciar o servidor automaticamente. Inclua links para capítulos de documentação específicos para mais detalhes, quando aplicável.
- Adicione links para recursos relevantes que abordam os padrões e as práticas recomendadas para um SO específico, se houver algum reconhecido pela comunidade.
Melhora 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 com base no pressuposto de que o usuário seguiu o tutorial passo a passo.
Melhora em 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 testar o tutorial atual no Windows e no Ubuntu, procurar fóruns sobre problemas frequentes de configuração e consultar mentores para garantir que as práticas recomendadas estejam corretas e que os conceitos mais importantes sejam explicados sem simplificação excessiva.