Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Open Source Geospatial Foundation
- Rédacteur technique:
- flicstar
- Nom du projet:
- Consultez les guides de démarrage rapide OSGeoLive
- Durée du projet:
- Durée standard (3 mois)
Project description
Objectif
- Mettez à jour les documents afin qu'ils restent à jour, exacts et pertinents.
- Créez un modèle pour assurer la cohérence entre les documents et pour les prochains guides de démarrage rapide.
Audience
- Les nouveaux utilisateurs de l'OSGeo sont en direct
- Rédacteurs de nouveaux guides de démarrage rapide OSGeo Live
Diffusion
- Wiki
Voici ce qui, selon moi, doit être fait:
- Suivez les 50 guides de démarrage rapide OSGeo Live.
- Marquez des éléments avec des modifications. Envoyer pour examen.
- Implémenter l'examen/le feedback
- Créer un modèle de démarrage rapide pour implémenter la cohérence à l'avenir.
- Mettez à jour la procédure de démarrage rapide.
- Ajout de nouvelles applications à OSGeoLive. Elles ont besoin des guides de démarrage rapide.
Ce que je propose de faire:
Consultez 50 guides de démarrage rapide OSGeo Live et marquez les modifications en utilisant ces pages comme référence:
Nouveau: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Ancienne version: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Créer des problèmes de documentation dans trac (Issue Tracker)
Fournissez un rapport résumant les résultats. Par exemple, un pourcentage des 50 qui nécessitent un travail minimal, moyen ou important.
Créez un modèle de démarrage rapide pour implémenter la cohérence à l'avenir.
Mettez à jour la page "Comment documenter le fichier de démarrage rapide".
Voici ce dont vous disposerez à la fin du SoD:
- 50 tickets de documentation dans Trac, avec des guides de démarrage rapide balisés conformément au modèle convenu
- Instantané de l'état actuel des guides de démarrage rapide OSGeo Live et des efforts à fournir pour les mettre à jour.
- Modèle de démarrage rapide mis à jour et cohérent avec le modèle du guide d'entraînement.
- Processus mis à jour pour la documentation de démarrage rapide.
Par où je vais commencer:
- Consultez la feuille de calcul des packages OSGeo-Live pour voir quels packages ont changé entre les versions.
- Demandez à la liste de diffusion OSGEo Live si elle a des suggestions de guides de démarrage rapide spécifiques pour commencer.
Ce que j'ai déjà fait:
- Configurer ma VM et installer OSGeoLive
- Dupliquer le dépôt OSGeoLive-Doc
- Accès à Trac et examen de demandes d'assistance existantes La demande n° 1382 semble pertinente: https://trac.osgeo.org/osgeolive/ticket/1382
- Participer à des discussions par liste de diffusion
- Quelqu'un a eu quelques chats vidéo informels