Create nginx redirect map for Confluence URLs from sitemap.xml

nginx has a _very_ fast map implementation that allows you to provide
a map of old->new redirect URLs.  Rather than us having to maintain a
list of old/broken links in mkdocs.yml, we now create a redirect map
from the sitemap.xml file mkdocs already creates.  The downloads server
that handles the redirects from wiki.asterisk.org to docs.asterisk.org
now uses that map to do the redirects.

Also moved the files in the utils directory that were only needed for
the initial import to the utils/initial_import directory.

Author: gtjoseph

.github/workflows/publish.yml

@@ -15,12 +15,16 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
       - uses: actions/setup-python@v5
         with:
           python-version: 3.x
           cache: 'pip'
-      - run: pip install -r requirements.txt
-      
+
+      - name: Setup
+        run: |
+          pip install -r requirements.txt
+
       - name: Get Token needed to push updates
         id: get_workflow_token
         uses: peter-murray/workflow-application-token-action@v3
@@ -35,11 +39,11 @@ jobs:
           GH_TOKEN:      ${{steps.get_workflow_token.outputs.token}}
         run: |
           gh auth setup-git -h github.com
-          git config --global user.email "asteriskteam@digium.com"
+          git config --global user.email "asteriskteam@sangoma.com"
           git config --global user.name "Asterisk Development Team"
           cat >Makefile.inc <<EOF
           ${{vars.MAKEFILE_INC}}
           EOF
           make
+          make temp/site/redirect_map.conf
           make deploy
-

Makefile

@@ -180,6 +180,10 @@ else
 	@mkdocs build -f $(BUILD_DIR)/mkdocs.yml -d $(SITE_DIR)
 endif
 
+temp/site/redirect_map.conf: temp/site/sitemap.xml
+	@echo "Creating $@ from $^"
+	@./utils/create_redirect_map.py $^ $@
+
 deploy: no-branch-check
 	@if [ -z "$(DEPLOY_REMOTE)" ] ; then \
 		echo "No DEPLOY_REMOTE was defined in Makefile.inc" ;\
@@ -189,7 +193,7 @@ deploy: no-branch-check
 	@[ ! -f $(BUILD_DIR)/mkdocs.yml ] && \
 		{ echo "Can't deploy. '$(BUILD_DIR)/mkdocs.yml' not found" ; exit 1 ; } || :
 	@sed -i -r -e "$(MINIFY_REGEX)" $(BUILD_DIR)/mkdocs.yml
-	@mkdocs gh-deploy -r $(DEPLOY_REMOTE) -b $(DEPLOY_BRANCH) \
+	@mkdocs gh-deploy --dirty -r $(DEPLOY_REMOTE) -b $(DEPLOY_BRANCH) \
 		-d $(SITE_DIR) --no-history -f $(BUILD_DIR)/mkdocs.yml
 
 serve: 

mkdocs.yml

@@ -56,19 +56,6 @@ extra_css:
   - material-override.css
 
 plugins:
-  - redirects:
-      redirect_maps:
-        Asterisk+Community+Code+of+Conduct.md: Asterisk-Community/Asterisk-Community-Code-of-Conduct.md
-        Building+and+Installing+Asterisk.md: Getting-Started/Installing-Asterisk/Installing-Asterisk-From-Source/Building-and-Installing-Asterisk.md
-        Secure+Calling+Tutorial.md: Deployment/Secure-Calling/Secure-Calling-Tutorial/index.md
-        PJSIP+Configuration+Wizard.md: Configuration/Channel-Drivers/SIP/Configuring-res_pjsip/PJSIP-Configuration-Wizard.md
-        Realtime+Database+Configuration.md: Fundamentals/Asterisk-Configuration/Database-Support-Configuration/Realtime-Database-Configuration.md
-        ConfBridge.md: Configuration/Applications/Conferencing-Applications/ConfBridge/index.md
-        SIP+Retransmissions.md: Deployment/Troubleshooting/SIP-Retransmissions.md
-        Voice+Prompts+and+Music+on+Hold+License.md: About-the-Project/License-Information/Voice-Prompts-and-Music-on-Hold-License.md
-        Querying+and+Manipulating+State.md: Fundamentals/Key-Concepts/States-and-Presence/Querying-and-Manipulating-State.md
-        Build+System+Architecture.md: Development/Reference-Information/Other-Reference-Information/Build-System-Architecture.md
-        Important+Security+Considerations.md: Deployment/Important-Security-Considerations/index.md
   - search
   - awesome-pages:
       filename: .pages

