Uyuni 2025.05 API update

Makefile

@@ -5,8 +5,8 @@ SHELL = bash
 
 
 # SUMA Productname and file replacement
-PRODUCTNAME_SUMA ?= 'SUSE Manager'
-FILENAME_SUMA ?= suse_manager
+PRODUCTNAME_SUMA ?= 'SUSE Multi-Linux Manager'
+FILENAME_SUMA ?= suse_multi_linux_manager
 SUMA_CONTENT ?= true
 
 # UYUNI Productname and file replacement
@@ -25,7 +25,7 @@ PDF_THEME_DIR ?= branding/pdf/themes
 # suse-draft
 # suse
 
-PDF_THEME_SUMA ?= suse-draft
+PDF_THEME_SUMA ?= suse
 
 
 # UYUNI PDF Themes
@@ -79,8 +79,8 @@ endef
 define pdf-book-create
 	asciidoctor-pdf \
 		-r ./extensions/xref-converter.rb \
-		-a pdf-stylesdir=$(PDF_THEME_DIR)/ \
-		-a pdf-style=$(1) \
+		-a pdf-themesdir=$(PDF_THEME_DIR)/ \
+		-a pdf-theme=$(1) \
 		-a pdf-fontsdir=$(PDF_FONTS_DIR) \
 		-a productname=$(2) \
 		-a suma-content=$(3) \
@@ -107,56 +107,8 @@ define pdf-book-create-index
 endef
 
 
-## Generate PDF version of the Installation Guide
-define pdf-install-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),installation)
-endef
-
-
-## Generate PDF version of the Client Configuration Guide
-define pdf-client-configuration-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),client-configuration)
-
-endef
-
-
-define pdf-upgrade-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),upgrade)
-
-endef
-
-
-define pdf-reference-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),reference)
-
-endef
-
-
-define pdf-administration-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),administration)
-
-endef
-
-
-define pdf-salt-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),salt)
-
-endef
-
-
-define pdf-retail-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),retail)
-
-endef
-
-
-define pdf-architecture-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),architecture)
-endef
-
-
-define pdf-quickstart-public-cloud-product
-	$(call pdf-book-create,$(1),$(2),$(3),$(4),quickstart-public-cloud)
+define pdf-api-product
+	$(call pdf-book-create,$(1),$(2),$(3),$(4),api)
 endef
 
 # Help Menu
@@ -185,22 +137,13 @@ clean: ## Remove build artifacts from output directory (Antora and PDF)
 	-rm -rf build/ \
 		.cache/ \
 		public/ \
-		modules/installation/nav-installation-guide.pdf.adoc \
-		modules/client-configuration/nav-client-configuration-guide.pdf.adoc \
-		modules/upgrade/nav-upgrade-guide.pdf.adoc \
-		modules/reference/nav-reference-guide.pdf.adoc \
-		modules/administration/nav-administration-guide.pdf.adoc \
-		modules/salt/nav-salt-guide.pdf.adoc \
-		modules/retail/nav-retail-guide.pdf.adoc \
-		modules/architecture/nav-architecture-guide.pdf.adoc \
-		modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-
+		modules/api/nav-api-guide.pdf.adoc
 
 # SUMA DOCUMENTATION BUILD COMMANDS
 
 .PHONY: validate-suma
 validate-suma: ## Validates page references and prints a report (Does not build the site)
-	$(call validate-product,suma-site.yml)
+	$(call validate-product,suma-api-site.yml)
 
 
 
@@ -212,147 +155,50 @@ pdf-tar-suma: ## Create tar of PDF files
 
 # To build for suma-webui or uyuni you need to comment out the correct name/title in the antora.yml file. (TODO remove this manual method.)
 .PHONY: antora-suma
-antora-suma: clean pdf-all-suma pdf-tar-suma ## Build the SUMA Antora static site (See README for more information)
-		sed -i "s/^ # *\(name: *suse-manager\)/\1/;\
-	s/^ # *\(title: *SUSE Manager\)/\1/;\
+antora-suma: clean pdf-all-suma ## Build the SUMA Antora static site (See README for more information)
+		sed -i "s/^ # *\(name: *docs\)/\1/;\
+	s/^ # *\(title: *SUSE Multi-Linux Manager\)/\1/;\
 	s/^ *\(title: *Uyuni\)/#\1/;\
 	s/^ *\(name: *uyuni\)/#\1/;" antora.yml
