vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 opened on Jan 30, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (2,141 stars) (807 forks)batch import
documentationhelp wantedsample requestwishlist

Description

Based on interactions over Issue https://github.com/vmware/pyvmomi/issues/191 we need to create a sample and a manual page featuring PerformanceManager and specifically address that the value -1 in this context is a special data not found value.

This could be some what surprising to some developers as we've observed. So we want to make this something that's easy to google and answer for.

Contributor guide

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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicspyvmomi libraryvSphere PerformanceManager concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review the issue #191 linked in the description to understand the context of the 1 value for PerformanceManager. Then, create a sample script and a manual page in the pyvmomi documentation (likely in the 'docs' directory) that demonstrates how to use PerformanceManager and clearly explains that 1 indicates data not found. Ensure the documentation is easy to find and includes code examples.