As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:
1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.
2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.
Also replace policy.json to policy.yaml ref from doc and tests.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: Ic65d2fd6ce7215b4a47a6fb41b9cbf991f27773b
This patch adds a new tox job/command for building the pdf
version of documentation.
tox -epdf-docs
In addition to adjusting the infra requirement for PDF build
support, the following changes are made to build a PDF doc
- Download link of config_options, sample config and policy
files are disabled for PDF doc as relative links do not
make sense.
- Pre-create the doc/build/pdf/_static directory as a
workaround because sphinx_feature_classification.support_matrix extension
is operating under the assumption that the _static directory already exist
and trying to copy support-matrix.css into it. We need to remove
this workaround once the problem in the support_matrix extension is fixed.
- Use the toctree_only=True workaround to avoid TOC duplicate links.
Change-Id: Ief8df5f6a5a22b8d0530458ac45f344a72cc3e49
Our tools noticed that keystone links to
https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html
which does not exist anymore.
The page was removed but the link to it was not changed. Replace this
and similar links with internal links that will work even if files are
moved - and can be verified, thus sphinx will error in case of broken
targets.
These changes include a few other fixes for broken keystone links, e.g.
to renamed anchors.
For the include files in admin/configuration.rst and
admin/federation/configure_federation.rst: Rename them to *inc.
The files were
published twice (as separate files and on this page) and thus
referencing failed. Renaming avoids this.
Also, put doctree outside of html tree so that it does not get
published.
Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549
This change adjusts the documentation to include a link to the
original raw file for better copy&paste purpose.
DocImpact
Change-Id: I85841a7c1c2242fca9849793908f6eb6cd6c89b1
This patchset removes the lingering code that supported paste.deploy
that is obsolted by the loader wrapped around keystone's use of Flask.
* The keystone-paste.ini file has been removed.
* All options have been removed (without deprecation) as they are no
longer referenced.
* The TokenAuthMiddleware code (with deprecation warning) has been
removed as it was only provided to ensure compatibility with paste.ini
files that were not updated (ensuring not breaking a deployer that
did not update paste.ini file to remove it from the pipeline).
* Paste deploy entrypoints have been removed.
Change-Id: I35064a440ef718f50c7e644e8b2d56a99c3ec74f
The sample files were being rendered in two separate places. This
commit removes one of them and adjusts the references accordingly.
This commit also removes the sample files from the Operator guide
since they have their own dedicated section under configuration/.
Change-Id: I6da0843e2cb9dc7451d97af661a6cb4873eba671
The doc migration spec requires each sub directory
to have an index page which could be directly
referenced in the main openstack documentation under
the topic specific pages, along with other projects.
This patch validates that and adds new files where
they are absent.
Change-Id: I180952857db758482fd767aa9f5cf6343fec9c42
Keystone nows has it's own configuration guide, which means we no
longer need to maintain a separate configuration reference in the
operator guide.
Change-Id: Iadfb90db9f5f23798d57a442e372d35519332a49
The config files included from openstack manuals refer
to policy.json sample configuration file. Currently policy.yaml
is being used as the sample file in keystone.
To avoid any confusion, this commit replaces instances of
policy.json with policy.yaml.
Change-Id: Ib2d4496fa90639b2ed9b72d1f03354a0c0beffd2
There are auto generated configuration and policy guides which
were earlier manually copied and referenced. Used sphinext
module in oslo_config and oslo_policy to automatically render
those pages.
Change-Id: I2b49eb0083661cce70c5b9457fe5bd32dfe5e5e8
Currently some of the config references docs are a part of
general OpenStack-manuals. Migrating those docs to keystone
documentation so that they can be reviewed effectively by
keystone developers too.
Following the specs, the files are added to admin/ and
configuration/ directories.
The files containing congiguration options are added
in a subsequent patch using oslo.config plugin.
Partial-Bug #1694460
Change-Id: I9a85f610e66a10dac54c50b2a54305e979888ee5