vmware/pyvmomi

[Documentation] Create a manual page for PerformanceManager

Open

#207 创建于 2015年1月30日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (2,141 star) (807 fork)batch import
documentationhelp wantedsample requestwishlist

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python basicspyvmomi libraryvSphere PerformanceManager concept
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.
[Documentation] Create a manual page for PerformanceManager · vmware/pyvmomi#207 | Good First Issue