During the recent work on release notes I got some useful lessons on reno.
It is worth documented. (Note that they will be added to the reno docs
but it is nice to have it in horizon doc too)
Also adds a link to the release note section in the contributor guide
to the release note page so that developers can find information on
the release notes more easily.
Change-Id: I0c5bd5f5e70d6c1be4eb8f8e895312205177774e
This commit updates links affected by doc migration.
Note that other links are not touched in this commit.
Fixing other broken links or changing http to https
should be covered by a separate patch.
Also convert http links to docs.openstack.org to https per reviewer
request (though it is not directly related to doc-migration).
Note that this commit does not touch files under releasenotes/notes/.
If we touch release notes in older releases, reno will considers
it as a release note in the current release.
(Pike release notes are clean up in a separate patch.)
Change-Id: Iba9bd465ef08014a4972584cf4da6e7d77961119
Currently themes machinery works in such way that if we rely on
default theme in our branded theme, we have to include them both into
AVAILABLE_THEMES setting, otherwise default theme assets will be
unavailable and the branded theme assets compilation will fail. On
the other hand, mentioning them both leads to theme picker being
shown - which we would like to avoid (per marketing wish).
SELECTABLE_THEMES setting was added to allow limiting the user facing
themes by configuration.
Closes-bug: #1564543
Co-Authored-By: Ivan Kolodyazhny <e0ne@e0ne.info>
Change-Id: Ic00a9201d2d352685b1089a37a25987b75d6636d
* This patch adds support for the virtio-forwarder VNIC type.
* The virtio-forwarder VNIC type has been added as another option for
setting the "binding:vnic_type" property on a port. This requests a
low-latency virtio port inside the instance, likely backed by hardware
acceleration.
* The documentation for OPENSTACK_NEUTRON_NETWORK/supported_vnic_types
has been updated to clarify the term "supported VNIC types".
Unfortunately, the VNIC binding happens at scheduling and error
reporting in core Nova and Neutron is not optimal in this case.
* Corresponding python-openstackclient change:
https://review.openstack.org/#/c/483532/
* Corresponding neutron-lib change:
https://review.openstack.org/#/c/483530/
Signed-off-by: Jan Gutter <jan.gutter@netronome.com>
Closes-Bug: 1705548
Depends-On: I28315fb12f62dc7d52d099c211086b2b81eca39a
Change-Id: I02dc3581de8f31c659e545e340cbdf6a1b2bb837
The main purpose of prelude is to describe release highlights.
The current usage of prelude looks random and there is no need for
individual release notes to use prelude section.
This commit cleans them up.
Also add a note on this to the contributor guide.
Change-Id: Ib72a3f4fc1bac2befd900249d07f5d67a56079f3
DEFAULT_SERVICE_REGIONS was recently added and documented in Django
OpenStack Auth. In preparation for adding DOA to Horizon, lets add this
to the Horizon doc.
Change-Id: Ic8a6c45eeec555cdb16068630ae693199e40d6f5
doc8 is a linter for documents and used in openstack-manuals.
It is better to enforce document linters for simple checking.
The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
Change-Id: I3810df521068ffc97e25a5fc56b72397bf9783bc
This commit is primarily a reorganisation fo our settings documentation.
The aim is to move away from the horizon / openstack_dashboard / django
distinction, which makes little sense to non-devs. This will be replaced
by a split between general horizon settings, service-specific settings,
and upstream Django settings. as well as organising the settings in
each section alphabetically. The aim is to promote discoverability of
settings for operators.
This patch also improves visiblity of deprecation, adds missing
tags (versionadded, seealso, deprecated, versionchanged), and
updates content where necessary. Some missing settings were added,
and many settings were also updated to reference other relevant
settings.
Change-Id: Idd496af7d4fe7d242772bb402d22c54c18f05d51
Implements: blueprint pike-docs-overhaul
At now, most django_openstack_auth (DOA) settings are documented
in the horizon documentation. It is better to have documentation
in a same place for better maintenance.
This commit drops openstack_auth specific settings from
the horizon configuration guide.
Also update the wrong name of openstack_auth setting in
local_settings.py. The correct name is TOKEN_DELETION_DISABLED.
Change-Id: Ia5518278c1bc70bb1b3faf44917094de56f344af
On clouds that use domain-specific Identity configuration[1], a user
must provide both their username and domain in order to log into
horizon. Without this patch, users must be aware of their domain's name
and enter it into a text box at login. This is sensible on public
clouds, because supplying potential domains to an unauthenticated user
exposes too much information about other customers and makes potential
attacks easier. On private clouds, however, it is a hinderance to
usability. For example, when migrating from a single-domain
configuration to a multi-domain configuration, users must now guess or
be informed of their domain in order to enter it in the text box. As
another example, when keystone domains are mapped to Active Directory
domains, the user may not be used to having to know their AD domains and
would prefer to select a likely one based on their geographical location
or department from a dropdown menu.
This patch adds the config file examples and documentation for new
config options, "OPENSTACK_KEYSTONE_DOMAIN_DROPDOWN" for enabling a
dropdown menu instead of a textbox when MULTIDOMAIN_SUPPORT is enabled,
and "OPENSTACK_KEYSTONE_DOMAIN_CHOICES" for providing domains to choose
from. The behavior changes corresponding to these new options are
implemented in django_openstack_auth in a corresponding patch.
[1] https://docs.openstack.org/developer/keystone/configuration.html#domain-specific-drivers
Change-Id: I71d64182524d1f54745d9e42347b3a605fa2a920
Depends-On: Ie0a7e36b9975342fab81ddebb87880608d3ef187
In reviews we usually check import grouping but it is boring.
By using flake8-import-order plugin, we can avoid this.
This flake8 plugin is already used in tempest.
It enforces loose checking so it sounds good to use.
Note that flake8-import-order version is pinned to avoid unexpected
breakage of pep8 job.
Change-Id: I8ccd05eb70350a2441cc2a4d1eafc09ee690b83b
The table of horizon plugin registry does not need complex formatting.
list-table allows us to edit it easily compared to the grid table.
Change-Id: Ic1e49de42947c9b8252af17a8df24d1fc47f6b38
The new standard document structure suggests to have a dedicated dir
named configuration/. It will be linked from docs.o.o directly,
so it would be better to follow the guideline.
This commit moves the pages on settings and customization to
a new directory configuration/.
It also splits the pages into meaningful pieces.
Change-Id: I65a3b0b688c8abc176662f86a0dbbfa3b64c4101
* Clean up unnecessary vertical quotes at the left side
caused by extra spaces at the beginning of lines.
* Do not use backquotes in the title lines
(ref/run_tests.rst, ref/horizon.rst)
When backquotes are used in the first-level title,
it will be included in the navigation at the top-right corner
https://docs.openstack.org/developer/horizon/contributor/ref/index.html
* Remove duplicated contents:: directive in ref/run_tests.sh.
openstackdocstheme generates the toc by default, so having contents::
directive leads to duplicated toc in a page.
Change-Id: Icc641927ad7cd7a8d79632c64a3ce212f0dc0b64
Set some of the new config values and enable openstackdocstheme as an
extension so it will inject values into the page context as it writes
each documentation page. This ensures the pages link to the right bug
tracker, etc.
Change-Id: I36d400358b1b5e2c2423c43f43c775bafb0d4721
Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Request URLs can be put in ignored_urls in OPERATION_LOG_OPTIONS
in order to ignore them from auditing.
Change-Id: I6673e765fd88bc4230a3b7ced2ee227669136bb2
Closes-Bug: #1688206
These two documents were incredibly outdated, but also had almost
identical concerns. This patch updates the content and merges the two
documents.
Note that this guide is still separate to the quickstart guide, which is
intended for developers. In future patches in this blueprint, the file &
navigation structure will be altered to make this distinction more
clear.
Change-Id: Ic5d111d53ab69a3cd1ab08c4c05b2d676e79258c
Implements: blueprint pike-docs-overhaul
After switching openstackdocstheme, TOC in the left sidebar becomes long.
This is because openstackdocstheme treats the first level of 'doctree'
in the top page (index.rst). In Horizon documentation, many documents
are listed as the first level, so the sidebar is long.
This commit adds index.rst per topic and merges all toctree
under the developer docs into a single toctree.
This will lead to the well-organized toc tree in the sidebar.
(Note that this does not touch "Using Horizon" part as it is being
refactored in https://review.openstack.org/#/c/473932/.)
The title level of "Packaging Horizon" in topics/packaging.rst is
changed to the second level because openstackdocthemes assume
only one first-level title per file and the second first-level title
or later are not displayed in a rendered page.
Implements: blueprint pike-docs-overhaul
Change-Id: I16e2bae18d8f67716c9838094a39527cd8bf733e
The CLI propmpt symbol in the updated doc was changed to #, which
implies root. Lets not encourage people to run a bunch of things as
root. This patch reverts it to $
Change-Id: Iac7343e676cc58b79e7328cdbad1652f98da0ecf
Implements: blueprint pike-docs-overhaul
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Changing Popen to .check_output because of 3 reasons:
1. check_output() will raise CalledProcessError if
the called process returns a non-zero return code.
2. For consistency with keystone [1] and cinder [2]
3. It makes the code look much better.
[1] https://review.openstack.org/#/c/457142/
[2] https://review.openstack.org/#/c/433081
Change-Id: Ia6721b3b2bdf8427e8c42b4f056f5fcb7c4b73ee
Update the example local.conf with a couple of useful options, and
remove plugins that are no longer part of the Horizon tree.
Change-Id: I5a4de7041fdf821b480d1fe34cf9423441390d91
Implements: blueprint pike-docs-overhaul
This patch is the first in a series improving Horizons documentation. It
aims to make the initial quick start section clearer, updates the
information to remove some redundant information, and updates the
appearance to match the rest of the openstack docs.
Change-Id: I942e62b6c2c272dc2b5c91bca42c77677bb4e09d
Implements: blueprint pike-docs-overhaul
This patch adds the ability to configure the default "create volume"
value when launching an instance with Cinder enabled.
Co-Authored-By: Rob Cresswell <robert.cresswell@outlook.com>
Closes-Bug: 1678109
Change-Id: I272f7f1b20cc1276976c464a82d1776de92d17e7
There is no need to catch warnings from openstack_dashboard.settings
in the doc build job. This might be a bug of a recent Sphinx 1.6.x,
but I think it is useful to have this setting to avoid unexpected failures.
Change-Id: I9894622ba0f5fbb74e9dac016ed76ac9e3c2f733
This change extends the description of OPENSTACK_HOST, now including
references to other settings that explain how to setup multiple region in
Horizon.
Change-Id: Id079cae5767159ff8d2ff8b854ab218db1fbdd79
The enabled files for the Developer dashboard and Theme Preview
panel have been moved to contrib.
Added the step for copying enabled files to the local folder.
Change-Id: I3182aafd86e1ed1ba610d4b11bed81f8a65eb0e3
Closes-bug: #1691291
