Skip to content

Propagate changes to api-gateway-api-ref from PreProd environment - #47

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

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

Conversation

@otcbot

@otcbot otcbot Bot commented Oct 15, 2025

Copy link
Copy Markdown
Contributor

This is an automatically created Pull Request for changes to api-gateway-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/api-gateway/pulls/82.

There were patch conflicts, please review original patch file.

@otcbot otcbot Bot added the documentation Improvements or additions to documentation label Oct 15, 2025
@otcbot

otcbot Bot commented Oct 15, 2025

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)
@@ -40,7 +40,6 @@ commands =
   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:dev-guide]commands}
-  {[testenv:json-dev-guide]commands}
   {[testenv:api-ref]commands}
   {[testenv:json-api-ref]commands}
   {[testenv:umn]commands}
@@ -79,26 +78,11 @@ 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
 
-# Json version (for search)
-[testenv:json-dev-guide]
-deps = {[testenv:docs]deps}
-allowlist_externals =
-  cp
-  mkdir
-  sh
-commands =
-  sphinx-build -W --keep-going -b json 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"
-  mkdir -p dev_guide/build/json
-  cp -av doc/build/json/dev-guide dev_guide/build/json
-
 # PDF version
 [testenv:dev-guide-pdf-docs]
 deps = {[testenv:docs]deps}
@@ -109,15 +93,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/apig-dev-guide.pdf doc/build/pdf/
-  cp dev_guide/build/pdf/apig-dev-guide.pdf doc/build/html/
+  cp doc/dev-guide/build/pdf/apig-dev-guide.pdf doc/build/pdf/
+  cp doc/dev-guide/build/pdf/apig-dev-guide.pdf doc/build/html/
 
 # HTML version
 [testenv:api-ref]
@@ -226,7 +210,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)
@@ -10,7 +10,7 @@ API Gateway (APIG) is a high-performance, high-availability, and high-security A
       :service_type: apig
       :umn: This document provides detailed operation guidance of API Gateway service to help you learn and use this ervice.
       :api-ref: This document introduces API reference provided by API Gateway service and describes functions and parameters of each API.
-      :dev: This document describes how to call the APIs of API Gateway service.
+      :dev-guide: This document describes how to call the APIs of API Gateway service.
    
    .. service_card_link::
       :title: Best Practice

@github-actions

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

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