-	DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr antora suma-site.yml --generator antora-site-generator-lunr
+	DOCSEARCH_ENABLED=true SITE_SEARCH_PROVIDER=lunr npx antora --extension @antora/lunr-extension suma-api-site.yml
 
 
 
 # SUMA
 .PHONY: obs-packages-suma
-obs-packages-suma: clean pdf-all-suma antora-suma ## Generate SUMA OBS tar files
+obs-packages-suma: clean antora-suma #pdf-all-suma ## Generate SUMA OBS tar files
 	$(call obs-packages-product,$(HTML_OUTPUT_SUMA),$(PDF_OUTPUT_SUMA))
 
-
-# Generate PDF versions of all SUMA books
 .PHONY: pdf-all-suma
-pdf-all-suma: pdf-install-suma pdf-client-configuration-suma pdf-upgrade-suma pdf-reference-suma pdf-administration-suma pdf-salt-suma pdf-retail-suma pdf-quickstart-public-cloud-suma ##pdf-architecture-suma-webui
-
-
-.PHONY: modules/installation/nav-installation-guide.pdf.adoc
-modules/installation/nav-installation-guide.pdf.adoc:
-	$(call pdf-book-create-index,installation)
-
-## Generate PDF version of the SUMA Installation Guide
-.PHONY: pdf-install-suma
-pdf-install-suma: modules/installation/nav-installation-guide.pdf.adoc
-	$(call pdf-install-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-
-.PHONY: modules/client-configuration/nav-client-configuration-guide.pdf.adoc
-modules/client-configuration/nav-client-configuration-guide.pdf.adoc:
-	$(call pdf-book-create-index,client-configuration)
-
-## Generate PDF version of the SUMA Client Configuration Guide
-.PHONY: pdf-client-configuration-suma
-pdf-client-configuration-suma: modules/client-configuration/nav-client-configuration-guide.pdf.adoc
-	$(call pdf-client-configuration-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
+pdf-all-suma: pdf-api-suma ## Generate PDF version of the UYUNI API Documentation
 
+.PHONY: modules/api/nav-api-guide.pdf.adoc
+modules/api/nav-api-guide.pdf.adoc:
+	$(call pdf-book-create-index,api)
 
-.PHONY: modules/upgrade/nav-upgrade-guide.pdf.adoc
-modules/upgrade/nav-upgrade-guide.pdf.adoc:
-	$(call pdf-book-create-index,upgrade)
-
-## Generate PDF version of the SUMA Upgrade Guide
-.PHONY: pdf-upgrade-suma
-pdf-upgrade-suma: modules/upgrade/nav-upgrade-guide.pdf.adoc
-	$(call pdf-upgrade-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-
-
-.PHONY: modules/reference/nav-reference-guide.pdf.adoc
-modules/reference/nav-reference-guide.pdf.adoc:
-	$(call pdf-book-create-index,reference)
-
-## Generate PDF version of the SUMA Reference Manual
-.PHONY: pdf-reference-suma
-pdf-reference-suma: modules/reference/nav-reference-guide.pdf.adoc
-	$(call pdf-reference-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-.PHONY: modules/administration/nav-administration-guide.pdf.adoc
-modules/administration/nav-administration-guide.pdf.adoc:
-	$(call pdf-book-create-index,administration)
-
-.PHONY: pdf-administration-suma
-## Generate PDF version of the SUMA Administration Guide
-pdf-administration-suma: modules/administration/nav-administration-guide.pdf.adoc
-	$(call pdf-administration-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-.PHONY: modules/salt/nav-salt-guide.pdf.adoc
-modules/salt/nav-salt-guide.pdf.adoc:
-	$(call pdf-book-create-index,salt)
-
-.PHONY: pdf-salt-suma
-## Generate PDF version of the SUMA Salt Guide
-pdf-salt-suma: modules/salt/nav-salt-guide.pdf.adoc
-	$(call pdf-salt-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-.PHONY: modules/retail/nav-retail-guide.pdf.adoc
-modules/retail/nav-retail-guide.pdf.adoc:
-	$(call pdf-book-create-index,retail)
-
-.PHONY: pdf-retail-suma
-## Generate PDF version of the SUMA Retail Guide
-pdf-retail-suma: modules/retail/nav-retail-guide.pdf.adoc
-	$(call pdf-retail-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-
-.PHONY: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc:
-	$(call pdf-book-create-index,quickstart-public-cloud)
-
-.PHONY: pdf-qs-public-cloud-suma
-## Generate PDF version of the SUMA Quickstart for public cloud
-pdf-qs-public-cloud-suma: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-	$(call pdf-quickstart-public-cloud-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-
-.PHONY: modules/architecture/nav-architecture-guide.pdf.adoc
-modules/architecture/nav-architecture-guide.pdf.adoc:
-	$(call pdf-book-create-index,architecture)
-
-.PHONY: pdf-architecture-suma
-## Generate PDF version of the SUMA Architecture Guide
-pdf-architecture-suma: modules/architecture/nav-architecture-guide.pdf.adoc
-	$(call pdf-architecture-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
-
-
-.PHONY: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc:
-	$(call pdf-book-create-index,quickstart-public-cloud)
-
-.PHONY: pdf-quickstart-public-cloud-suma
-## Generate PDF version of the SUMA Quickstart Guide for Public Cloud
-pdf-quickstart-public-cloud-suma: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-	$(call pdf-quickstart-public-cloud-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
-
+.PHONY: pdf-api-suma
+## Generate PDF version of the UYUNI API
+pdf-api-suma: modules/api/nav-api-guide.pdf.adoc
+	$(call pdf-api-product,$(PDF_THEME_SUMA),$(PRODUCTNAME_SUMA),$(SUMA_CONTENT),$(FILENAME_SUMA))
 
 
 # UYUNI DOCUMENTATION BUILD COMMANDS
 
 .PHONY: validate-uyuni
 validate-uyuni: ## Validates page references and prints a report (Does not build the site)
-	$(call validate,uyuni-site.yml)
-
-
+	$(call validate,uyuni-api-site.yml)
 
 .PHONY: pdf-tar-uyuni
 pdf-tar-uyuni: ## Create tar of PDF files
 	$(call pdf-tar-product,$(PDF_OUTPUT_UYUNI))
 
-
 .PHONY: antora-uyuni
-antora-uyuni: clean pdf-all-uyuni pdf-tar-uyuni ## Build the UYUNI Antora static site (See README for more information)
-		sed -i "s/^ *\(name: *suse-manager\)/#\1/;\
-	s/^ *\(title: *SUSE Manager\)/#\1/;\
+antora-uyuni: clean pdf-all-uyuni ##pdf-tar-uyuni ## Build the UYUNI Antora static site (See README for more information)
+		sed -i "s/^ *\(name: *docs\)/#\1/;\
+	s/^ *\(title: *SUSE Multi-Linux Manager\)/#\1/;\
 	s/^ *# *\(title: *Uyuni\)/\1/;\
 	s/^ *# *\(name: *uyuni\)/\1/;" antora.yml
-		DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr antora uyuni-site.yml --generator antora-site-generator-lunr
+		DOCSEARCH_ENABLED=true SITE_SEARCH_PROVIDER=lunr npx antora --extension @antora/lunr-extension uyuni-api-site.yml
 
 
 
@@ -362,59 +208,14 @@ obs-packages-uyuni: clean pdf-all-uyuni antora-uyuni ## Generate UYUNI OBS tar f
 	$(call obs-packages-product,$(HTML_OUTPUT_UYUNI),$(PDF_OUTPUT_UYUNI))
 
 
-
 .PHONY: pdf-all-uyuni
-pdf-all-uyuni: pdf-install-uyuni pdf-client-configuration-uyuni pdf-upgrade-uyuni pdf-reference-uyuni pdf-administration-uyuni pdf-salt-uyuni pdf-retail-uyuni ##pdf-architecture-uyuni ## Generate PDF versions of all UYUNI books
-
-
-
-## Generate PDF version of the UYUNI Installation Guide
-.PHONY: pdf-install-uyuni
-pdf-install-uyuni: modules/installation/nav-installation-guide.pdf.adoc
-	$(call pdf-install-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-
-
-## Generate PDF version of the UYUNI Client Configuration Guide
-.PHONY: pdf-client-configuration-uyuni
-pdf-client-configuration-uyuni: modules/client-configuration/nav-client-configuration-guide.pdf.adoc
-	$(call pdf-client-configuration-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Upgrade Guide
-.PHONY: pdf-upgrade-uyuni
-pdf-upgrade-uyuni: modules/upgrade/nav-upgrade-guide.pdf.adoc
-	$(call pdf-upgrade-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Reference Guide
-.PHONY: pdf-reference-uyuni
-pdf-reference-uyuni: modules/reference/nav-reference-guide.pdf.adoc
-	$(call pdf-reference-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Administration Guide
-.PHONY: pdf-administration-uyuni
-pdf-administration-uyuni: modules/administration/nav-administration-guide.pdf.adoc
-	$(call pdf-administration-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Salt Guide
-.PHONY: pdf-salt-uyuni
-pdf-salt-uyuni: modules/salt/nav-salt-guide.pdf.adoc
-	$(call pdf-salt-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Retail Guide
-.PHONY: pdf-retail-uyuni
-pdf-retail-uyuni: modules/retail/nav-retail-guide.pdf.adoc
-	$(call pdf-retail-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
-
-## Generate PDF version of the UYUNI Architecture Guide
-.PHONY: pdf-architecture-uyuni
-pdf-architecture-uyuni: modules/architecture/nav-architecture-guide.pdf.adoc
-	$(call pdf-architecture-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
+pdf-all-uyuni: pdf-api-uyuni ## Generate PDF version of the UYUNI API Documentation
 
-.PHONY: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc:
-	$(call pdf-book-create-index,quickstart-public-cloud)
+.PHONY: modules/api/nav-api-guide.pdf.adoc
+modules/api/nav-api-guide.pdf.adoc:
+	$(call pdf-book-create-index,api)
 
-.PHONY: pdf-quickstart-public-cloud-uyuni
-## Generate PDF version of the SUMA Quickstart Guide for Public Cloud
-pdf-quickstart-public-cloud-uyuni: modules/quickstart-public-cloud/nav-quickstart-public-cloud-guide.pdf.adoc
-	$(call pdf-quickstart-public-cloud-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))
+.PHONY: pdf-api-uyuni
+## Generate PDF version of the UYUNI API
+pdf-api-uyuni: modules/api/nav-api-guide.pdf.adoc
+	$(call pdf-api-product,$(PDF_THEME_UYUNI),$(PRODUCTNAME_UYUNI),$(UYUNI_CONTENT),$(FILENAME_UYUNI))

README.adoc

@@ -49,9 +49,3 @@ endif::[]
 == Introduction
 This is the source for the official Uyuni API documentation.
 
-[suma.docs.team]
-== The Uyuni Documentation Team
-
-* Joseph Cayouette @jcayouette
-* Karl Eichwalder @keichwa
-* Lana Brindley @Loquacity

antora.yml

@@ -1,22 +1,20 @@
 # Uncomment name and title to build for SUSE Manager
-#name: suse-manager
-#title: SUSE Manager
+#name: docs
+#title: SUSE Multi-Linux Manager
 
 # Uncomment name and title to build for Uyuni
 name: uyuni
-title: Uyuni
+title: Uyuni API
 
 # Which branch is the default for this playbook.
-version: master
+version: ~
 
 # Starting page or home
-start_page: ROOT:index
+start_page: ROOT:index.adoc
 
 nav:
   # ROOT Modules (release notes, introduction and resource links)
   - modules/ROOT/nav.adoc
 
   # Upgrade Guide
   - modules/api/nav-api-guide.adoc
-
-

branding/default-ui-old/suma/tmp/helpers/and.js

@@ -0,0 +1,9 @@
+'use strict'
+
+module.exports = (...args) => {
+  const numArgs = args.length
+  if (numArgs === 3) return args[0] && args[1]
+  if (numArgs < 3) throw new Error('{{and}} helper expects at least 2 arguments')
+  args.pop()
+  return args.every((it) => it)
+}