utils/create_redirect_map.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+"""Convert sitemap to redirect map for old Confluence URLs
+
+Copyright (C) 2025, Sangoma Technologies, Inc.
+George T Joseph <gjoseph@sangoma.com>
+
+This program is free software, distributed under the terms of
+the GNU General Public License Version 2.
+"""
+
+import sys, os, re
+import xml.etree.ElementTree as ET
+from urllib.parse import urlparse
+from datetime import datetime as dt
+import datetime
+
+sectionmap = {
+    "WhatsNew/" : "New+in+{version}",
+    "Upgrading/" : "Upgrading+to+Asterisk+{version}",
+    "API_Documentation/" : "Asterisk+{version}+Command+Reference",
+    }
+
+subsectionmap = {
+    "AGI_Commands/": ("AGI+Commands", "AGICommand"),
+    "AMI_Actions/": ("AMI+Actions", "ManagerAction"),
+    "AMI_Events/": ("AMI+Events", "ManagerEvent"),
+    "Dialplan_Applications/": ("Dialplan+Applications", "Application"),
+    "Dialplan_Functions/": ("Dialplan+Functions", "Function"),
+    "ARI/": ("ARI", None),
+    "Asterisk_REST_Interface/": ("ARI", None),
+    "Module_Configuration/": ("Module+Configuration", "Configuration"),
+    "Modules/": (None, None),
+    }
+
+def main(argv):
+    infile = argv[1] if len(argv) > 1 else None
+    outfile = argv[2] if len(argv) > 2 else None
+    tree = ET.parse(infile)
+    redirects = {}
+    for loc in tree.findall(".//{*}url/{*}loc"):
+        url = urlparse(loc.text)
+        path = url.path
+        if path.endswith('/'):
+            path = path[:-1]
+        m = re.match(r'/Asterisk_([0-9]+)_Documentation/([^/]+/)?([^/]+/)?([^/]+/)?$', url.path)
+        api_section = ""
+        section = ""
+        pagename = ""
+        if m is not None:
+            version = m.groups()[0]
+            if m.groups()[1]:
+                section = sectionmap[m.groups()[1]]
+            if m.groups()[2]: 
+                subsection = subsectionmap[m.groups()[2]]
+            pagename = m.groups()[3]
+            if m.lastindex == 1:
+                key = f"/wiki/display/AST/Asterisk+{version}+Documentation".lower()
+            elif m.lastindex == 2:
+                key = f"/wiki/display/AST/{section.format(version=version)}".lower()
+            elif m.lastindex == 3:
+                if subsection[0] is None:
+                    continue
+                key = f"/wiki/display/AST/Asterisk+{version}+{subsection[0]}".lower()
+            elif  m.lastindex == 4:
+                if pagename.endswith('/'):
+                    pagename = pagename[:-1]
+                if subsection[1] is None:
+                    sn = ""
+                    pagename = pagename.replace('_','+')
+                else:
+                    sn = subsection[1]+"_"
+                if subsection[1] == "AGICommand":
+                    pagename = pagename.replace('_','+')
+                key = f"/wiki/display/AST/Asterisk+{version}+{sn}{pagename}".lower()
+        else:
+            if re.match(r'/(?:Certified-Asterisk|Latest_API)', url.path):
+                continue
+            if url.path == '/':
+                key = "/wiki/display/AST/Home".lower()
+            else:
+                key = f"/wiki/display/AST/{os.path.basename(path).replace('-','+')}".lower()
+        if key not in redirects:
+            redirects[key] = url.path
+    with open(outfile, 'w') if outfile else sys.stdout as f:
+        f.write("# Auto-generated file. Do not edit!\n")
+        d = dt.now().strftime("%Y-%m-%d %T %z")
+        f.write(f"# Generated {d}\n")
+        f.write("# Maps old URLs to new URLs\n")
+        f.write("# Format: /old/url/ /new/url/;\n")
+        f.write("#\n")
+        for k in redirects.keys():
+            f.write(f"{k} {redirects[k]};\n")
+    return 0
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv) or 0)