Propagate changes to bare-metal-server-api-ref from PreProd environment

[otcbot]

This is an automatically created Pull Request for changes to bare-metal-server-api-ref to promote changes down the pipeline to Production environment.

The original change can be found under https://gitea.eco.tsi-dev.otc-service.com/docs/bare-metal-server/pulls/130.

There were patch conflicts, please review original patch file.

[otcbot]

I tried my best, but could not apply the patch as is, therefore I will report you what I could not apply.

BTW, if in the diff you see removed line equal to the added line it may be caused by invisible trailing spaces. This is safe to ignore.

In most cases content of the patch remainder need to be carefully analyzed and necessary changes applied manually.

Following is the patch remainder:

diff a/tox.ini b/tox.ini	(rejected hunks)
@@ -82,7 +82,7 @@ allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html dev_guide/source doc/build/html_temp/dev-guide
+  sphinx-build -W --keep-going -b html doc/dev-guide/source doc/build/html_temp/dev-guide
   sphinx-minify --input-directory doc/build/html_temp/dev-guide --output-directory doc/build/html/dev-guide
   mkdir -p dev_guide/build/html
   cp -av doc/build/html/dev-guide dev_guide/build/html
@@ -95,7 +95,7 @@ allowlist_externals =
   mkdir
   sh
 commands =
-  sphinx-build -W --keep-going -b json dev_guide/source doc/build/json/dev-guide
+  sphinx-build -W --keep-going -b json doc/dev-guide/source doc/build/json/dev-guide
   # 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"
@@ -112,15 +112,15 @@ allowlist_externals =
   bash
   cp
 commands =
-  rm -rf dev_guide/build/pdf
-  cp -r {toxinidir}/_templates dev_guide/source/_templates/
-  sphinx-build -W --keep-going -b latex dev_guide/source dev_guide/build/pdf/
-  bash -c "for f in dev_guide/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
-  bash -c "for f in dev_guide/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C dev_guide/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
+  rm -rf doc/dev-guide/build/pdf
+  cp -r {toxinidir}/_templates doc/dev-guide/source/_templates/
+  sphinx-build -W --keep-going -b latex doc/dev-guide/source doc/dev-guide/build/pdf/
+  bash -c "for f in doc/dev-guide/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
+  bash -c "for f in doc/dev-guide/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
+  make -C doc/dev-guide/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
   mkdir -p doc/build/pdf
-  cp dev_guide/build/pdf/bms-dev-guide.pdf doc/build/pdf/
-  cp dev_guide/build/pdf/bms-dev-guide.pdf doc/build/html/
+  cp doc/dev-guide/build/pdf/bms-dev-guide.pdf doc/build/pdf/
+  cp doc/dev-guide/build/pdf/bms-dev-guide.pdf doc/build/html/
 
 # HTML version
 [testenv:image-creation-guide]
@@ -276,7 +276,7 @@ commands =
     rm -rf {toxinidir}/packages.txt
     wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
     bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
-    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
+    bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then sudo apt update && xargs sudo apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
     bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
 
 [doc8]
diff a/doc/source/index.rst b/doc/source/index.rst	(rejected hunks)
@@ -12,5 +12,5 @@ A Bare Metal Server (BMS) is a physical server dedicated to individual tenants.
       :service_type: bms
       :umn: This document describes basic concepts, functions, key terms, and FAQs of BMSs and provides instructions for applying for and using BMSs.
       :api-ref: This document describes application programming interfaces (APIs) of Bare Metal Server (BMS) and provides API parameters and example values.
-      :dev: This document describes how to call the APIs of Bare Metal Server (BMS) to use the functions of the service. The concepts related to BMS help you quickly learn the service.
+      :dev-guide: This document describes how to call the APIs of Bare Metal Server (BMS) to use the functions of the service. The concepts related to BMS help you quickly learn the service.
       :image-creation-guide: This document describes the private image creation procedure (including creating a VM and installing the OS, software, and drivers on the VM) and uses multiple OSs as examples to provide instructions for you to create a private image.
\ No newline at end of file
diff a/doc/image-creation-guide/source/appendix/mapping_between_bms_specifications_and_drivers.rst b/doc/image-creation-guide/source/appendix/mapping_between_bms_specifications_and_drivers.rst	(rejected hunks)
@@ -16,7 +16,7 @@ Mapping Between BMS Specifications and Drivers
 .. table:: **Table 1** Mapping between BMS specifications and drivers
 
    +-----------+------------------------------+-------------------+------------+-----------------------------------------------+------------------------------+-----------+------------+---------------------------------+--------------------+
-   | BMS       |                              | Driver            |            |                                               |                              |           |            |                                 |                    |
+   | BMS       | _                            | Driver            | _          | _                                             | _                            | _         | _          | _                               | _                  |
    +===========+==============================+===================+============+===============================================+==============================+===========+============+=================================+====================+
    | BMS Type  | OS                           | Server Driver     | SDI Driver | Hi1822 Normal NIC Driver/Management Component | Hi1822 Offloading NIC Driver | IB Driver | GPU Driver | Multipath Software              | bms-network-config |
    +-----------+------------------------------+-------------------+------------+-----------------------------------------------+------------------------------+-----------+------------+---------------------------------+--------------------+

[github-actions]

📦 Preview-Documentation uploaded to Swift: https://swift.eco.tsi-dev.otc-service.com/v1/AUTH_73733c21728443609ee0b47f64b5ce0b/gh_action_logs/bare-metal-server/19375572111/

[github-actions]

📦 Preview-Documentation uploaded to Swift: https://swift.eco.tsi-dev.otc-service.com/v1/AUTH_73733c21728443609ee0b47f64b5ce0b/gh_action_logs/bare-metal-server/19375572106/