From a544b5d48062eef940fbc96b46b83cc2919825d6 Mon Sep 17 00:00:00 2001 From: jcayouette Date: Tue, 13 Oct 2026 16:52:55 +0200 Subject: [PATCH] Add English meta descriptions to SUSE Edge 3.3 docs. Each English page now has a finished description, and revision dates stay unchanged. --- docs/en/README.adoc | 1 + docs/en/components/akri.adoc | 1 + docs/en/components/edge-image-builder.adoc | 1 + docs/en/components/elemental.adoc | 1 + docs/en/components/endpoint-copier-operator.adoc | 1 + docs/en/components/fleet.adoc | 1 + docs/en/components/k3s.adoc | 1 + docs/en/components/linux-micro.adoc | 1 + docs/en/components/longhorn.adoc | 1 + docs/en/components/metal3.adoc | 1 + docs/en/components/metallb.adoc | 1 + docs/en/components/networking.adoc | 1 + docs/en/components/neuvector.adoc | 1 + docs/en/components/rancher-dashboard-extensions.adoc | 1 + docs/en/components/rancher.adoc | 1 + docs/en/components/rke2.adoc | 1 + docs/en/components/suse-multilinux-manager.adoc | 1 + docs/en/components/system-upgrade-controller.adoc | 1 + docs/en/components/turtles.adoc | 1 + docs/en/components/upgrade-controller.adoc | 1 + docs/en/components/virtualization.adoc | 1 + docs/en/concepts/observability.adoc | 1 + docs/en/concepts/terms.adoc | 1 + docs/en/day2/downstream-clusters.adoc | 1 + docs/en/day2/fleet-helm-upgrade.adoc | 1 + docs/en/day2/fleet-k8s-upgrade.adoc | 1 + docs/en/day2/fleet-os-upgrade.adoc | 1 + docs/en/day2/fleet.adoc | 1 + docs/en/day2/mgmt-cluster.adoc | 1 + docs/en/day2/migration.adoc | 1 + docs/en/day2/upgrade-controller.adoc | 1 + docs/en/edge-book/edge.adoc | 1 + docs/en/edge-book/releasenotes.adoc | 1 + docs/en/edge-book/version-matrix.adoc | 1 + docs/en/edge-book/welcome.adoc | 1 + docs/en/github_workflow_best_practices.adoc | 1 + docs/en/guides/air-gapped-eib-deployments.adoc | 1 + docs/en/guides/clusterclass.adoc | 1 + docs/en/guides/kiwi-builder-images.adoc | 1 + docs/en/guides/metallb-k3s.adoc | 1 + docs/en/guides/metallb-kube-api.adoc | 1 + docs/en/integrations/create-package-obs.adoc | 1 + docs/en/integrations/linkerd.adoc | 1 + docs/en/integrations/nats.adoc | 1 + docs/en/integrations/nvidia-slemicro.adoc | 1 + docs/en/product/atip-architecture.adoc | 1 + docs/en/product/atip-automated-provision.adoc | 1 + docs/en/product/atip-features.adoc | 1 + docs/en/product/atip-lifecycle.adoc | 1 + docs/en/product/atip-management-cluster.adoc | 1 + docs/en/product/atip-requirements.adoc | 1 + docs/en/product/atip.adoc | 1 + docs/en/quickstart/eib.adoc | 1 + docs/en/quickstart/elemental.adoc | 1 + docs/en/quickstart/metal3.adoc | 1 + docs/en/quickstart/suse-multilinux-manager.adoc | 1 + docs/en/tech_writing_best_practices.adoc | 1 + docs/en/tips/eib.adoc | 1 + docs/en/tips/elemental.adoc | 1 + docs/en/tips/metal3.adoc | 1 + docs/en/troubleshooting/collecting-diagnostics-for-support.adoc | 1 + docs/en/troubleshooting/general-troubleshooting-principles.adoc | 1 + .../troubleshooting-directed-network-provisioning.adoc | 1 + docs/en/troubleshooting/troubleshooting-edge-image-builder.adoc | 1 + docs/en/troubleshooting/troubleshooting-edge-networking.adoc | 1 + docs/en/troubleshooting/troubleshooting-kiwi.adoc | 1 + docs/en/troubleshooting/troubleshooting-other-components.adoc | 1 + .../en/troubleshooting/troubleshooting-phone-home-scenarios.adoc | 1 + 68 files changed, 68 insertions(+) diff --git a/docs/en/README.adoc b/docs/en/README.adoc index fa21dfad7..908bf5eb4 100644 --- a/docs/en/README.adoc +++ b/docs/en/README.adoc @@ -1,4 +1,5 @@ = SUSE Edge Documentation +:description: Find and learn about writing and building SUSE Edge documentation using Asciidoc, including best practices, examples, and tools :revdate: 2024-03-06 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/akri.adoc b/docs/en/components/akri.adoc index 82c4ccbd6..fa86ef3a6 100644 --- a/docs/en/components/akri.adoc +++ b/docs/en/components/akri.adoc @@ -1,5 +1,6 @@ [#components-akri] = Akri +:description: Learn how to use Akri to discover leaf devices and schedule workloads on them using Configuration CRDs and discovery handlers :revdate: 2025-01-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/edge-image-builder.adoc b/docs/en/components/edge-image-builder.adoc index 2db0f38d2..021971d22 100644 --- a/docs/en/components/edge-image-builder.adoc +++ b/docs/en/components/edge-image-builder.adoc @@ -1,5 +1,6 @@ [#components-eib] = Edge Image Builder +:description: Use Edge Image Builder to create customized, ready-to-boot disk images for air-gapped deployments that include Kubernetes clusters and system configurations :revdate: 2025-08-07 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/elemental.adoc b/docs/en/components/elemental.adoc index c987b7f90..f7e614034 100644 --- a/docs/en/components/elemental.adoc +++ b/docs/en/components/elemental.adoc @@ -1,5 +1,6 @@ [#components-elemental] = Elemental +:description: Use Elemental to register and manage edge nodes with Rancher for Kubernetes deployment by configuring elemental-register and elemental-system-agent :revdate: 2025-01-16 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/endpoint-copier-operator.adoc b/docs/en/components/endpoint-copier-operator.adoc index 6a54f47b1..4e60d38c7 100644 --- a/docs/en/components/endpoint-copier-operator.adoc +++ b/docs/en/components/endpoint-copier-operator.adoc @@ -1,5 +1,6 @@ [#components-eco] = Endpoint Copier Operator +:description: Operate the Endpoint Copier Operator to create and sync a Kubernetes Service and Endpoint for High Availability setups in K3s or RKE2 clusters :revdate: 2025-02-28 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/fleet.adoc b/docs/en/components/fleet.adoc index 2a182348e..63a5a97d7 100644 --- a/docs/en/components/fleet.adoc +++ b/docs/en/components/fleet.adoc @@ -1,5 +1,6 @@ [#components-fleet] = Fleet +:description: Use Fleet to manage Kubernetes applications from Git with Helm and monitor cluster resources through Ranchers Continuous Delivery interface :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/k3s.adoc b/docs/en/components/k3s.adoc index 3e28ba85f..1fb436d47 100644 --- a/docs/en/components/k3s.adoc +++ b/docs/en/components/k3s.adoc @@ -1,5 +1,6 @@ [#components-k3s] = K3s +:description: Install K3s on SUSE Linux Micro using Edge Image Builder to set up a highly available Kubernetes cluster for SUSE Edge workloads :revdate: 2025-01-16 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/linux-micro.adoc b/docs/en/components/linux-micro.adoc index 150c8b787..e70bc911e 100644 --- a/docs/en/components/linux-micro.adoc +++ b/docs/en/components/linux-micro.adoc @@ -1,5 +1,6 @@ [#components-slmicro] = SUSE Linux Micro +:description: Use SUSE Linux Micro to create a secure, lightweight operating system for the edge with features like Btrfs snapshots and Cockpit for local management :revdate: 2025-01-16 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/longhorn.adoc b/docs/en/components/longhorn.adoc index 919b8e29c..c24f4c055 100644 --- a/docs/en/components/longhorn.adoc +++ b/docs/en/components/longhorn.adoc @@ -1,5 +1,6 @@ [#components-suse-storage] = https://www.suse.com/products/rancher/storage/[SUSE Storage] +:description: Install SUSE Storage on Kubernetes clusters using Helm by adding the Rancher Charts repository and fetching charts :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/metal3.adoc b/docs/en/components/metal3.adoc index 1281491d2..c38260134 100644 --- a/docs/en/components/metal3.adoc +++ b/docs/en/components/metal3.adoc @@ -1,5 +1,6 @@ [#components-metal3] = Metal^3^ +:description: Manage bare-metal servers with Metal³ using Kubernetes-native resources and out-of-band protocols like Redfish :revdate: 2024-11-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/metallb.adoc b/docs/en/components/metallb.adoc index 088f1118e..b60ceae47 100644 --- a/docs/en/components/metallb.adoc +++ b/docs/en/components/metallb.adoc @@ -1,5 +1,6 @@ [#components-metallb] = MetalLB +:description: Configure MetalLB to create load balancer services on bare-metal Kubernetes clusters using L2 or BGP mode :revdate: 2025-02-28 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/networking.adoc b/docs/en/components/networking.adoc index be953db1c..162f6ce2e 100644 --- a/docs/en/components/networking.adoc +++ b/docs/en/components/networking.adoc @@ -1,5 +1,6 @@ [#components-nmc] = Edge Networking +:description: Configure Edge Networking using NetworkManager Configurator to set up static IP addresses, VLANs, and other network settings in SUSE Edge environments :revdate: 2025-03-26 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/neuvector.adoc b/docs/en/components/neuvector.adoc index bb7867b5d..70e18c241 100644 --- a/docs/en/components/neuvector.adoc +++ b/docs/en/components/neuvector.adoc @@ -1,5 +1,6 @@ [#components-suse-security] = https://www.suse.com/products/rancher/security/[SUSE Security] +:description: Learn about the components and deployment of SUSE Security, including Manager, Controller, Enforcer, Scanner, and Updater containers :revdate: 2025-01-16 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/rancher-dashboard-extensions.adoc b/docs/en/components/rancher-dashboard-extensions.adoc index 5fc38c4fc..9457ada6d 100644 --- a/docs/en/components/rancher-dashboard-extensions.adoc +++ b/docs/en/components/rancher-dashboard-extensions.adoc @@ -1,5 +1,6 @@ [#components-rancher-dashboard-extensions] = Rancher Dashboard Extensions +:description: Install Rancher Dashboard Extensions using the Rancher UI, Helm, or Fleet to add KubeVirt and Akri management features to the Rancher interface :revdate: 2025-05-15 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/rancher.adoc b/docs/en/components/rancher.adoc index 73266344b..166a628df 100644 --- a/docs/en/components/rancher.adoc +++ b/docs/en/components/rancher.adoc @@ -1,5 +1,6 @@ [#components-rancher] = Rancher +:description: Learn how to manage Kubernetes clusters using Rancher by deploying, monitoring, and securing them across on-premises, cloud, and edge environments :revdate: 2025-06-10 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/rke2.adoc b/docs/en/components/rke2.adoc index f81d588aa..a383a3273 100644 --- a/docs/en/components/rke2.adoc +++ b/docs/en/components/rke2.adoc @@ -1,5 +1,6 @@ [#components-rke2] = RKE2 +:description: Install and configure RKE2 to deploy secure, compliant Kubernetes clusters using SUSE Edge Image Builder and best practices for Edge and IoT :revdate: 2025-05-01 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/suse-multilinux-manager.adoc b/docs/en/components/suse-multilinux-manager.adoc index 7cc5e1e96..3dd06d4e2 100644 --- a/docs/en/components/suse-multilinux-manager.adoc +++ b/docs/en/components/suse-multilinux-manager.adoc @@ -1,5 +1,6 @@ [#components-suma] = SUSE Multi-Linux Manager +:description: Use SUSE Multi-Linux Manager to keep SUSE Linux Micro consistently up-to-date across all nodes in your edge deployment :revdate: 2025-01-28 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/system-upgrade-controller.adoc b/docs/en/components/system-upgrade-controller.adoc index cc76105eb..5fc956e99 100644 --- a/docs/en/components/system-upgrade-controller.adoc +++ b/docs/en/components/system-upgrade-controller.adoc @@ -1,5 +1,6 @@ [#components-system-upgrade-controller] = System Upgrade Controller +:description: Install the System Upgrade Controller using Fleet GitRepo or Bundle resources to manage node upgrades in your cluster :revdate: 2025-02-24 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/turtles.adoc b/docs/en/components/turtles.adoc index 6828f76c0..39e6da67b 100644 --- a/docs/en/components/turtles.adoc +++ b/docs/en/components/turtles.adoc @@ -1,5 +1,6 @@ [#components-rancher-turtles] = Rancher Turtles +:description: Learn how Rancher Turtles integrates Rancher Manager with Cluster API to automatically import and manage Kubernetes clusters :revdate: 2025-04-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/upgrade-controller.adoc b/docs/en/components/upgrade-controller.adoc index 28d7abf2b..3f9743289 100644 --- a/docs/en/components/upgrade-controller.adoc +++ b/docs/en/components/upgrade-controller.adoc @@ -1,5 +1,6 @@ [#components-upgrade-controller] = Upgrade Controller +:description: Upgrade the SUSE Edge platform components using the Upgrade Controller by configuring a single resource that automates the upgrade process for Kubernetes :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/components/virtualization.adoc b/docs/en/components/virtualization.adoc index 52fa79f6f..93d9fad48 100644 --- a/docs/en/components/virtualization.adoc +++ b/docs/en/components/virtualization.adoc @@ -1,5 +1,6 @@ [#components-kubevirt] = Edge Virtualization +:description: Use Edge Virtualization to manage virtual machines on edge nodes with Kubernetes through KubeVirt, including deploying components and using the dashboard :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/concepts/observability.adoc b/docs/en/concepts/observability.adoc index 54810fd92..76a5defc6 100644 --- a/docs/en/concepts/observability.adoc +++ b/docs/en/concepts/observability.adoc @@ -1,5 +1,6 @@ [#concepts-observability] = Observability +:description: Understand observability and how it helps monitor and improve system behavior by providing detailed insights into performance and operational health :revdate: 2024-03-06 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/concepts/terms.adoc b/docs/en/concepts/terms.adoc index 7922aa3d6..78b8c6da8 100644 --- a/docs/en/concepts/terms.adoc +++ b/docs/en/concepts/terms.adoc @@ -1,5 +1,6 @@ [glossary] = Terminology +:description: Understand the terminology used in Kubernetes, including container, cluster, and API, by learning their specific meanings in this space :revdate: 2024-03-06 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/day2/downstream-clusters.adoc b/docs/en/day2/downstream-clusters.adoc index dabe8addf..00af3ee24 100644 --- a/docs/en/day2/downstream-clusters.adoc +++ b/docs/en/day2/downstream-clusters.adoc @@ -1,5 +1,6 @@ [#day2-downstream-clusters] = Downstream clusters +:description: Learn how to perform Day 2 operations for different parts of your downstream cluster using information in this page :revdate: 2025-08-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/day2/fleet-helm-upgrade.adoc b/docs/en/day2/fleet-helm-upgrade.adoc index 88a15db79..cf7545faa 100644 --- a/docs/en/day2/fleet-helm-upgrade.adoc +++ b/docs/en/day2/fleet-helm-upgrade.adoc @@ -1,3 +1,4 @@ +:description: Upgrade a Helm chart in an air-gapped environment by preparing and loading Edge release images and OCI chart artifacts to your private registry [#{cluster-type}-day2-fleet-helm-upgrade] == Helm chart upgrade :revdate: 2025-07-30 diff --git a/docs/en/day2/fleet-k8s-upgrade.adoc b/docs/en/day2/fleet-k8s-upgrade.adoc index dbe752edb..92741a458 100644 --- a/docs/en/day2/fleet-k8s-upgrade.adoc +++ b/docs/en/day2/fleet-k8s-upgrade.adoc @@ -1,3 +1,4 @@ +:description: Upgrade Kubernetes clusters using the System Upgrade Controller and Fleet by following the upgrade process, components, and requirements described in this page [#{cluster-type}-day2-fleet-k8s-upgrade] == Kubernetes version upgrade :revdate: 2025-01-14 diff --git a/docs/en/day2/fleet-os-upgrade.adoc b/docs/en/day2/fleet-os-upgrade.adoc index 768a07531..573d1a533 100644 --- a/docs/en/day2/fleet-os-upgrade.adoc +++ b/docs/en/day2/fleet-os-upgrade.adoc @@ -1,3 +1,4 @@ +:description: Upgrade cluster nodes using Fleet and the System Upgrade Controller by deploying SUC plans that manage package upgrades or OS migrations with specific systemd [#{cluster-type}-day2-fleet-os-upgrade] == OS upgrade :revdate: 2025-05-20 diff --git a/docs/en/day2/fleet.adoc b/docs/en/day2/fleet.adoc index af65ac850..24cd5743e 100644 --- a/docs/en/day2/fleet.adoc +++ b/docs/en/day2/fleet.adoc @@ -1,3 +1,4 @@ +:description: Learn how to perform Day 2 operations using Fleet by understanding its components, custom resources, and upgrade workflows [#{cluster-type}-day2-fleet] == Fleet :revdate: 2025-01-14 diff --git a/docs/en/day2/mgmt-cluster.adoc b/docs/en/day2/mgmt-cluster.adoc index 1e9e2bda2..280956a65 100644 --- a/docs/en/day2/mgmt-cluster.adoc +++ b/docs/en/day2/mgmt-cluster.adoc @@ -1,5 +1,6 @@ [#day2-mgmt-cluster] = Management Cluster +:description: Learn how to perform Day 2 operations on your management cluster using the upgrade controller and fleet tools :revdate: 2025-01-14 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/day2/migration.adoc b/docs/en/day2/migration.adoc index 3124a36d8..94e297fbd 100644 --- a/docs/en/day2/migration.adoc +++ b/docs/en/day2/migration.adoc @@ -1,5 +1,6 @@ [#day2-migration] = Edge 3.3 migration +:description: Migrate your management and downstream clusters from Edge 3.3 using the methods described in this page :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/day2/upgrade-controller.adoc b/docs/en/day2/upgrade-controller.adoc index 120b9f0ad..a6be74e6b 100644 --- a/docs/en/day2/upgrade-controller.adoc +++ b/docs/en/day2/upgrade-controller.adoc @@ -1,3 +1,4 @@ +:description: Upgrade your management cluster using the Upgrade Controller by creating an UpgradePlan that specifies the desired Edge version [#{cluster-type}-day2-upgrade-controller] == Upgrade Controller :revdate: 2025-01-16 diff --git a/docs/en/edge-book/edge.adoc b/docs/en/edge-book/edge.adoc index c9802ad1d..0ce693897 100755 --- a/docs/en/edge-book/edge.adoc +++ b/docs/en/edge-book/edge.adoc @@ -1,4 +1,5 @@ = SUSE Edge Documentation +:description: Find information about SUSE Edge components, how to use them, and how to solve problems with them in the documentation :revdate: 2025-08-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/edge-book/releasenotes.adoc b/docs/en/edge-book/releasenotes.adoc index da05d2ec9..0a6fb0093 100644 --- a/docs/en/edge-book/releasenotes.adoc +++ b/docs/en/edge-book/releasenotes.adoc @@ -1,6 +1,7 @@ [#release-notes] = Abstract +:description: This abstract summarizes the features, use cases, and support lifecycle of SUSE Edge 3.3, including details about its release notes :revdate: 2025-07-15 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/edge-book/version-matrix.adoc b/docs/en/edge-book/version-matrix.adoc index 6e78dd3b3..5effad73e 100644 --- a/docs/en/edge-book/version-matrix.adoc +++ b/docs/en/edge-book/version-matrix.adoc @@ -1,5 +1,6 @@ [#component-version-matrix] = Component Versions +:description: Find the supported versions of each component on this page, including SUSE Linux Micro, Rancher Prime, K3s, RKE2, MetalLB, and other tools listed in the table :revdate: 2025-01-16 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/edge-book/welcome.adoc b/docs/en/edge-book/welcome.adoc index 5fe52cd2d..d63588e3e 100644 --- a/docs/en/edge-book/welcome.adoc +++ b/docs/en/edge-book/welcome.adoc @@ -1,5 +1,6 @@ [#suse-edge-documentation] = SUSE Edge {version-edge} Documentation +:description: Learn about the components, architecture, and management of SUSE Edge to deploy and operate edge computing infrastructure and workloads :revdate: 2025-07-15 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/github_workflow_best_practices.adoc b/docs/en/github_workflow_best_practices.adoc index bdcf76c73..b0c9172f1 100644 --- a/docs/en/github_workflow_best_practices.adoc +++ b/docs/en/github_workflow_best_practices.adoc @@ -1,4 +1,5 @@ = SUSE Edge Engineering GitHub workflow: Best Practices +:description: Learn best practices for using Git and GitHub workflows in the SUSE Edge Engineering teams process, including forking, committing, and creating PRs There are multiple ways to use Git and GitHub workflows, how to create PR/MR, cherry pick commits to a specific branch, etc. diff --git a/docs/en/guides/air-gapped-eib-deployments.adoc b/docs/en/guides/air-gapped-eib-deployments.adoc index 5866a3e8f..89d5bb55f 100644 --- a/docs/en/guides/air-gapped-eib-deployments.adoc +++ b/docs/en/guides/air-gapped-eib-deployments.adoc @@ -1,4 +1,5 @@ = Air-gapped deployments with Edge Image Builder +:description: Create an air-gapped deployment using Edge Image Builder by configuring network settings, preparing a base directory, and defining the image :revdate: 2025-07-08 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/guides/clusterclass.adoc b/docs/en/guides/clusterclass.adoc index e1c6bfee3..09d6bed6c 100644 --- a/docs/en/guides/clusterclass.adoc +++ b/docs/en/guides/clusterclass.adoc @@ -1,5 +1,6 @@ [#guides-clusterclass-example] = Using clusterclass to deploy downstream clusters +:description: Learn how to use ClusterClass to define reusable cluster templates and deploy consistent downstream Kubernetes clusters with CAPI and RKE2 :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/guides/kiwi-builder-images.adoc b/docs/en/guides/kiwi-builder-images.adoc index ca09b0b50..e6d545fb2 100644 --- a/docs/en/guides/kiwi-builder-images.adoc +++ b/docs/en/guides/kiwi-builder-images.adoc @@ -1,5 +1,6 @@ [#guides-kiwi-builder-images] = Building Updated SUSE Linux Micro Images with Kiwi +:description: Build updated SUSE Linux Micro images with Kiwi by using specific image profiles and following the steps outlined in this page :revdate: 2025-03-26 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/guides/metallb-k3s.adoc b/docs/en/guides/metallb-k3s.adoc index ae581c8b3..994e76fe1 100644 --- a/docs/en/guides/metallb-k3s.adoc +++ b/docs/en/guides/metallb-k3s.adoc @@ -1,5 +1,6 @@ [#guides-metallb-k3s] = MetalLB on K3s (using Layer 2 Mode) +:description: Deploy MetalLB on K3s using Layer 2 Mode to configure load balancing for Kubernetes services with standard network equipment and three free IP addresses :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/guides/metallb-kube-api.adoc b/docs/en/guides/metallb-kube-api.adoc index f16f49c25..8bc247e44 100644 --- a/docs/en/guides/metallb-kube-api.adoc +++ b/docs/en/guides/metallb-kube-api.adoc @@ -1,5 +1,6 @@ [#guides-metallb-kubernetes] = MetalLB in front of the Kubernetes API server +:description: Use MetalLB to expose the Kubernetes API server externally by creating a LoadBalancer service and deploying the Endpoint Copier Operator to keep IPs in sync :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/integrations/create-package-obs.adoc b/docs/en/integrations/create-package-obs.adoc index d169e4e9f..d57653758 100644 --- a/docs/en/integrations/create-package-obs.adoc +++ b/docs/en/integrations/create-package-obs.adoc @@ -1,4 +1,5 @@ = Create a package (RPM or Container image) using OBS (openSUSE Build Service) +:description: Create a package using OBS by setting up a project, configuring metadata, and adding files for RPM or container image builds :revdate: 2024-03-06 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/integrations/linkerd.adoc b/docs/en/integrations/linkerd.adoc index a49d59594..4cceb2e5f 100644 --- a/docs/en/integrations/linkerd.adoc +++ b/docs/en/integrations/linkerd.adoc @@ -1,5 +1,6 @@ [#integrations-linkerd] = Linkerd Service Mesh +:description: Learn how Linkerd Service Mesh adds security, observability, and reliability to Kubernetes without extra complexity :revdate: 2024-04-22 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/integrations/nats.adoc b/docs/en/integrations/nats.adoc index a6f6e6379..7619a92a9 100644 --- a/docs/en/integrations/nats.adoc +++ b/docs/en/integrations/nats.adoc @@ -1,5 +1,6 @@ [#integrations-nats] = NATS +:description: Use NATS to send and receive messages between applications across cloud vendors, on-premises, edge, Web, and mobile devices using subject strings for addressing :revdate: 2025-04-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/integrations/nvidia-slemicro.adoc b/docs/en/integrations/nvidia-slemicro.adoc index b7660a229..07a2e8a0b 100644 --- a/docs/en/integrations/nvidia-slemicro.adoc +++ b/docs/en/integrations/nvidia-slemicro.adoc @@ -1,4 +1,5 @@ = NVIDIA GPUs on SUSE Linux Micro +:description: Install NVIDIA open driver and related components on SUSE Linux Micro to enable GPU support for deployment and use with Kubernetes :revdate: 2025-04-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/product/atip-architecture.adoc b/docs/en/product/atip-architecture.adoc index 7f3d84994..1c7fceaeb 100644 --- a/docs/en/product/atip-architecture.adoc +++ b/docs/en/product/atip-architecture.adoc @@ -1,3 +1,4 @@ +:description: Learn how to use the management and runtime stacks in SUSE Telco Cloud to deploy and manage clusters and workloads [#atip-architecture] == Concept & Architecture :revdate: 2025-08-25 diff --git a/docs/en/product/atip-automated-provision.adoc b/docs/en/product/atip-automated-provision.adoc index 451ce71e1..540cf5788 100644 --- a/docs/en/product/atip-automated-provision.adoc +++ b/docs/en/product/atip-automated-provision.adoc @@ -1,3 +1,4 @@ +:description: Learn how to prepare and configure a downstream cluster image for connected scenarios using Edge Image Builder and SUSE Telco Cloud [#atip-automated-provisioning] == Fully automated directed network provisioning :revdate: 2025-08-25 diff --git a/docs/en/product/atip-features.adoc b/docs/en/product/atip-features.adoc index 46e7084e3..fc2d16120 100644 --- a/docs/en/product/atip-features.adoc +++ b/docs/en/product/atip-features.adoc @@ -1,3 +1,4 @@ +:description: Configure Telco-specific features on clusters using directed network provisioning, including real-time kernel settings and CPU isolation [#atip-features] == Telco features configuration :revdate: 2025-08-25 diff --git a/docs/en/product/atip-lifecycle.adoc b/docs/en/product/atip-lifecycle.adoc index f8f764bab..c82ff9e33 100644 --- a/docs/en/product/atip-lifecycle.adoc +++ b/docs/en/product/atip-lifecycle.adoc @@ -1,3 +1,4 @@ +:description: Upgrade the management and downstream clusters by following the procedures for Metal³, operating system, and RKE2 cluster upgrades as described in this page [#atip-lifecycle] == Lifecycle actions :revdate: 2025-08-25 diff --git a/docs/en/product/atip-management-cluster.adoc b/docs/en/product/atip-management-cluster.adoc index 0a2fe6a01..44cac4dde 100644 --- a/docs/en/product/atip-management-cluster.adoc +++ b/docs/en/product/atip-management-cluster.adoc @@ -1,3 +1,4 @@ +:description: Set up the management cluster by preparing image files, defining cluster configurations, and customizing settings for connected or air-gap environments [#atip-management-cluster] == Setting up the management cluster :revdate: 2025-07-31 diff --git a/docs/en/product/atip-requirements.adoc b/docs/en/product/atip-requirements.adoc index dd07a07d6..efd99f36f 100644 --- a/docs/en/product/atip-requirements.adoc +++ b/docs/en/product/atip-requirements.adoc @@ -1,3 +1,4 @@ +:description: Learn the hardware, network, and port requirements for setting up SUSE Telco Cloud management and downstream clusters [#atip-requirements] == Requirements & Assumptions :revdate: 2025-08-25 diff --git a/docs/en/product/atip.adoc b/docs/en/product/atip.adoc index 927fccd00..274e6f603 100644 --- a/docs/en/product/atip.adoc +++ b/docs/en/product/atip.adoc @@ -1,5 +1,6 @@ [#atip] = SUSE Telco Cloud +:description: Learn how SUSE Telco Cloud helps telecom operators and vendors modernize their networks with a complete open source solution :revdate: 2025-08-25 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/quickstart/eib.adoc b/docs/en/quickstart/eib.adoc index 5aa0df37b..38196021f 100644 --- a/docs/en/quickstart/eib.adoc +++ b/docs/en/quickstart/eib.adoc @@ -1,5 +1,6 @@ [#quickstart-eib] = Standalone clusters with Edge Image Builder +:description: Create a customized, ready-to-boot disk image for a standalone cluster using Edge Image Builder by defining configuration options :revdate: 2025-07-31 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/quickstart/elemental.adoc b/docs/en/quickstart/elemental.adoc index ae6ad7648..fbfc852ca 100644 --- a/docs/en/quickstart/elemental.adoc +++ b/docs/en/quickstart/elemental.adoc @@ -1,5 +1,6 @@ [#quickstart-elemental] = Remote host onboarding with Elemental +:description: Learn how to use Elemental to onboard remote hosts into Rancher for centralized management of Kubernetes clusters and applications :revdate: 2025-06-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/quickstart/metal3.adoc b/docs/en/quickstart/metal3.adoc index 98d9b4091..f657ed8c1 100644 --- a/docs/en/quickstart/metal3.adoc +++ b/docs/en/quickstart/metal3.adoc @@ -1,5 +1,6 @@ [#quickstart-metal3] = BMC automated deployments with Metal^3^ +:description: Learn how to use BMC automated deployments with Metal^3^ to manage bare-metal servers using Redfish and Cluster API for infrastructure provisioning :revdate: 2025-07-29 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/quickstart/suse-multilinux-manager.adoc b/docs/en/quickstart/suse-multilinux-manager.adoc index 7341b3ff5..036f718ed 100644 --- a/docs/en/quickstart/suse-multilinux-manager.adoc +++ b/docs/en/quickstart/suse-multilinux-manager.adoc @@ -1,5 +1,6 @@ [#quickstart-suma] = SUSE Multi-Linux Manager +:description: Install and configure SUSE Multi-Linux Manager Server to manage and update SUSE Linux Micro on edge nodes using provided tools and steps :revdate: 2025-05-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/tech_writing_best_practices.adoc b/docs/en/tech_writing_best_practices.adoc index f61dd9984..ba653c863 100644 --- a/docs/en/tech_writing_best_practices.adoc +++ b/docs/en/tech_writing_best_practices.adoc @@ -1,4 +1,5 @@ = Technical Writing: Best Practices +:description: Learn best practices for technical writing by applying clear rules that help you create simple, consistent, and reader-focused documentation :revdate: 2024-03-06 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/tips/eib.adoc b/docs/en/tips/eib.adoc index 40549adfb..955ed6873 100644 --- a/docs/en/tips/eib.adoc +++ b/docs/en/tips/eib.adoc @@ -1,5 +1,6 @@ [#tips-edge-image-builder] = Edge Image Builder +:description: Build Edge Image Builder images for SUSE Linux Micro and Kubernetes clusters by configuring resources, kernel modules, and node settings in the definition file :revdate: 2025-03-26 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/tips/elemental.adoc b/docs/en/tips/elemental.adoc index bb89aa21c..a7fff31d5 100644 --- a/docs/en/tips/elemental.adoc +++ b/docs/en/tips/elemental.adoc @@ -1,5 +1,6 @@ [#tips-elemental] = Elemental +:description: Install and configure Elemental on a management cluster to expose Rancher services using MetalLB and Ingress controllers :revdate: 2025-01-20 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/tips/metal3.adoc b/docs/en/tips/metal3.adoc index 8257fa781..78ab8b523 100644 --- a/docs/en/tips/metal3.adoc +++ b/docs/en/tips/metal3.adoc @@ -1,5 +1,6 @@ [#tips-metal3] = *Metal^3^* +:description: Learn how to configure network settings and manage boot entries for Metal^3^ using specific tools and methods :revdate: 2025-10-07 :revnumber: 3.3 :page-revdate: {revdate} diff --git a/docs/en/troubleshooting/collecting-diagnostics-for-support.adoc b/docs/en/troubleshooting/collecting-diagnostics-for-support.adoc index 233b26bfc..2e3107bd5 100644 --- a/docs/en/troubleshooting/collecting-diagnostics-for-support.adoc +++ b/docs/en/troubleshooting/collecting-diagnostics-for-support.adoc @@ -1,3 +1,4 @@ +:description: Learn how to collect detailed diagnostic information for SUSE Edge environments using logs, system commands, and tools like Nessie [#collecting-diagnostics-for-support] == Collecting Diagnostics for Support :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/general-troubleshooting-principles.adoc b/docs/en/troubleshooting/general-troubleshooting-principles.adoc index 45f6baee5..034eb7e96 100644 --- a/docs/en/troubleshooting/general-troubleshooting-principles.adoc +++ b/docs/en/troubleshooting/general-troubleshooting-principles.adoc @@ -1,3 +1,4 @@ +:description: Learn general troubleshooting principles to check logs, clocks, network settings, component status, and isolate problems in SUSE Edge environments [#general-troubleshooting-principles] == General Troubleshooting Principles :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/troubleshooting-directed-network-provisioning.adoc b/docs/en/troubleshooting/troubleshooting-directed-network-provisioning.adoc index 5cc6dadde..2798e8950 100644 --- a/docs/en/troubleshooting/troubleshooting-directed-network-provisioning.adoc +++ b/docs/en/troubleshooting/troubleshooting-directed-network-provisioning.adoc @@ -1,3 +1,4 @@ +:description: Troubleshoot directed-network provisioning issues by checking firmware, certificates, cluster references, BMC communication, BMH states, and image errors [#troubleshooting-directed-network-provisioning] == Troubleshooting Directed-network provisioning :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/troubleshooting-edge-image-builder.adoc b/docs/en/troubleshooting/troubleshooting-edge-image-builder.adoc index 93fbd4249..076b7452f 100644 --- a/docs/en/troubleshooting/troubleshooting-edge-image-builder.adoc +++ b/docs/en/troubleshooting/troubleshooting-edge-image-builder.adoc @@ -1,3 +1,4 @@ +:description: Check the EIB configuration file for typos or incorrect paths to source files or build scripts when troubleshooting Edge Image Builder issues [#troubleshooting-edge-image-builder] == Troubleshooting Edge Image Builder (EIB) :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/troubleshooting-edge-networking.adoc b/docs/en/troubleshooting/troubleshooting-edge-networking.adoc index 5d1620671..bae9d9931 100644 --- a/docs/en/troubleshooting/troubleshooting-edge-networking.adoc +++ b/docs/en/troubleshooting/troubleshooting-edge-networking.adoc @@ -1,3 +1,4 @@ +:description: Check NMC configuration files, logs, and run nmc manually to find and fix network setup problems during host boot or inspection [#troubleshooting-edge-networking] == Troubleshooting Edge Networking (NMC) :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/troubleshooting-kiwi.adoc b/docs/en/troubleshooting/troubleshooting-kiwi.adoc index 51516d11d..4136da59a 100644 --- a/docs/en/troubleshooting/troubleshooting-kiwi.adoc +++ b/docs/en/troubleshooting/troubleshooting-kiwi.adoc @@ -1,3 +1,4 @@ +:description: Find and fix common problems when using Kiwi to build SUSE Linux Micro images by checking specific errors, logs, and build environment requirements [#troubleshooting-kiwi] == Troubleshooting Kiwi :revdate: 2025-06-17 diff --git a/docs/en/troubleshooting/troubleshooting-other-components.adoc b/docs/en/troubleshooting/troubleshooting-other-components.adoc index 31c625912..fc67010a1 100644 --- a/docs/en/troubleshooting/troubleshooting-other-components.adoc +++ b/docs/en/troubleshooting/troubleshooting-other-components.adoc @@ -1,3 +1,4 @@ +:description: Find troubleshooting guides for other SUSE Edge components in their official documentation or the SUSE Knowledgebase [#troubleshooting-other-components] == Troubleshooting Other components :revdate: 2025-06-19 diff --git a/docs/en/troubleshooting/troubleshooting-phone-home-scenarios.adoc b/docs/en/troubleshooting/troubleshooting-phone-home-scenarios.adoc index 87906d6e6..8473ee160 100644 --- a/docs/en/troubleshooting/troubleshooting-phone-home-scenarios.adoc +++ b/docs/en/troubleshooting/troubleshooting-phone-home-scenarios.adoc @@ -1,3 +1,4 @@ +:description: Troubleshoot Phone-Home scenarios by checking logs, ensuring communication with Rancher, verifying clock sync, and reviewing MachineRegistration [#troubleshooting-phone-home-scenarios] == Troubleshooting Phone-Home scenarios :revdate: 2025-06-17