このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Open Source Geospatial Foundation
- テクニカル ライター:
- flicstar
- プロジェクト名:
- OSGeoLive クイックスタートを確認する
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
目的
- ドキュメントを更新して、最新の状態、正確な状態、関連性の高い状態に保つ。
- ドキュメント全体の整合性を確保し、今後追加される新しいクイックスタートに使用できるように、テンプレートを作成します。
オーディエンス
- OSGeo Live の新規ユーザー
- 新しい OSGeo ライブ クイックスタートのライター
配信
- Wiki
必要なご対応は次のとおりです。
- 50 個の既存の OSGeo Live クイックスタートを実行する
- 編集内容をマークアップします。審査に送る。
- レビュー/フィードバックを実装する
- 今後の整合性を確保するために、クイックスタート テンプレートを作成します。
- 「クイック スタートの手順」を更新しました。
- OSGeoLive に新しいアプリを追加する - クイックスタートが必要。
提案する内容は次のとおりです。
既存の OSGeo ライブ クイックスタート ガイド 50 件を確認し、編集してマークアップします。参考として以下のページを参考にしてください。
新規: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
旧: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
trac でドキュメントの問題を作成する（Issue Tracker）
結果をまとめたレポートを提供します。たとえば、50 件のうち、最小限の作業、中程度の作業、多くの作業が必要なものの割合です。
クイックスタート テンプレートを作成して、今後の整合性を確保します。
「クイックスタート ファイルを記述する方法」のページを更新しました。
SoD の最後に行うもの:
- Trac に 50 件のドキュメント チケットがあり、合意済みのクイックスタート テンプレートに基づいてクイックスタートがマークアップされている
- OSGeo Live クイックスタートの現在のステータスと、更新に必要な作業量のスナップショット。
- トレーニング ガイドのテンプレートと一致する最新のクイックスタート テンプレート。
- 更新されたクイックスタート ドキュメント プロセス。
以下に、その手順をご紹介します。
- リリース間でどのパッケージが変更されたかは、OSGeo-Live Packages スプレッドシートで確認できます。
- 最初に行うべき具体的なクイックスタートについて、OSGEo Live メーリング リストで提案を募集します。
すでに実施した内容:
- VM を設定して OSGeoLive をインストール
- OSGeoLive-Doc リポジトリをフォークしました
- trac にアクセスし、既存のドキュメント チケットを確認しました。チケット #1382（関連あり）: https://trac.osgeo.org/osgeolive/ticket/1382
- メーリング リストのディスカッションに参加した
- 非公式のビデオチャットを数回行った