Docs: include a 'How do I...?' table to direct on common tasks
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 42/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、xarray のドキュメントにある同等の「How do I...?」表を確認し、次にこのリポジトリの既存のドキュメント構成を調べます。一般的なユーザータスクを、該当するメソッド、API リファレンス、例、チュートリアル、レシピに対応付けるドキュメントページを作成します。完了条件は、特定したタスクについて表にそれらのナビゲーションリンクが用意されていることです。
索引モデルが issue の本文から書いたものです。
説明
As part of our summit this week, we have identified that users would benefit from a page in the documentation which centers around a table which list common tasks that a user might want to do and maps them to relevant methods and their API reference pages; examples; and documentation sections.
A great example of this is an equivalent table in the xarray docs. As well as pointing to methods of direct relevance as per that table, we can include some extra columns which point to relevant sections of the Tutorial and relevant recipes, where applicable.
- 主要言語
- Python
- スター
- 150
- フォーク
- 23
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 2
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NCAS-CMS/cf-python のほかの issue
-
code tidy
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
bug?
-
release
-
enhancement
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
NCAS-CMS/cf-python の issue をすべて見る
似ている issue
-
agent-ready documentation needs-triage
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
instance instance add
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
searxng/searx-instances#939 · コメント 1 件 ·
-
area-deployment area-integrations triage:bot-seen
難易度 2/5 半日 初心者へのやさしさ 86/100