Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Open Source Geospatial Foundation
- Rédacteur technique:
- flicstar
- Nom du projet:
- Consulter les guides de démarrage rapide d'OSGeoLive
- Durée du projet:
- Durée standard (trois mois)
Project description
Objectif
- Mettez à jour les documents pour les actualiser, les rendre précis et pertinents.
- Créez un modèle pour assurer la cohérence entre les documents et pour les futurs guides de démarrage rapide.
Audience
- Nouveaux utilisateurs d'OSGeo en direct
- Auteurs des nouveaux guides de démarrage rapide OSGeo Live
Envoi
- Wiki
Voici ce que je pense qu'il faut faire:
- Parcourez les 50 guides de démarrage rapide OSGeo Live existants.
- Balisage avec modifications. Envoyez-les pour examen.
- Implémenter l'avis/les commentaires
- Créez un modèle de démarrage rapide pour assurer la cohérence à l'avenir.
- Mise à jour de la procédure de démarrage rapide.
- Ajoutez de nouvelles applications à OSGeoLive. Elles ont besoin de démarrages rapides.
Ce que je me propose de faire:
Passez en revue 50 guides de démarrage rapide OSGeo Live existants et ajoutez des modifications en utilisant ces pages comme référence:
Nouveau: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Ancien: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Créer des problèmes de documentation dans trac (outil de suivi des problèmes)
Fournissez un rapport récapitulatif du résultat. Par exemple, le pourcentage des 50 tâches qui nécessitent un travail minimal, moyen ou important.
Créez un modèle de démarrage rapide pour assurer la cohérence à l'avenir.
Mise à jour de la page "Comment documenter le fichier de démarrage rapide".
Voici ce que vous aurez à la fin de la phase de conception:
- 50 demandes de documentation dans Trac, avec des guides de démarrage rapide marqués conformément au modèle de guide de démarrage rapide convenu
- Instantané de l'état actuel des démarrages rapides OSGeo Live et du travail requis pour les mettre à jour.
- Modèle de démarrage rapide mis à jour, conforme au modèle du guide de formation.
- Mise à jour du processus de documentation du guide de démarrage rapide.
Voici par où je vais commencer:
- Consultez la feuille de calcul des paquets OSGeo-Live pour voir quels paquets ont changé entre les versions.
- Demandez à la liste de diffusion OSGEo Live s'ils ont des suggestions de démarrages rapides spécifiques à suivre.
Ce que j'ai déjà fait:
- J'ai configuré ma VM et installé OSGeoLive.
- Duplication du dépôt OSGeoLive-Doc
- J'ai obtenu l'accès à Trac et examiné certains tickets de documentation existants. Le ticket 1382 semble pertinent: https://trac.osgeo.org/osgeolive/ticket/1382
- avoir participé aux discussions de la liste de diffusion ;
- A eu quelques discussions vidéo informelles