diff --git a/doc/source/configuration/config-options.rst b/doc/source/configuration/config-options.rst index 8882db30e2..bad8ff1b8f 100644 --- a/doc/source/configuration/config-options.rst +++ b/doc/source/configuration/config-options.rst @@ -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 diff --git a/doc/source/configuration/policy.rst b/doc/source/configuration/policy.rst index 9c4d815a57..cec620f943 100644 --- a/doc/source/configuration/policy.rst +++ b/doc/source/configuration/policy.rst @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 3076a779f0..4560fef811 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 ~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/sample_files/index.rst b/doc/source/sample_files/index.rst deleted file mode 100644 index 6294276007..0000000000 --- a/doc/source/sample_files/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -Sample Files -============ - -.. toctree:: - :maxdepth: 1 - - sample_config - sample_policy \ No newline at end of file diff --git a/doc/source/sample_files/sample_config.rst b/doc/source/sample_files/sample_config.rst deleted file mode 100644 index fe681dacdc..0000000000 --- a/doc/source/sample_files/sample_config.rst +++ /dev/null @@ -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 diff --git a/doc/source/sample_files/sample_policy.rst b/doc/source/sample_files/sample_policy.rst deleted file mode 100644 index 53e63c72ed..0000000000 --- a/doc/source/sample_files/sample_policy.rst +++ /dev/null @@ -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