theupdateframework / theupdateframework/python-tuf

doc: consider re-adding a "quickstart" document

オープン
#1,797 コメント 7 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

backlog documentation
主要言語
Python
スター
1.7k
フォーク
304
平均マージ
1日 2時間
マージ済み PR(30日)
17

説明

Supersedes https://github.com/theupdateframework/python-tuf/issues/1006

Description of issue or feature request:
#1790 removes QUICKSTART.md because it is severely outdated. The new client and repo examples should be a good replacement to quickly get users familiar with python-tuf and are also easy to discover (e.g. via main README and main menu on RTD).

Still, there might be merit in better framing these examples or adding additional examples as a "quick start"-documentation (note: this is also a silver criteria for the cii badgeapp).

Current behavior:

  • no explicit "quick start" documentation

Expected behavior:

  • consider adding quick start documentation or better frame existing documentation

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

examples/ 配下のクライアントおよびリポジトリの例を確認し、QUICKSTART.md が #1790 によって削除された後、それらが README.md と docs/index.rst からどのようにリンクされているかを追跡します。既存の資料を、要求されている quick-start の目標および CII badge の基準と比較します。ドキュメントの方針と、必要な位置付けまたは追加内容が明確に定義され、実装されれば作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。