search

futuregrid / cloud-metrics

Project to create usage statistics from IaaS such as OpenStack, Eucalyptus, and Nimbus
2 stars 3 forks source link

man page for installation and command usage #16

Closed lee212 closed 11 years ago

lee212 commented 12 years ago

Simple guide for installation and usage of command tools would be written in Readme.md file. More specifically it should satisfy following items: 1) how to download futuregrid-cloud-metrics from pypi 2) how to install by reading readme.md file 3) notify installer privilege should be root 4) how to configure with Eucalyptus and mysql database 5) how to run command line tools

laszewsk commented 12 years ago

I helped a bit in the cleanup.

On Wed, Apr 4, 2012 at 1:43 AM, lee212 < reply@reply.github.com

wrote:

Simple guide for installation and usage of command tools would be written in Readme.md file. More specifically it should satisfy following items: 1) how to download futuregrid-cloud-metrics from pypi 2) how to install by reading readme.md file 3) notify installer privilege should be root 4) how to configure with Eucalyptus and mysql database 5) how to run command line tools

Reply to this email directly or view it on GitHub: https://github.com/futuregrid/futuregrid-cloud-metrics/issues/16

lee212 commented 12 years ago

Probably, like euca2ools, linux man page would be helpful as a manual page for commands such as fg-metric, fg-analyze, etc. I need to figure out how to automatically generate man page for python commands. There must be some tools e.g. pydoc or something else. However, this is optional. Writing manuals is first task.

laszewsk commented 12 years ago

Why not just say

fg-analyze --help

print out elementary help via argparse, but also include

more details about this command can be found at

http://github.../man/fg-analyze.md

or start

wget http://github.../man/fg-analyze.md

and display the contents ;-)

keep complex manual pages in .md format and not in the code.

On Thu, Apr 5, 2012 at 12:04 PM, lee212 < reply@reply.github.com

wrote:

Probably, like euca2ools, linux man page would be helpful as a manual page for commands such as fg-metric, fg-analyze, etc. I need to figure out how to automatically generate man page for python commands. There must be some tools e.g. pydoc or something else. However, this is optional. Writing manuals is first task.

Reply to this email directly or view it on GitHub:

https://github.com/futuregrid/futuregrid-cloud-metrics/issues/16#issuecomment-4979667

lee212 commented 12 years ago

Just in case, I leave a comment here with links.

references:

lee212 commented 11 years ago

We provide a user guide and an instruction for the installation and the command tools. Currently, the pages are stored at github: http://futuregrid.github.com/cloud-metrics/