docs: update SwaggerUI version (#12518)

- fixed one merge conflict with the `pull_request_template.md` where the Sustainability Effort mention was not backported to release-3.5 Signed-off-by: Anton Gilgur <[email protected]> Signed-off-by: Anton Gilgur <[email protected]> (cherry picked from commit 2e9c1ca)
argoproj · Oct 27, 2024 · f4470ed · f4470ed
1 parent 4e23c7d
commit f4470ed
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 30 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,4 +1,4 @@
-<!-- markdownlint-disable MD041 -->
+<!-- markdownlint-disable MD041 -- this is rendered within existing HTML, so allow starting without an H1 -->
 
 <!--
 
@@ -30,7 +30,6 @@ Fixes #TODO
 ### Modifications
 
 <!-- TODO: Say what changes you made. -->
-
 <!-- TODO: Attach screenshots if you changed the UI. -->
 
 ### Verification

diff --git a/Makefile b/Makefile
@@ -684,7 +684,7 @@ endif
 .PHONY: docs-spellcheck
 docs-spellcheck: /usr/local/bin/mdspell
 	# check docs for spelling mistakes
-	mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name swagger.md -not -name executor_swagger.md -not -path '*/cli/*')
+	mdspell --ignore-numbers --ignore-acronyms --en-us --no-suggestions --report $(shell find docs -name '*.md' -not -name upgrading.md -not -name README.md -not -name fields.md -not -name upgrading.md -not -name executor_swagger.md -not -path '*/cli/*')
 	# alphabetize spelling file -- ignore first line (comment), then sort the rest case-sensitive and remove duplicates
 	$(shell cat .spelling | awk 'NR<2{ print $0; next } { print $0 | "LC_COLLATE=C sort" }' | uniq | tee .spelling > /dev/null)
 
@@ -697,7 +697,7 @@ endif
 .PHONY: docs-linkcheck
 docs-linkcheck: /usr/local/bin/markdown-link-check
 	# check docs for broken links
-	markdown-link-check -q -c .mlc_config.json $(shell find docs -name '*.md' -not -name fields.md -not -name swagger.md -not -name executor_swagger.md)
+	markdown-link-check -q -c .mlc_config.json $(shell find docs -name '*.md' -not -name fields.md -not -name executor_swagger.md)
 
 /usr/local/bin/markdownlint:
 # update this in Nix when upgrading it here
@@ -709,7 +709,7 @@ endif
 .PHONY: docs-lint
 docs-lint: /usr/local/bin/markdownlint
 	# lint docs
-	markdownlint docs --fix --ignore docs/fields.md --ignore docs/executor_swagger.md --ignore docs/swagger.md --ignore docs/cli --ignore docs/walk-through/the-structure-of-workflow-specs.md
+	markdownlint docs --fix --ignore docs/fields.md --ignore docs/executor_swagger.md --ignore docs/cli --ignore docs/walk-through/the-structure-of-workflow-specs.md
 
 /usr/local/bin/mkdocs:
 # update this in Nix when upgrading it here

diff --git a/docs/swagger.md b/docs/swagger.md
@@ -1,27 +1,14 @@
 # API Reference
 
-<!DOCTYPE html>
-<html lang="en">
- <head>
-  <meta charset="utf-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1" />
-  <meta
-  name="description"
-  content="SwaggerUI"
-  />
-  <title>SwaggerUI</title>
-  <link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
- </head>
- <body>
-  <div id="swagger-ui"></div>
-  <script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
-  <script>
-   window.onload = () => {
-   window.ui = SwaggerUIBundle({
-    url: "https://raw.githubusercontent.com/argoproj/argo-workflows/main/api/openapi-spec/swagger.json",
-    dom_id: "#swagger-ui",
-   });
-   };
-  </script>
- </body>
-</html>
+<!-- markdownlint-disable MD033 -- allow inline HTML -->
+<div id="swagger-ui"></div>
+<link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
+<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
+<script>
+  window.onload = function loadSwaggerUI() {
+    window.ui = SwaggerUIBundle({
+      url: "https://raw.githubusercontent.com/argoproj/argo-workflows/main/api/openapi-spec/swagger.json",
+      dom_id: "#swagger-ui",
+    });
+  };
+</script>