yahoo-eng-team team mailing list archive

[Julie Pichon <1300710@xxxxxxxxxxxxxxxxxx>]

Public bug reported:

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).

** Affects: horizon
     Importance: Medium
         Status: New


** Tags: documentation

** Description changed:

  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.
+ 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).

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Dashboard (Horizon).
https://bugs.launchpad.net/bugs/1300710

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

Status in OpenStack Dashboard (Horizon):
  New

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).

To manage notifications about this bug go to:
https://bugs.launchpad.net/horizon/+bug/1300710/+subscriptions