Missing getting started documentation

Bug #1569139 reported by Gerard Braad
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
steth
Fix Released
Undecided
Han Chao

Bug Description

The project currently has no complete instructions on how to setup the tool in a single- and/or multi-node environment. It would be ideal if a short summary of installation and usage can be given.

Please see: https://github.com/openstack/steth/blob/master/doc/source/index.rst
It is preferred to specify instructions using backticks and code blocks.

The README would need to refer to this document. Or the README should mention a basic usage; Install using `python setup.py`.

Gerard Braad (gbraad)
description: updated
Han Chao (hanchao-v)
Changed in steth:
status: New → Confirmed
assignee: nobody → Han Chao (hanchao-v)
Revision history for this message
Gerard Braad (gbraad) wrote :

We decide to use rst for documentation instead of md. Since there is limited documentation this is an easy change.

Han Chao (hanchao-v)
Changed in steth:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to steth (master)

Reviewed: https://review.openstack.org/305062
Committed: https://git.openstack.org/cgit/openstack/steth/commit/?id=dba214e25100af9c93633ff4b7e476e7c124bc3c
Submitter: Jenkins
Branch: master

commit dba214e25100af9c93633ff4b7e476e7c124bc3c
Author: hanchao <email address hidden>
Date: Wed Apr 13 17:02:39 2016 +0800

    Restructure the docs for steth

    Reformat the README.md into README.rst. Reschedule the
    directory of the docs. Add code blocks to emphasize the
    commands in the quickstart.rst. Seperate the multi-node-
    architecture section out of the README.rst, and put it
    in the multi-node-architecture.rst.

    Note: The multi-node-architecture.rst is not indicated in
    the README.rst.

    Change-Id: I05407cf75e4f140158c690d96a9ded5f39cf6bc8
    Closes-Bug: #1569139

Changed in steth:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.