From 8951b1eb57e472a333c3a9f4e869e7ca7acce9ad Mon Sep 17 00:00:00 2001
From: "Hasko, Vladimir" <vladimir.hasko@t-systems.com>
Date: Tue, 24 Oct 2023 22:16:22 +0000
Subject: [PATCH] adding best-practice to sbv

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>
---
 api-ref/source/conf.py |  7 +------
 doc/source/index.rst   |  3 ++-
 tox.ini                | 44 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 47 insertions(+), 7 deletions(-)

diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index a5297e9..3967284 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -109,9 +109,4 @@ html_static_path = ['_static']
 html_copy_source = False
 
 # -- Options for PDF output --------------------------------------------------
-latex_documents = [
-    ('index',
-     'None.tex',
-     u'Document Database Service - API Reference',
-     u'OpenTelekomCloud', 'manual'),
-]
+latex_documents = []
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3b690f2..6b2be58 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -8,6 +8,7 @@ Document Database Service (DDS) is a cloud computing-based NoSQL database featur
 
    .. service_card::
       :service_type: dds
+      :environment: internal
       :umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
       :api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.
-      
\ No newline at end of file
+      :best-practice: To use Document Database Service more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
diff --git a/tox.ini b/tox.ini
index 60da261..903b641 100644
--- a/tox.ini
+++ b/tox.ini
@@ -38,6 +38,8 @@ commands =
   sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
   {[testenv:umn]commands}
   {[testenv:json-umn]commands}
+  {[testenv:best-practice]commands}
+  {[testenv:json-best-practice]commands}
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
 
@@ -52,6 +54,7 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:umn-pdf-docs]commands}
+  {[testenv:best-practice-pdf-docs]commands}
 
 
 # HTML version
@@ -99,6 +102,47 @@ commands =
   cp umn/build/pdf/dds-umn.pdf doc/build/pdf/
 
 
+# HTML version
+[testenv:best-practice]
+deps = {[testenv:docs]deps}
+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 = {[testenv:docs]deps}
+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 = {[testenv:docs]deps}
+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/dds-best-practice.pdf doc/build/pdf/
+
+
 # HTML version
 [testenv:api-ref]
 deps = {[testenv:docs]deps}