Skip to content

Propagate changes to virtual-private-network-api-ref from PreProd environment - #64

Open
otcbot[bot] wants to merge 1 commit into
mainfrom
propose-api-ref#85
Open

otcbot[bot] wants to merge 1 commit into
mainfrom
propose-api-ref#85

Conversation

@otcbot

@otcbot otcbot Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

This is an automatically created Pull Request for changes to virtual-private-network-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/virtual-private-network/pulls/85.

There were patch conflicts, please review original patch file.

@otcbot otcbot Bot added the documentation Improvements or additions to documentation label Sep 24, 2026
@otcbot

otcbot Bot commented Sep 24, 2026

Copy link
Copy Markdown
Contributor Author

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)
@@ -39,10 +39,10 @@ commands =
   rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
   sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
   sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
-  {[testenv:umn]commands}
-  {[testenv:json-umn]commands}
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
+  {[testenv:umn]commands}
+  {[testenv:json-umn]commands}
 
 
 [testenv:pdf-docs]
@@ -64,40 +64,40 @@ commands =
   wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
   wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
   wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
-  {[testenv:umn-pdf-docs]commands}
   {[testenv:api-ref-pdf-docs]commands}
+  {[testenv:umn-pdf-docs]commands}
 
 
 
 # HTML version
-[testenv:umn]
+[testenv:api-ref]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html umn/source doc/build/html_temp/umn
-  sphinx-minify --input-directory doc/build/html_temp/umn --output-directory doc/build/html/umn
-  mkdir -p umn/build/html
-  cp -av doc/build/html/umn umn/build/html
+  sphinx-build -W --keep-going -b html api-ref/source doc/build/html_temp/api-ref
+  sphinx-minify --input-directory doc/build/html_temp/api-ref --output-directory doc/build/html/api-ref
+  mkdir -p api-ref/build/html
+  cp -av doc/build/html/api-ref api-ref/build/html
 
 # Json version (for search)
-[testenv:json-umn]
+[testenv:json-api-ref]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
   sh
 commands =
-  sphinx-build -W --keep-going -b json umn/source doc/build/json/umn
+  sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref
   # 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"
-  mkdir -p umn/build/json
-  cp -av doc/build/json/umn umn/build/json
+  mkdir -p api-ref/build/json
+  cp -av doc/build/json/api-ref api-ref/build/json
 
 # PDF version
-[testenv:umn-pdf-docs]
+[testenv:api-ref-pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   rm
@@ -106,45 +106,45 @@ allowlist_externals =
   bash
   cp
 commands =
-  rm -rf umn/build/pdf
-  cp -r {toxinidir}/_templates umn/source/_templates/
-  sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/
-  bash -c "for f in umn/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
-  bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C umn/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
+  rm -rf api-ref/build/pdf
+  cp -r {toxinidir}/_templates api-ref/source/_templates/
+  sphinx-build -W --keep-going -b latex api-ref/source api-ref/build/pdf/
+  bash -c "for f in api-ref/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
+  bash -c "for f in api-ref/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
+  make -C api-ref/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
   mkdir -p doc/build/pdf
-  cp umn/build/pdf/vpn-umn.pdf doc/build/pdf/
-  cp umn/build/pdf/vpn-umn.pdf doc/build/html/
+  cp api-ref/build/pdf/vpn-api-ref.pdf doc/build/pdf/
+  cp api-ref/build/pdf/vpn-api-ref.pdf doc/build/html/
 
 # HTML version
-[testenv:api-ref]
+[testenv:umn]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
 commands =
-  sphinx-build -W --keep-going -b html api-ref/source doc/build/html_temp/api-ref
-  sphinx-minify --input-directory doc/build/html_temp/api-ref --output-directory doc/build/html/api-ref
-  mkdir -p api-ref/build/html
-  cp -av doc/build/html/api-ref api-ref/build/html
+  sphinx-build -W --keep-going -b html umn/source doc/build/html_temp/umn
+  sphinx-minify --input-directory doc/build/html_temp/umn --output-directory doc/build/html/umn
+  mkdir -p umn/build/html
+  cp -av doc/build/html/umn umn/build/html
 
 # Json version (for search)
-[testenv:json-api-ref]
+[testenv:json-umn]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   cp
   mkdir
   sh
 commands =
-  sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref
+  sphinx-build -W --keep-going -b json umn/source doc/build/json/umn
   # 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"
-  mkdir -p api-ref/build/json
-  cp -av doc/build/json/api-ref api-ref/build/json
+  mkdir -p umn/build/json
+  cp -av doc/build/json/umn umn/build/json
 
 # PDF version
-[testenv:api-ref-pdf-docs]
+[testenv:umn-pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   rm
@@ -153,15 +153,15 @@ allowlist_externals =
   bash
   cp
 commands =
-  rm -rf api-ref/build/pdf
-  cp -r {toxinidir}/_templates api-ref/source/_templates/
-  sphinx-build -W --keep-going -b latex api-ref/source api-ref/build/pdf/
-  bash -c "for f in api-ref/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
-  bash -c "for f in api-ref/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C api-ref/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
+  rm -rf umn/build/pdf
+  cp -r {toxinidir}/_templates umn/source/_templates/
+  sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/
+  bash -c "for f in umn/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
+  bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
+  make -C umn/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
   mkdir -p doc/build/pdf
-  cp api-ref/build/pdf/vpn-api-ref.pdf doc/build/pdf/
-  cp api-ref/build/pdf/vpn-api-ref.pdf doc/build/html/
+  cp umn/build/pdf/vpn-umn.pdf doc/build/pdf/
+  cp umn/build/pdf/vpn-umn.pdf doc/build/html/
 
 
 [testenv:bindeps]
@@ -176,7 +176,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/zuul.yaml b/zuul.yaml	(rejected hunks)
@@ -6,8 +6,8 @@
       - helpcenter-base-jobs
     vars:
       sphinx_pdf_files:
-        - vpn-umn.pdf
         - vpn-api-ref.pdf
+        - vpn-umn.pdf
     check:
       jobs:
         - noop

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant