The documentation is outdated

Bug #1902703 reported by Andrey Kurilin
38
This bug affects 8 people
Affects Status Importance Assigned to Milestone
Rally
In Progress
Critical
Unassigned

Bug Description

The purpose of this bug report to group track different outdated items related to documentation.

The list of known issues:

1. rally.readthedocs.io includes documentation for both rally framework and rally-openstack that requires to add a lot of notes that specific package should be installed

2. installation page includes reference to install_rally.sh script that was deprecated and removed long time ago. (solution for those who bumped into the issue: use `pip install rally` or `pip install rally-openstack`)

3. installation page and hub.docker.com include duplicated info about docker

4. There is no reference to Task input format v2 at all.

5. All examples of how to develop plugins are openstack related and use wrong imports (after splitting openstack plugins into the separate framework)

6. Changelog is not included into documentation

Changed in rally:
status: New → Triaged
importance: Undecided → Critical
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to rally (master)

Reviewed: https://review.opendev.org/c/openstack/rally/+/796615
Committed: https://opendev.org/openstack/rally/commit/9279809311050c832ce18825b07d745875aff31a
Submitter: "Zuul (22348)"
Branch: master

commit 9279809311050c832ce18825b07d745875aff31a
Author: Andrey Kurilin <email address hidden>
Date: Wed Jun 16 12:41:34 2021 +0300

    Update installation guide

    Partial-Bug: #1902703
    Change-Id: I1c8501dd9bb46284b8aaedababe06cf379367e0d

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

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