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>
Changes to wafd_best-practice from docs/doc-exports#928 (adding best practice do
2023-11-14 13:47:45 +00:00 · 2023-10-23 23:34:34 +00:00 · 2023-08-10 16:24:34 +00:00 · 2023-07-18 08:08:25 +00:00 · 2023-07-17 18:38:45 +00:00 · 2023-06-03 08:14:37 +00:00
10 changed files with 273 additions and 58 deletions
--- a/api-ref/source/conf.py
+++ b/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.
--- a/doc/best-practice/source/_static/.placeholder
+++ b/doc/best-practice/source/_static/.placeholder
--- a/doc/best-practice/source/conf.py
+++ b/doc/best-practice/source/conf.py
--- a/doc/best-practice/source/docutils.conf
+++ b/doc/best-practice/source/docutils.conf
@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top
--- a/doc/best-practice/source/index.rst
+++ b/doc/best-practice/source/index.rst
@ -0,0 +1,4 @@
+==================================================
+Dedicated Web Application Firewall - Best Practice
+==================================================
+
--- a/doc/requirements.txt
+++ b/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
--- a/doc/source/conf.py
+++ b/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.
--- a/doc/source/index.rst
+++ b/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.
--- a/tox.ini
+++ b/tox.ini
--- a/umn/source/conf.py
+++ b/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.
Author	SHA1	Message	Date
Gode, Sebastian	ccad9617d3	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>	2023-11-14 13:47:45 +00:00
proposalbot	bad4eefb1a	Changes to wafd_best-practice from docs/doc-exports#928 (adding best practice do Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2023-10-23 23:34:34 +00:00
Hasko, Vladimir	1bc7ad86dd	fix sphinx problems with constraints Reviewed-by: vladimirhasko <vladimirhasko@gmail.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>	2023-08-10 16:24:34 +00:00
Hasko, Vladimir	03dfa28ad9	adding description for best practice Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>	2023-07-18 08:08:25 +00:00
Hasko, Vladimir	ead72230ce	Update tox.ini && conf.py file Reviewed-by: vladimirhasko <vladimirhasko@gmail.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>	2023-07-17 18:38:45 +00:00
proposalbot	3a15b1ebd8	Changes to wafd_api-ref from docs/doc-exports#769 (chore: use convertor from sep Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2023-06-03 08:14:37 +00:00
proposalbot	d0437f6afb	Changes to wafd_umn from docs/doc-exports#769 (chore: use convertor from separat Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2023-06-03 07:57:40 +00:00
proposalbot	c25c20bac6	Changes to wafd_api-ref from docs/doc-exports#776 (re-introducing changes before Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2023-06-02 12:28:18 +00:00