Improve settings doc: add "added in <release>" information

Bug #1300710 reported by Julie Pichon
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Medium
Gary W. Smith

Bug Description

We direct users to http://docs.openstack.org/developer/horizon/topics/settings.html when they have a question about settings. They also find the page when searching for help. However it's not clear at all what release a setting is available for, especially when it's added to a version that hasn't been released yet.

I think we should add information like "added in Grizzly" or "new in 2014.1 (Icehouse)", similar to what the Django or Python docs do. It is really useful.

https://docs.python.org/2.7/library/unittest.html#unittest.TestCase.setUpClass
https://docs.djangoproject.com/en/1.6/ref/settings/#csrf-cookie-httponly

See related bug 1221115, which is about adding missing settings (but we don't need to wait for it to be resolved to start fixing this one).

Julie Pichon (jpichon)
description: updated
Changed in horizon:
status: New → Triaged
Changed in horizon:
assignee: nobody → Gary W. Smith (gary-w-smith)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

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

Changed in horizon:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/92877
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=83daca331a2198f5a2f25e2841e85c01d5caf08a
Submitter: Jenkins
Branch: master

commit 83daca331a2198f5a2f25e2841e85c01d5caf08a
Author: Gary W. Smith <email address hidden>
Date: Wed May 7 15:52:53 2014 -0700

    Add "new in" tags to docs for new Icehouse settings

    Also re-alphabetize settings list

    Change-Id: Ieb47e9f2a0be4906a744970a9d17dd5177e59fc0
    Partial-Bug: #1300710

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/93479
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=90a96dd057f18603a495410e9178e1417d8ff087
Submitter: Jenkins
Branch: master

commit 90a96dd057f18603a495410e9178e1417d8ff087
Author: Gary W. Smith <email address hidden>
Date: Mon May 12 16:08:05 2014 -0700

    Add "new in" tags for pre-Icehouse settings

    Change-Id: I7e1a3f5f20075638f14ddfb59456253e15704fdf
    Partial-Bug: #1300710

Revision history for this message
Gary W. Smith (gary-w-smith) wrote :

This bug should have a status of Fix Commited, since the last change really should have said Closes-Bug instead of Partial-Bug.

Changed in horizon:
status: In Progress → Fix Committed
Changed in horizon:
milestone: none → juno-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in horizon:
milestone: juno-2 → 2014.2
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.