Add index page for plugins documents

Now we have more documents for plugins on stable release,
support and their testing policy. Let's prepare a
index page for it will be easy for plugins maintainer.

Also renaming the stable support policy section to have a clear
name.

Adding redirect links for moved documents.

Change-Id: I17a9a6e0e88605a0ee5047678d6ed168c31396ec
This commit is contained in:
Ghanshyam Mann 2020-05-04 20:52:01 -05:00
parent 96800bb833
commit da3bb61f1f
7 changed files with 56 additions and 14 deletions

2
.gitignore vendored
View File

@ -31,7 +31,7 @@ build
!.coveragerc !.coveragerc
cover/ cover/
doc/source/_static/tempest.conf.sample doc/source/_static/tempest.conf.sample
doc/source/plugin-registry.rst doc/source/plugins/plugin-registry.rst
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build

View File

@ -59,7 +59,7 @@ projects not included above should go into one of the
`relevant plugin projects`_. `relevant plugin projects`_.
.. _External Plugin Interface: https://specs.openstack.org/openstack/qa-specs/specs/tempest/implemented/tempest-external-plugin-interface.html .. _External Plugin Interface: https://specs.openstack.org/openstack/qa-specs/specs/tempest/implemented/tempest-external-plugin-interface.html
.. _relevant plugin projects: https://docs.openstack.org/tempest/latest/plugin-registry.html#detected-plugins .. _relevant plugin projects: https://docs.openstack.org/tempest/latest/plugins/plugin-registry.html#detected-plugins
Exception Handling Exception Handling
------------------ ------------------

View File

@ -1 +1,4 @@
redirectmatch 301 ^/developer/tempest/(.*) /tempest/latest/$1 redirectmatch 301 ^/developer/tempest/(.*) /tempest/latest/$1
redirectmatch 301 ^/tempest/latest/plugin.html /tempest/latest/plugins/plugin.html
redirectmatch 301 ^/tempest/latest/plugin-registry.html /tempest/latest/plugins/plugin-registry
redirectmatch 301 ^/tempest/latest/support-policy /tempest/latest/stable-branch-support-policy

View File

@ -87,8 +87,7 @@ Plugins
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
plugin plugins/index
plugin-registry
Tempest & Plugins Compatible Version Policy Tempest & Plugins Compatible Version Policy
------------------------------------------- -------------------------------------------
@ -98,6 +97,14 @@ Tempest & Plugins Compatible Version Policy
tempest_and_plugins_compatible_version_policy tempest_and_plugins_compatible_version_policy
Stable Branch Support Policy
----------------------------
.. toctree::
:maxdepth: 2
stable_branch_support_policy
Stable Branch Testing Policy Stable Branch Testing Policy
---------------------------- ----------------------------
@ -114,14 +121,6 @@ Library
library library
Support Policy
--------------
.. toctree::
:maxdepth: 2
stable_branch_support_policy
Search Search
====== ======

View File

@ -0,0 +1,40 @@
=====================
Tempest Plugins Guide
=====================
.. toctree::
:maxdepth: 2
plugin
Stable Branch Support Policy
----------------------------
.. toctree::
:maxdepth: 2
../stable_branch_support_policy
Stable Branch Testing Policy
----------------------------
.. toctree::
:maxdepth: 2
../stable_branch_testing_policy
Tempest & Plugins Compatible Version Policy
-------------------------------------------
.. toctree::
:maxdepth: 2
../tempest_and_plugins_compatible_version_policy
Plugins Registry
----------------
.. toctree::
:maxdepth: 2
plugin-registry

View File

@ -98,8 +98,8 @@ printf "\n\n"
if [[ -r doc/source/data/tempest-plugins-registry.footer ]]; then if [[ -r doc/source/data/tempest-plugins-registry.footer ]]; then
cat doc/source/data/tempest-plugins-registry.footer cat doc/source/data/tempest-plugins-registry.footer
fi fi
) > doc/source/plugin-registry.rst ) > doc/source/plugins/plugin-registry.rst
if [[ -n ${1} ]]; then if [[ -n ${1} ]]; then
cp doc/source/plugin-registry.rst ${1}/doc/source/plugin-registry.rst cp doc/source/plugins/plugin-registry.rst ${1}/doc/source/plugins/plugin-registry.rst
fi fi