vmware/pyvmomi

Improve Documentation Navigation

Open

#166 opened on 2014年9月15日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (2,141 stars) (807 forks)batch import
documentationenhancementhelp wanted

説明

Based on this question we should probably work on ways to make it easier to forward and backwards navigate property hierarchies.

コントリビューターガイド

技術スタック
python
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
Investigate the current documentation structure of pyvmomi, particularly the property hierarchy pages. Look at how forward and backward navigation could be added, possibly using breadcrumbs or links. Refer to the linked issue #164 for user feedback. Consider implementing a sidebar or table of contents that allows easy traversal.