README.rst is unmaintained and out of date

Bug #1227734 reported by Dolph Mathews on 2013-09-19
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Medium
Dolph Mathews

Bug Description

The README.rst file contains fairly specific architectural descriptions that are very out of date, and generally haven't been maintained since they were originally written. Most, if not all, of the information in the README is actively documented elsewhere and can be safely removed in favor of references to the primary sources of documentation.

The README is generally the starting point for new developers, and as such, should mostly serve as a portal directing them to all of the primary resources available on the project (API docs, client, bug tracking, etc).

Fix proposed to branch: master
Review: https://review.openstack.org/47404

Changed in keystone:
status: New → In Progress

Reviewed: https://review.openstack.org/47404
Committed: http://github.com/openstack/keystone/commit/cddbde13847297ad59bfdcde6e58755af525bb19
Submitter: Jenkins
Branch: master

commit cddbde13847297ad59bfdcde6e58755af525bb19
Author: Dolph Mathews <email address hidden>
Date: Thu Sep 19 10:23:24 2013 -0500

    Rewrite README.rst

    Most of the content in the README is unmaintained and out of date, and
    can be replaced by references to documentation that *is* more properly
    maintained.

    This patch replaces most of the contents of the README with
    low maintenance links.

    Fixes-Bug: 1227734
    Change-Id: I4d63d971f94329197bd7001682d0d655901457f0

Changed in keystone:
status: In Progress → Fix Committed
Thierry Carrez (ttx) on 2013-10-02
Changed in keystone:
milestone: none → havana-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx) on 2013-10-17
Changed in keystone:
milestone: havana-rc1 → 2013.2
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers