vmware/pyvmomi

Improve Documentation Navigation

Open

#166 opened on Sep 15, 2014

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (807 forks)batch import
documentationenhancementhelp wanted

Repository metrics

Stars
 (2,141 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Contributor guide

Research direction
Explore the pyvmomi property hierarchy documentation and suggest ways to improve forward/backward navigation, possibly using breadcrumbs, tree views, or linking between related properties.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85