Projeto da Fundação Geospatial de código aberto

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:

Fundação Geoespacial de código aberto

Redator técnico:

flicstar

Nome do projeto:

Revisar os guias de início rápido do OSGeoLive

Duração do projeto:

Duração padrão (três meses)

Project description

Finalidade

• Atualize os documentos para mantê-los atualizados, precisos e relevantes.
• Crie um modelo para garantir a consistência entre os documentos e para as novas formações rápidas que serão adicionadas no futuro.

Público-alvo

• Novos usuários do OSGeo live
• Criadores de novos guias de início rápido do OSGeo Live

Entrega

• Wiki

O que eu acho que precisa ser feito:

1. Confira os 50 guias de início rápido do OSGeo ao vivo
2. Marcação com edições. Enviar para análise.
3. Implementar a avaliação/feedback
4. Crie um modelo de início rápido para implementar a consistência no futuro.
5. Atualize o "Como fazer um procedimento de início rápido".
6. Adiciona novos apps ao OSGeoLive: eles precisam de guias de início rápido.

O que proponho fazer:

• Revise 50 guias de início rápido do OSGeo Live e faça marcações com edições usando estas páginas como referência:

  Novo: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file

  Antigo: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation

• Criar problemas de documentação no trac (rastreador de problemas)

• Forneça um relatório resumindo o resultado. Por exemplo, a porcentagem dos 50 que exigem trabalho mínimo, médio ou muito.

• Criar um modelo de início rápido para implementar consistência no futuro.

• Atualizamos a página "Como documentar o arquivo de início rápido".

O que você terá no final do SoD:

• 50 tickets de documentação no Trac, com guias de início rápido marcados de acordo com o modelo de guia de início rápido acordado
• Um resumo do status atual dos tutoriais rápidos do OSGeo Live e de quanto trabalho é necessário para atualizá-los.
• Um modelo de início rápido atualizado e consistente com o do guia de treinamento
• Um processo atualizado de documentação do Guia de início rápido.

Por onde vou começar:

• Consulte a planilha "OSGeo-Live Packages" para saber quais pacotes mudaram entre as versões.
• Pergunte à lista de e-mails do OSGEo Live se eles têm sugestões de Guias de início rápido específicos para começar.

O que eu já fiz:

• Configurei minha VM e instalei o OSGeoLive.
• Bifurcação do repositório OSGeoLive-Doc
• Acesso ao trac e revisão de alguns tickets de documentos. O tíquete 1382 parece relevante: https://trac.osgeo.org/osgeolive/ticket/1382
• Participou de discussões na lista de e-mails
• Teve alguns chats informais por vídeo