Skip to content

Conversation

@dcasota
Copy link
Contributor

@dcasota dcasota commented Dec 15, 2025

Documentation Analysis Report

Generated: 2025-12-15T08-49-57.148757
Tool: photonos-docs-lecturer.py v2.4
Last Updated: 2025-12-15T09:19:00.267454
Pages analyzed: 674
Issues found: 2433
Fixes applied: 132
LLM Provider: xai

Files Fixed

  • content/en/docs-v3/troubleshooting-guide/troubleshooting-tools/common-tools.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
  • content/en/docs-v5/user-guide/kubernetes-on-photon-os/kubernetes-kubeadm-cluster-on-photon/configure-master-node.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
  • content/en/docs-v4/installation-guide/downloading-photon.md: deprecated URLs
  • content/en/docs-v5/administration-guide/containers/docker-rootless-support.md: hardcoded replaces
  • content/en/docs-v5/installation-guide/downloading-photon.md: deprecated URLs
  • content/en/docs-v3/installation-guide/install-photon-on-dell-gateway/installing-photon-os-on-dell-300X.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/Overview/Introduction.md: hardcoded replaces
  • content/en/docs-v4/overview/Introduction.md: hardcoded replaces
  • content/en/docs-v3/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
  • content/en/docs-v4/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
  • content/en/docs-v5/Overview/Introduction.md: hardcoded replaces
  • content/en/docs-v5/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
  • content/en/docs-v4/troubleshooting-guide/photon-os-general-troubleshooting/photon-code.md: hardcoded replaces
  • content/en/docs-v5/troubleshooting-guide/photon-os-general-troubleshooting/photon-code.md: hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
  • content/en/docs-v3/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
  • content/en/docs-v4/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
  • content/en/docs-v5/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
  • content/en/docs-v3/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
  • content/en/docs-v4/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
  • content/en/docs-v5/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
  • content/en/docs-v5/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
  • content/en/docs-v3/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
  • content/en/docs-v5/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/user-guide/setting-up-network-pxe-boot.md: deprecated URLs
  • content/en/docs-v4/user-guide/setting-up-network-pxe-boot.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/user-guide/setting-up-network-pxe-boot.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
  • content/en/docs-v3/installation-guide/photon-management-daemon/available-apis.md:
  • content/en/docs-v3/installation-guide/build-iso-from-source/build-prerequisites.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
  • content/en/docs-v5/user-guide/kubernetes-on-photon-os/kubernetes-kubeadm-cluster-on-photon/configure-worker-node-on-kubernetes.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
  • content/en/docs-v3/Overview/Flavours.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
  • content/en/docs-v4/overview/Flavours.md: hardcoded replaces
  • content/en/docs-v5/Overview/Flavours.md: hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
  • content/en/docs-v5/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
  • content/en/docs-v3/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
  • content/en/docs-v4/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
  • content/en/docs-v4/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
  • content/en/docs-v4/installation-guide/run-photon-on-raspberry-pi/installing-the-iso-image-for-photon-os-rpi.md: hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
  • content/en/docs-v5/installation-guide/run-photon-on-raspberry-pi/installing-the-iso-image-for-photon-os-rpi.md: hardcoded replaces
  • content/en/docs-v3/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/administration-guide/containers/kubernetes.md:
  • content/en/docs-v5/administration-guide/containers/kubernetes.md:
  • content/en/docs-v4/installation-guide/upgrading-to-photon-os-4.md:
  • content/en/docs-v3/administration-guide/managing-network-configuration/using-the-network-configuration-manager.md:
  • content/en/docs-v3/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs
  • content/en/docs-v5/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs
  • content/en/docs-v3/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
  • content/en/docs-v4/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
  • content/en/docs-v5/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
  • content/en/docs-v3/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
  • content/en/docs-v3/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
  • content/en/docs-v5/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
  • content/en/docs-v5/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
  • content/en/docs-v5/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
  • content/en/docs-v3/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
  • content/en/docs-v4/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
  • content/en/docs-v4/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
  • content/en/docs-v4/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
  • content/en/docs-v3/administration-guide/photon-os-packages/signed-packages.md: broken emails
  • content/en/docs-v4/administration-guide/photon-os-packages/signed-packages.md: broken emails
  • content/en/docs-v5/administration-guide/photon-os-packages/signed-packages.md: broken emails
  • content/en/docs-v4/administration-guide/photon-os-packages/photon-os-package-repositories.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/administration-guide/photon-os-packages/photon-os-package-repositories.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/administration-guide/pmd-nextgen/photon-mgmtd-web-REST-API/user-group-host-management.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
  • content/en/docs-v4/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
  • content/en/docs-v5/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
  • content/en/docs-v3/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
  • content/en/docs-v4/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
  • content/en/docs-v5/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
  • content/en/docs-v4/administration-guide/managing-packages-with-tdnf/install-package-cli.md: deprecated URLs
  • content/en/docs-v5/administration-guide/managing-packages-with-tdnf/install-package-cli.md: deprecated URLs
  • content/en/docs-v3/administration-guide/changing-the-locale.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/changing-the-locale.md: hardcoded replaces
  • content/en/docs-v5/administration-guide/changing-the-locale.md: hardcoded replaces
  • content/en/docs-v4/troubleshooting-guide/troubleshooting-packages.md:
  • content/en/docs-v3/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v4/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v5/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
  • content/en/docs-v3/administration-guide/managing-network-configuration/netmgr.c.md: hardcoded replaces
  • content/en/docs-v4/administration-guide/managing-network-configuration/netmgr.c.md: hardcoded replaces

