openstack/keystone
Code Issues Proposed changes

Remove duplicate sample files

Browse Source 
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
This commit is contained in:
Lance Bragstad 2017-07-28 20:42:07 +00:00
parent d31d063412
commit 9e5a6d6750
6 changed files with 5 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/configuration/config-options.rst
View File

@ -9,7 +9,7 @@ The Identity service is configured in the ``/etc/keystone/keystone.conf`` file.
The following tables provide a comprehensive list of the Identity
service options. For a sample configuration file, refer to
:doc:`/sample_files/sample_config`.
:doc:`samples/keystone-conf`.
.. show-options::
:config-file: config-generator/keystone.conf

4
doc/source/configuration/policy.rst
View File

@ -5,8 +5,8 @@ Policy configuration
Configuration
~~~~~~~~~~~~~
The following is an overview of all available policies in Keystone. For a
sample configuration file, refer to :doc:`/sample_files/sample_policy`.
The following is an overview of all available policies in Keystone. For a sample
configuration file, refer to :doc:`samples/policy-yaml`.
.. show-policy::
:config-file: ../../config-generator/keystone-policy-generator.conf

5
doc/source/index.rst
View File

@ -78,15 +78,14 @@ This section contains the documentation needed for developing keystone.
Operator Documentation
~~~~~~~~~~~~~~~~~~~~~~
This section contains the documentation for operating, deploying and configuring
the keystone service.
This section contains the documentation for deploying and operating the
keystone service.
.. toctree::
:maxdepth: 2
configuration.rst
advanced-topics/index.rst
sample_files/index.rst
User Documentation
~~~~~~~~~~~~~~~~~~

8
doc/source/sample_files/index.rst
View File

@ -1,8 +0,0 @@
Sample Files
============
.. toctree::
:maxdepth: 1
sample_config
sample_policy

12
doc/source/sample_files/sample_config.rst
View File

@ -1,12 +0,0 @@
==============================
Keystone Configuration Options
==============================
The following is a sample keystone configuration for adaptation and use. It is
auto-generated from keystone when this documentation is built, so if you are
having issues with an option, please compare your version of keystone with the
version of this documentation.
The sample configuration can also be viewed in `file form <../_static/keystone.conf.sample>`_.
.. literalinclude:: ../_static/keystone.conf.sample

15
doc/source/sample_files/sample_policy.rst
View File

@ -1,15 +0,0 @@
======================
Keystone Sample Policy
======================
The following is a sample keystone policy file that has been auto-generated
from default policy values in code. If you're using the default policies, then
the maintenance of this file is not necessary, and it should not be copied into
a deployment. Doing so will result in duplicate policy definitions. It is here
to help explain which policy operations protect specific keystone APIs, but it
is not suggested to copy and paste into a deployment unless you're planning on
providing a different policy for an operation that is not the default.
The sample policy file can also be viewed in `file form <../_static/keystone.policy.yaml.sample>`_.
.. literalinclude:: ../_static/keystone.policy.yaml.sample