Merge remote-tracking branch 'upstream/main' into sync-20250206-1

Author: mattias-kindborg-at-work

404.html

@@ -4,6 +4,7 @@
 permalink: /404
 nav_exclude: true
 search_exclude: true
+redirect_to: https://developer.axis.com/acap/
 ---
 
 <h1>Page not found</h1>

Gemfile

@@ -4,4 +4,5 @@ source "https://rubygems.org/"
 # here are only used for local development. Update the versions when needed to
 # match GitHub Pages, see https://pages.github.com/versions for more info.
 gem "github-pages", "~> 231"
-gem "just-the-docs", "~> 0.10.0"
+gem "just-the-docs", "~> 0.10.0"
+gem "jekyll-redirect-from"

README.md

@@ -1,5 +1,10 @@
 # ACAP documentation
 
+<!-- textlint-disable -->
+> [!Note]
+> This repository has been archived and its content migrated to [Axis Developer Documentation](https://developer.axis.com/) where ACAP documentation is found at <https://developer.axis.com/acap>. For the rational behind the migration, see [this blog post](https://developer.axis.com/blog/2025/02/06/acap).
+<!-- textlint-enable -->
+
 Welcome to the AXIS Camera Application Platform (ACAP) [documentation](https://axiscommunications.github.io/acap-documentation), which is built with [GitHub pages](https://pages.github.com/).
 
 ## Contribute

_config.yml

@@ -54,6 +54,7 @@ kramdown:
 plugins:
   - jekyll-remote-theme
   - jekyll-sitemap
+  - jekyll-redirect-from
 
 # ------------------------------------------------------------------------------
 # Theme settings
@@ -70,9 +71,6 @@ aux_links:
 search_enabled: true
 heading_anchors: true
 
-# Google Analytics Tracking
-ga_tracking: UA-266925-56
-
 # Back to top link
 back_to_top: true
 back_to_top_text: Back to top

build_redirects.py

@@ -0,0 +1,84 @@
+import os
+import glob
+
+def find_files(directory):
+    pattern = os.path.join(directory, "**", "*.md")
+    return glob.glob(pattern, recursive=True)
+
+def add_frontmatter_config(file_path, config_key, config_value):
+    with open(file_path, "r") as file:
+        content = file.read()
+
+    parts = content.split("---")
+    if len(parts) < 3:
+        raise ValueError("The file does not contain valid FrontMatter")
+
+    frontmatter = parts[1].strip()
+    rest_of_content = "---".join(parts[2:])
+
+    frontmatter_lines = frontmatter.split("\n")
+
+    key_exists = False
+    for i, line in enumerate(frontmatter_lines):
+        if line.startswith(f"{config_key}:"):
+            frontmatter_lines[i] = f"{config_key}: {config_value}"
+            key_exists = True
+            break
+
+    if not key_exists:
+        frontmatter_lines.append(f"{config_key}: {config_value}")
+
+    frontmatter = "\n".join(frontmatter_lines)
+
+    updated_content = f"---\n{frontmatter}\n---{rest_of_content}"
+
+    with open(file_path, "w") as file:
+        file.write(updated_content)
+
+files = find_files("./docs")
+files.append("./index.md")
+files.append("./404.html")
+
+for file in files:
+    relativePath = file.replace("./docs/", "").replace("./", "").replace("index.md", "").replace(".md", "")
+
+    # The following redirects are changed because in Docusaurus a category
+    # doesn't necessarily have a page associated with it
+
+    if (relativePath == "introduction/"):
+        relativePath = "introduction/what-is-acap"
+
+    if (relativePath == "get-started/" or relativePath == "get-started/set-up-developer-environment/"):
+        relativePath = "get-started/set-up-developer-environment/pre-requisites"
+
+    if (relativePath == "api/"):
+        relativePath = "api/native-sdk-api"
+
+    if (relativePath == "service/"):
+        relativePath = "service/acap-service-portal"
+
+    if (relativePath == "acap-sdk-version-3/"):
+        relativePath = "acap-sdk-version-3/introduction"
+
+    if (relativePath == "acap-sdk-version-3/develop-applications/"):
+        relativePath = "acap-sdk-version-3/develop-applications/application-project-structure"
+
+    if (relativePath == "acap-sdk-version-3/services-for-partners/"):
+        relativePath = "acap-sdk-version-3/services-for-partners/package-signing"
+
+    # This page ios removed in the migration, redirect to the root of the ACAP
+    # documentation
+    if (relativePath == "licenses/"):
+        relativePath = ""
+    
+    # Redirect them to the root of the ACAP documentation    
+    if (relativePath == "404.html"):
+        relativePath = ""
+        
+    if (not relativePath.endswith("release-notes/") and "release-notes/" in relativePath):
+        relativePath += "/"
+
+    url = f"https://developer.axis.com/acap/{relativePath}"
+
+    add_frontmatter_config(file, "redirect_to", url)
+    

docs/acap-sdk-version-3/api/index.md

@@ -3,6 +3,7 @@ layout: acap_sdk_version_3
 parent: ACAP SDK version 3
 title: API
 nav_order: 6
+redirect_to: https://developer.axis.com/acap/acap-sdk-version-3/api/
 ---
 # API
 

docs/acap-sdk-version-3/develop-applications/application-project-structure.md

@@ -4,6 +4,7 @@ parent: Develop applications
 grand_parent: ACAP SDK version 3
 title: Application project structure
 nav_order: 1
+redirect_to: https://developer.axis.com/acap/acap-sdk-version-3/develop-applications/application-project-structure
 ---
 # Application project structure
 

docs/acap-sdk-version-3/develop-applications/build-install-and-run-the-application.md

@@ -4,6 +4,7 @@ parent: Develop applications
 grand_parent: ACAP SDK version 3
 title: Build, install and run the application
 nav_order: 2
+redirect_to: https://developer.axis.com/acap/acap-sdk-version-3/develop-applications/build-install-and-run-the-application
 ---
 # Build, install and run the application
 

docs/acap-sdk-version-3/develop-applications/develop-using-visual-studio-code.md

@@ -4,6 +4,7 @@ parent: Develop applications
 grand_parent: ACAP SDK version 3
 title: Develop using Visual Studio Code
 nav_order: 5
+redirect_to: https://developer.axis.com/acap/acap-sdk-version-3/develop-applications/develop-using-visual-studio-code
 ---
 # Develop using Visual Studio Code
 

docs/acap-sdk-version-3/develop-applications/index.md

@@ -4,5 +4,6 @@ parent: ACAP SDK version 3
 title: Develop applications
 nav_order: 3
 has_children: true
+redirect_to: https://developer.axis.com/acap/acap-sdk-version-3/develop-applications/application-project-structure
 ---
 # Develop applications