Update tox.ini && conf.py file

Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>

api-ref/source/conf.py

@@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = 'internal'
+otcdocs_doc_link = '/web-application-firewall-dedicated/api-ref/'
+otcdocs_doc_title = 'API Reference'
+otcdocs_doc_type = 'api-ref'
+otcdocs_service_category = 'security-services'
+otcdocs_service_title = 'Dedicated Web Application Firewall'
+otcdocs_service_type = 'wafd'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

doc/best-practice/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

doc/best-practice/source/index.rst

@@ -0,0 +1,4 @@
+==================================================
+Dedicated Web Application Firewall - Best Practice
+==================================================
+

doc/requirements.txt

@@ -1,7 +1,10 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
+
 otcdocstheme # Apache-2.0
+
 # releasenotes
 reno>=3.1.0 # Apache-2.0
 
 otc-sphinx-directives>=0.1.0
+sphinx-minify>=0.0.1 # Apache-2.0
 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

doc/source/conf.py

@@ -31,6 +31,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = ''
+otcdocs_doc_link = ''
+otcdocs_doc_title = ''
+otcdocs_doc_type = ''
+otcdocs_service_category = 'security-services'
+otcdocs_service_title = 'Dedicated Web Application Firewall'
+otcdocs_service_type = 'wafd'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

doc/source/index.rst

@@ -8,6 +8,8 @@ Web Application Firewall (WAF) keeps web services stable and secure. It examines
    :class: container-sbv
 
    .. service_card::
+      :environment: internal
       :service_type: wafd
       :umn: This document helps you know about the Web Application Firewall (Dedicated) and guide you on how to use the service.
-      :api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values.
+      :api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values.
+      :best-practice: To use Web Application Firewall (Dedicated) more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

umn/source/conf.py

@@ -18,7 +18,7 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]
 
 otcdocs_auto_name = False
@@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/web-application-firewall-dedicated'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = 'internal'
+otcdocs_doc_link = '/web-application-firewall-dedicated/umn/'
+otcdocs_doc_title = 'User Guide'
+otcdocs_doc_type = 'umn'
+otcdocs_service_category = 'security-services'
+otcdocs_service_title = 'Dedicated Web Application Firewall'
+otcdocs_service_type = 'wafd'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.