Issue Categories Detected and Fixed

Deterministic Fixes (Applied Automatically)

  • VMware spelling: Corrected incorrect spellings (vmware, Vmware, etc.) to VMware (excludes URLs, file paths, emails, code blocks)
  • Deprecated URLs: Updated packages.vmware.com URLs to packages.broadcom.com
  • Backtick spacing: Fixed missing spaces before/after inline code
  • Backtick errors: Fixed spaces inside backticks (e.g., "code" -> "code")
  • Heading hierarchy: Fixed heading level violations (e.g., H1 -> H3 skips)
  • Shell prompts: Removed shell prompt prefixes ($, #, ❯) from code blocks

LLM-Assisted Fixes (Requires --llm flag)

  • Grammar/spelling errors: Language and grammar corrections (preserves URLs exactly)
  • Markdown artifacts: Fixed unrendered markdown syntax (preserves URLs exactly)
  • Mixed command/output: Separated command and output into distinct code blocks
  • Indentation issues: Fixed list and code block indentation

Issues Reported (Manual Review Recommended)

  • Broken links: Orphan URLs requiring manual verification
  • Broken images: Missing or inaccessible image files
  • Unaligned images: Images lacking proper CSS alignment
  • Unclosed code blocks: Fenced (```) or inline (`) code blocks without closing markers

This PR is updated incrementally as fixes are applied. Check the commit history for details.

@dcasota dcasota force-pushed the photon-hugo branch 30 times, most recently from 5d4f053 to 7ad9c59 Compare December 15, 2025 08:54
@dcasota dcasota force-pushed the photon-hugo branch 27 times, most recently from 09d7a05 to b1e1b13 Compare December 15, 2025 09:17
- content/en/docs-v3/troubleshooting-guide/troubleshooting-tools/common-tools.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
- content/en/docs-v4/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
- content/en/docs-v5/user-guide/kubernetes-on-photon-os/kubernetes-kubeadm-cluster-on-photon/configure-master-node.md: hardcoded replaces
- content/en/docs-v5/administration-guide/security-policy/default-firewall-settings.md: hardcoded replaces
- content/en/docs-v4/installation-guide/downloading-photon.md: deprecated URLs
- content/en/docs-v5/administration-guide/containers/docker-rootless-support.md: hardcoded replaces
- content/en/docs-v5/installation-guide/downloading-photon.md: deprecated URLs
- content/en/docs-v3/installation-guide/install-photon-on-dell-gateway/installing-photon-os-on-dell-300X.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/Overview/Introduction.md: hardcoded replaces
- content/en/docs-v4/overview/Introduction.md: hardcoded replaces
- content/en/docs-v3/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
- content/en/docs-v4/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
- content/en/docs-v5/Overview/Introduction.md: hardcoded replaces
- content/en/docs-v5/troubleshooting-guide/kernel-problems-and-boot-and-login-errors/kernel-overview.md: hardcoded replaces
- content/en/docs-v4/troubleshooting-guide/photon-os-general-troubleshooting/photon-code.md: hardcoded replaces
- content/en/docs-v5/troubleshooting-guide/photon-os-general-troubleshooting/photon-code.md: hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
- content/en/docs-v3/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
- content/en/docs-v4/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-aws-ec2/prerequisites-for-photon-os-on-aws-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
- content/en/docs-v5/installation-guide/run-photon-on-azure/prerequisites-for-photon-os-on-azure.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
- content/en/docs-v3/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-on-fusion/prerequisites-for-photon-os-on-fusion.md: deprecated URLs
- content/en/docs-v4/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
- content/en/docs-v5/installation-guide/run-photon-on-gce/prerequisites-for-photon-os-on-gce.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
- content/en/docs-v5/installation-guide/run-photon-on-raspberry-pi/prerequisites-for-photon-os-on-rpi.md: deprecated URLs
- content/en/docs-v3/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-workstation/prerequisites-for-photon-os-on-workstation.md: deprecated URLs
- content/en/docs-v5/installation-guide/run-photon-on-vsphere/prerequisites-for-photon-os-on-vsphere.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/user-guide/setting-up-network-pxe-boot.md: deprecated URLs
- content/en/docs-v4/user-guide/setting-up-network-pxe-boot.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/user-guide/setting-up-network-pxe-boot.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
- content/en/docs-v3/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
- content/en/docs-v5/administration-guide/managing-packages-with-tdnf/standard-syntax-for-tndf/commands.md: hardcoded replaces
- content/en/docs-v3/installation-guide/photon-management-daemon/available-apis.md:
- content/en/docs-v3/installation-guide/build-iso-from-source/build-prerequisites.md: hardcoded replaces
- content/en/docs-v3/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
- content/en/docs-v4/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
- content/en/docs-v5/administration-guide/managing-packages-with-tdnf/configuration-files-and-repositories.md: hardcoded replaces
- content/en/docs-v3/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
- content/en/docs-v5/user-guide/kubernetes-on-photon-os/kubernetes-kubeadm-cluster-on-photon/configure-worker-node-on-kubernetes.md: hardcoded replaces
- content/en/docs-v4/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
- content/en/docs-v5/administration-guide/managing-services-withsystemd/controlling-services.md: hardcoded replaces
- content/en/docs-v4/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
- content/en/docs-v3/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
- content/en/docs-v3/Overview/Flavours.md: hardcoded replaces
- content/en/docs-v5/administration-guide/cloud-init-on-photon-os/deploy-photon-os-with-cloud-init.md: hardcoded replaces
- content/en/docs-v4/overview/Flavours.md: hardcoded replaces
- content/en/docs-v5/Overview/Flavours.md: hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
- content/en/docs-v5/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
- content/en/docs-v3/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-fusion/importing-photon-os-from-ova-on-fusion.md: hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-on-vsphere/importing-photon-os-from-ova-on-vsphere.md:
- content/en/docs-v4/installation-guide/run-photon-on-workstation/importing-photon-os-from-ova-on-workstation.md: hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
- content/en/docs-v4/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
- content/en/docs-v4/installation-guide/run-photon-on-raspberry-pi/installing-the-iso-image-for-photon-os-rpi.md: hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-on-gce/installing-photon-os-on-gce.md:
- content/en/docs-v5/installation-guide/run-photon-on-raspberry-pi/installing-the-iso-image-for-photon-os-rpi.md: hardcoded replaces
- content/en/docs-v3/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/user-guide/working-with-kickstart.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/administration-guide/containers/kubernetes.md:
- content/en/docs-v5/administration-guide/containers/kubernetes.md:
- content/en/docs-v4/installation-guide/upgrading-to-photon-os-4.md:
- content/en/docs-v3/administration-guide/managing-network-configuration/using-the-network-configuration-manager.md:
- content/en/docs-v3/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs
- content/en/docs-v5/administration-guide/managing-packages-with-tdnf/adding-a-new-repository.md: deprecated URLs
- content/en/docs-v3/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
- content/en/docs-v4/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
- content/en/docs-v5/installation-guide/run-photon-aws-ec2/deploying-a-containerized-application-in-photon-os-via-ssh.md: hardcoded replaces
- content/en/docs-v3/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
- content/en/docs-v3/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
- content/en/docs-v5/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
- content/en/docs-v5/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
- content/en/docs-v5/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
- content/en/docs-v3/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
- content/en/docs-v4/installation-guide/run-photon-on-fusion/installing-photon-os-from-iso-image-on-fusion.md:
- content/en/docs-v4/installation-guide/run-photon-on-vsphere/installing-photon-os-from-iso-image-on-vsphere.md:
- content/en/docs-v4/installation-guide/run-photon-on-workstation/installing-photon-os-from-iso-on-workstation.md:
- content/en/docs-v3/administration-guide/photon-os-packages/signed-packages.md: broken emails
- content/en/docs-v4/administration-guide/photon-os-packages/signed-packages.md: broken emails
- content/en/docs-v5/administration-guide/photon-os-packages/signed-packages.md: broken emails
- content/en/docs-v4/administration-guide/photon-os-packages/photon-os-package-repositories.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/administration-guide/photon-os-packages/photon-os-package-repositories.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/administration-guide/pmd-nextgen/photon-mgmtd-web-REST-API/user-group-host-management.md: hardcoded replaces
- content/en/docs-v3/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/administration-guide/photon-os-packages/building-a-package-from-a-source-rpm.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
- content/en/docs-v4/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
- content/en/docs-v5/troubleshooting-guide/network-troubleshooting/checking-firewall-rules.md: hardcoded replaces
- content/en/docs-v3/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/administration-guide/cloud-init-on-photon-os/customizing-a-photon-os-machine-on-ec2.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
- content/en/docs-v4/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
- content/en/docs-v5/administration-guide/cloud-init-on-photon-os/running-a-photon-os-machine-on-gce.md: deprecated URLs
- content/en/docs-v4/administration-guide/managing-packages-with-tdnf/install-package-cli.md: deprecated URLs
- content/en/docs-v5/administration-guide/managing-packages-with-tdnf/install-package-cli.md: deprecated URLs
- content/en/docs-v3/administration-guide/changing-the-locale.md: hardcoded replaces
- content/en/docs-v4/administration-guide/changing-the-locale.md: hardcoded replaces
- content/en/docs-v5/administration-guide/changing-the-locale.md: hardcoded replaces
- content/en/docs-v4/troubleshooting-guide/troubleshooting-packages.md:
- content/en/docs-v3/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
- content/en/docs-v4/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
- content/en/docs-v5/installation-guide/cloud-images.md: deprecated URLs, hardcoded replaces
- content/en/docs-v3/administration-guide/managing-network-configuration/netmgr.c.md: hardcoded replaces
- content/en/docs-v4/administration-guide/managing-network-configuration/netmgr.c.md: hardcoded replaces

Automated fixes by photonos-docs-lecturer.py v2.4
@dcasota
Copy link
Contributor Author

dcasota commented Dec 15, 2025

Hi,

With the official integration of the URL https://packages.broadcom.com/photon in recent commits, documentation updates are now underway.

Is everything error-free?

Not entirely. Future revisions will address enhancements including html comments, correct spelling of VMware, replacement of Bintray, improved use of backticks, refinement of Markdown formatting, indentation adjustments, numbered lists, and rectification of orphaned weblinks and image links - particularly for printview. Refer to files such as build-the-iso.md, build-cloud-images.md, build-ova.md, build-prerequisites.md, and prerequisites-for-photon-os-on-gce.md for specific cases. Achieving error-free documentation and printview is an attainable goal.

Lack of new content

There is so much new content through the commits in 2024/2025. Source provenance, canister, databases, offline/air-gapped functionality, hardening, etc.

What additional documentation system features are possible (wishlist)?

A number of valuable improvements could be implemented:

  • A copy-button positioned beside each fenced console command block, contingent on cleanup of command blocks and separation between commands and outputs.
  • A run-button for an embedded code sandbox adjacent to each fenced console command block, requiring curated context for each command block.
  • Integration of a chatbot within the search functionality.
  • Monthly changelog narratives corresponding to commits in active branches such as common, docs-v5, and docs-v4.
  • Multilanguage support.
  • Updated Hugo framework.
  • User academy featuring video tutorials, documentation, and blogs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant