openstackdocstheme/releasenotes/notes/renamed-opts-bbf5d1390ed6ba71.yaml
Stephen Finucane 7ad72dc84a Add package prefixes for all config options
It's bad practice to not prefix config options with a unique identifier
corresponding to the package. Start doing just this using the
'openstackdocs_' prefix.

Change-Id: Ic86998ceaa921f7093ba86f979ea648a1d621d59
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-05-13 14:32:20 +00:00

16 lines
574 B
YAML

---
upgrade:
- |
All configuration options are now prefixed with ``openstackdocs_``. Support
for the previous configuration option names are considered deprecated and
will be removed in a future release.
.. csv-table:: Affected options
:header: "New Name", "Deprecated Name"
``openstackdocs_repo_name``, ``repository_name``
``openstackdocs_use_storyboard``, ``use_storyboard``
``openstackdocs_bug_project``, ``bug_project``
``openstackdocs_bug_tag``, ``bug_tag``
``openstackdocs_project``, ``openstack_project``