Update content

api-ref/source/conf.py

@@ -30,17 +30,6 @@ 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/index.rst

@@ -1,3 +0,0 @@
-==================================================================
-Welcome to the documentation of web-application-firewall-dedicated
-==================================================================

doc/source/conf.py

@@ -31,17 +31,6 @@ 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 = ''
-otcdocs_service_title = ''
-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,8 +8,6 @@ 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.
-      :best-practice: To use Web Application Firewall (Dedicated) more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
+      :api-ref: This document describes application programming interfaces (APIs) of the Web Application Firewall (Dedicated) and provides API parameter description and example values.

tox.ini

@@ -36,8 +36,6 @@ commands =
   sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
-  {[testenv:best-practice]commands}
-  {[testenv:json-best-practice]commands}
   {[testenv:umn]commands}
   {[testenv:json-umn]commands}
 
@@ -52,7 +50,6 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:api-ref-pdf-docs]commands}
-  {[testenv:best-practice-pdf-docs]commands}
   {[testenv:umn-pdf-docs]commands}
 
 
@@ -101,47 +98,6 @@ commands =
   cp api-ref/build/pdf/wafd-api-ref.pdf doc/build/pdf/
 
 
-# HTML version
-[testenv:best-practice]
-deps = -r{toxinidir}/doc/requirements.txt
-allowlist_externals =
-  cp
-  mkdir
-commands =
-  sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice
-
-# Json version (for search)
-[testenv:json-best-practice]
-deps = -r{toxinidir}/doc/requirements.txt
-allowlist_externals =
-  cp
-  mkdir
-  sh
-commands =
-  sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice
-  # Drop data useless for the search - wrap it also with sh/xargs due to bugs
-  # in tox
-  sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
-
-# PDF version
-[testenv:best-practice-pdf-docs]
-deps = -r{toxinidir}/doc/requirements.txt
-allowlist_externals =
-  rm
-  mkdir
-  make
-  bash
-  cp
-commands =
-  rm -rf doc/best-practice/build/pdf
-  sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
-  bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
-  bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C doc/best-practice/build/pdf
-  mkdir -p doc/build/pdf
-  cp doc/best-practice/build/pdf/wafd-best-practice.pdf doc/build/pdf/
-
-
 # HTML version
 [testenv:umn]
 deps = -r{toxinidir}/doc/requirements.txt

umn/source/conf.py

@@ -18,7 +18,7 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme',
+    'otcdocstheme'
 ]
 
 otcdocs_auto_name = False
@@ -30,17 +30,6 @@ 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.