[OpenStack-docs] [install-guide] removal of the document change history table

Anne Gentle annegentle at justwriteclick.com
Tue Apr 14 13:25:54 UTC 2015


On Tue, Apr 14, 2015 at 5:27 AM, Andreas Jaeger <aj at suse.com> wrote:

> On 04/14/2015 12:12 PM, Christian Berendt wrote:
>
>> The document change history table
>> (http://docs.openstack.org/juno/install-guide/install/
>> yum/content/ch_preface.html)
>> does not makes sense to me because the change history is incomplete
>> (e.g. no "start documentation for kilo").
>>
>
> We update in general at least once per release. Patches are welcome ;)
>
>
>
>> I would prefer to remove the document change history table and to
>> replace it with a list of links to available specifications (e.g.
>> http://specs.openstack.org/openstack/docs-specs/specs/
>> kilo/installguide-kilo.html).
>>
>
> I suggest to add the basics from the spec to the history to see what was
> actually done - or add what we plan and we revise later ;)


Those document change histories aren't useful, I'd support removal. They're
definitely not coming over when we migrate to RST.

I think the git history is the best place for understanding what changed
when.

Not sure how to integrate a link to the spec though, maybe that is done
with commit messages that point to the blueprint? Sure it's a few clicks
removed, but I think the best traipse through history we should offer.

Anne


>
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
>        Graham Norton, HRB 21284 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150414/f78f8abe/attachment.html>


More information about the OpenStack-docs mailing list