📚 Sync documentation from source-docs

Source: docs(pipeline): add pod templates concept (#184)
Author: l-qing
Commit: aec65baa5514a947431ed9ee8df16a610bf455e6

This commit automatically syncs documentation changes from the source-docs repository.

🔗 View source commit: https://github.com/alaudadevops/tektoncd-operator/commit/aec65baa5514a947431ed9ee8df16a610bf455e6
🤖 Synced on 2025-06-30 06:36:42 UTC

Author: web-flow

.github/SYNC_INFO.md

@@ -0,0 +1,16 @@
+# Documentation Sync Information
+
+- **Last synced**: 2025-06-30 06:36:42 UTC
+- **Source repository**: alaudadevops/tektoncd-operator
+- **Source commit**: [aec65baa5514a947431ed9ee8df16a610bf455e6](https://github.com/alaudadevops/tektoncd-operator/commit/aec65baa5514a947431ed9ee8df16a610bf455e6)
+- **Triggered by**: l-qing
+- **Workflow run**: [#1](https://github.com/alaudadevops/tektoncd-operator/actions/runs/15965701172)
+
+## Files synced:
+- docs/
+- .yarn/
+- doom.config.yml
+- yarn.lock
+- tsconfig.json
+- package.json
+- sites.yaml

docs/en/install.mdx

@@ -6,7 +6,7 @@ weight: 240
 
 ## Installing Alauda DevOps Pipelines
 
-This guide provides cluster administrators with the process to install the Alauda DevOps Pipelines Operator on a Kubernetes cluster.
+This guide provides cluster administrators with the process to install the `Alauda DevOps Pipelines` Operator on a Kubernetes cluster.
 
 Prerequisites:
 
@@ -16,13 +16,13 @@ Prerequisites:
 
 ### Installing Alauda DevOps Pipelines Using the Web Console
 
-You can install the Alauda DevOps Pipelines Operator by using the Operators listed in the Marketplace or OperatorHub. When you install the Alauda DevOps Pipelines Operator, the required Custom Resources (CRs) are automatically installed alongside the Operator.
+You can install the `Alauda DevOps Pipelines` Operator by using the Operators listed in the Marketplace or OperatorHub. When you install the `Alauda DevOps Pipelines` Operator, the required Custom Resources (CRs) are automatically installed alongside the Operator.
 
 The Operator provides the following Custom Resource Definitions (CRDs) to manage the Tekton components: `tektonconfigs.operator.tekton.dev`, `tektonpipelines.operator.tekton.dev`, `tektontriggers.operator.tekton.dev`, `tektonhubs.operator.tekton.dev`, and more.
 
 If Tekton Pipelines is already installed on your cluster, the existing installation will be seamlessly upgraded by the Operator.
 
-The Alauda DevOps Pipelines Operator provides the option to select which components to install by specifying a preset configuration in the `TektonConfig` Custom Resource (CR). The `TektonConfig` CR is automatically installed when the Operator is installed. Supported presets include:
+The `Alauda DevOps Pipelines` Operator provides the option to select which components to install by specifying a preset configuration in the `TektonConfig` Custom Resource (CR). The `TektonConfig` CR is automatically installed when the Operator is installed. Supported presets include:
 
 - **Lite**: Installs only Tekton Pipelines.
 - **Basic**: Installs Tekton Pipelines and Tekton Triggers.
@@ -32,9 +32,9 @@ The Alauda DevOps Pipelines Operator provides the option to select which compone
 
 - In the Web console, navigate to **Marketplace** or **OperatorHub**.
 
-- Use the **Filter by keyword** box to search for `Alauda DevOps Pipelines Operator` in the directory. Click on the **Alauda DevOps Pipelines Operator** title.
+- Use the **Filter by keyword** box to search for `Alauda DevOps Pipelines` Operator in the directory. Click on the **`Alauda DevOps Pipelines` Operator** title.
 
-- Read the Operator overview on the **Alauda DevOps Pipelines Operator** page. Click **Install**.
+- Read the Operator overview on the **`Alauda DevOps Pipelines` Operator** page. Click **Install**.
 
 - On the **Install Operator** page:
 
@@ -44,9 +44,9 @@ The Alauda DevOps Pipelines Operator provides the option to select which compone
 
 - Click **Install**. You will see the Operator on the Installed Operators page.
 
-- Verify that the **Status** is set to **Succeeded** to confirm the successful installation of the Alauda DevOps Pipelines Operator.
+- Verify that the **Status** is set to **Succeeded** to confirm the successful installation of the `Alauda DevOps Pipelines` Operator.
 
-- Verify that all components of the Alauda DevOps Pipelines Operator have been successfully installed. Log in to the cluster in a terminal and run the following command:
+- Verify that all components of the `Alauda DevOps Pipelines` Operator have been successfully installed. Log in to the cluster in a terminal and run the following command:
 
   ```bash
   $ kubectl get tektonconfig config
@@ -85,11 +85,11 @@ The Alauda DevOps Pipelines Operator provides the option to select which compone
 
 ### Installing Alauda DevOps Pipelines Using CLI
 
-You can install the Alauda DevOps Pipelines Operator from the OperatorHub using the Command Line Interface (CLI).
+You can install the `Alauda DevOps Pipelines` Operator from the OperatorHub using the Command Line Interface (CLI).
 
 **Steps**
 
-- Create a `Subscription` object YAML file to subscribe a namespace to the Alauda DevOps Pipelines Operator, for example, `sub.yaml`:
+- Create a `Subscription` object YAML file to subscribe a namespace to the `Alauda DevOps Pipelines` Operator, for example, `sub.yaml`:
 
 **Example `Subscription` YAML**
 
@@ -107,7 +107,7 @@ spec:
 ```
 
 <Callouts>
-  1. The channel name you want to subscribe to. The `latest` channel allows for the installation of the latest stable version of the Alauda DevOps Pipelines Operator.
+  1. The channel name you want to subscribe to. The `latest` channel allows for the installation of the latest stable version of the `Alauda DevOps Pipelines` Operator.
   2. The name of the Operator to subscribe to.
   3. The name of the `CatalogSource` object providing the Operator.
   4. The namespace of the `CatalogSource` object. This may vary depending on your cluster configuration.
@@ -119,14 +119,14 @@ spec:
   $ kubectl apply -f sub.yaml
   ```
 
-  The subscription will install the Alauda DevOps Pipelines Operator in the `tekton-operator` namespace. The Operator will automatically install Tekton components in the default target namespace `tekton-pipelines`.
+  The subscription will install the `Alauda DevOps Pipelines` Operator in the `tekton-operator` namespace. The Operator will automatically install Tekton components in the default target namespace `tekton-pipelines`.
 
 ## Uninstalling Alauda DevOps Pipelines
 
-Cluster administrators can uninstall the Alauda DevOps Pipelines Operator by performing the following steps:
+Cluster administrators can uninstall the `Alauda DevOps Pipelines` Operator by performing the following steps:
 
 - Delete any optional component CRs if they exist, and then delete the `TektonConfig` CR.
-- Uninstall the Alauda DevOps Pipelines Operator.
+- Uninstall the `Alauda DevOps Pipelines` Operator.
 - Delete the Custom Resource Definitions (CRDs) for the `operator.tekton.dev` group if needed.
 
 Simply uninstalling the Operator will not remove the Alauda DevOps Pipelines components created by default during the installation of the Operator.
@@ -142,18 +142,20 @@ First, delete the `TektonConfig` CR and any other Tekton component CRs if they e
 - Click on the `TektonConfig` CRD to display the detailed page.
 - Click the **Instances** tab.
 - If an instance is displayed, click the `Options` menu of the displayed instance.
-- Select **Delete TektonConfig**.
+- Select **Delete**.
 - Click **Delete** to confirm the deletion of the CR.
+  - Deleting the `TektonConfig` resource will cascade delete the automatically created `TektonPipelines`, `TektonTriggers`, `TektonHubs`, `TektonChains`, etc. components.
 - Repeat these steps for any other Tekton component CRs that may exist.
+  - If you manually created `TektonResults` or `OpenShiftPipelinesAsCodes`, you may need to manually delete it.
 
-### Uninstalling the Alauda DevOps Pipelines Operator
+### Uninstalling the `Alauda DevOps Pipelines` Operator
 
-You can uninstall the Alauda DevOps Pipelines Operator using the Web console.
+You can uninstall the `Alauda DevOps Pipelines` Operator using the Web console.
 
 **Steps**
 
 - From the **Marketplace** or **OperatorHub** page, navigate to **Installed Operators**.
-- Find the Alauda DevOps Pipelines Operator in the list.
+- Find the `Alauda DevOps Pipelines` Operator in the list.
 - Click the **Options** menu and select **Uninstall Operator**.
 - In the **Uninstall Operator?** window, select **Delete all operand instances for this operator**, then click **Uninstall**.
 
@@ -182,7 +184,7 @@ In Alauda DevOps Pipelines, you can customize the following configurations using
 
 ### Prerequisites
 
-The Alauda DevOps Pipelines Operator must be installed.
+The `Alauda DevOps Pipelines` Operator must be installed.
 
 ### Tuning Performance with TektonConfig CR
 
@@ -207,7 +209,7 @@ spec:
       statefulset-ordinals: false
 ```
 
-All fields are optional. When set, the Alauda DevOps Pipelines Operator includes most fields as parameters in the `tekton-pipelines-controller` deployment under the `tekton-pipelines-controller` container. The Operator also updates the `bucket` field in the `config-leader-election` ConfigMap under the `tekton-pipelines` namespace.
+All fields are optional. When set, the `Alauda DevOps Pipelines` Operator includes most fields as parameters in the `tekton-pipelines-controller` deployment under the `tekton-pipelines-controller` container. The Operator also updates the `bucket` field in the `config-leader-election` ConfigMap under the `tekton-pipelines` namespace.
 
 If no values are specified, the Operator does not update these fields and applies the default values of the Tekton Pipelines controller.
 
@@ -233,7 +235,7 @@ HA mode does not affect tasks that run after the pod is created.
 
 ### Configuring Tekton Pipelines Control Plane
 
-You can customize the Tekton Pipelines control plane by editing the configuration fields in the `TektonConfig` Custom Resource (CR). The Alauda DevOps Pipelines Operator automatically includes default values for the configuration fields so you can use the Tekton Pipelines control plane.
+You can customize the Tekton Pipelines control plane by editing the configuration fields in the `TektonConfig` Custom Resource (CR). The `Alauda DevOps Pipelines` Operator automatically includes default values for the configuration fields so you can use the Tekton Pipelines control plane.
 
 **Process**
 
@@ -322,7 +324,7 @@ spec:
 
 ## Next Steps
 
-After successfully installing the Alauda DevOps Pipelines Operator:
+After successfully installing the `Alauda DevOps Pipelines` Operator:
 
 - [Adjusting Optional Configuration Items of Subcomponents](../configure/customize_options)
 - [Configuring Resource Quotas for Pipeline Components](../configure/customize_tekton_pipeline)

docs/en/overview/intro.mdx

@@ -11,13 +11,13 @@ i18n:
 
 Tekton is a powerful and flexible open-source framework for creating CI/CD systems, allowing developers to build, test, and deploy across cloud providers and on-premise systems. As part of the CD Foundation, a Linux Foundation project, Tekton provides a set of Kubernetes custom resources that serve as building blocks for creating cloud-native CI/CD pipelines.
 
-The Alauda DevOps Pipelines Operator provides a simplified way to install, upgrade, and manage the lifecycle of Tekton components on Kubernetes clusters. It extends Kubernetes functionality by installing and managing Tekton Pipelines and its associated components, making it easier to set up and maintain a robust CI/CD environment.
+The `Alauda DevOps Pipelines` Operator provides a simplified way to install, upgrade, and manage the lifecycle of Tekton components on Kubernetes clusters. It extends Kubernetes functionality by installing and managing Tekton Pipelines and its associated components, making it easier to set up and maintain a robust CI/CD environment.
 
 ## Key Components
 
-### Alauda DevOps Pipelines Operator
+### `Alauda DevOps Pipelines` Operator
 
-The Alauda DevOps Pipelines Operator is a Kubernetes operator that manages the lifecycle of Tekton components. It provides:
+The `Alauda DevOps Pipelines` Operator is a Kubernetes operator that manages the lifecycle of Tekton components. It provides:
 
 - Simplified installation and management of Tekton components
 - Automatic upgrades and configuration management
@@ -93,4 +93,4 @@ Tekton Results addresses the challenge of long-term storage and querying of CI/C
 - **Complexity for Simple Workflows**: May be overly complex for very simple CI/CD needs
 - **Initial Setup**: Requires proper configuration and setup of multiple components
 
-The Alauda DevOps Pipelines Operator simplifies many of these challenges by providing an integrated and managed experience for Tekton on Kubernetes clusters.
+The `Alauda DevOps Pipelines` Operator simplifies many of these challenges by providing an integrated and managed experience for Tekton on Kubernetes clusters.

docs/en/overview/quick_start.mdx

@@ -59,13 +59,37 @@ After installing the Tekton Operator, you should verify that it's running proper
 1. Check that the Operator pods are running:
 
   ```bash
-  kubectl get pods -n tekton-operator
+  $ kubectl get pods -n tekton-operator
+  ```
+
+  The results should be similar to the following:
+
+  ```bash
+  NAME                                       READY   STATUS    RESTARTS   AGE
+  tekton-operator-57cfd5bb79-dnxzt           2/2     Running   0          10m
+  tekton-operator-webhook-6fb66bfd65-ppfz8   1/1     Running   0          10m
   ```
 
 2. Verify the Operator CRDs (Custom Resource Definitions) are installed:
 
   ```bash
-  kubectl get crds | grep tekton
+  $ kubectl get crds | grep operator.tekton.dev
+  ```
+
+  The results should be similar to the following:
+
+  ```bash
+  tektonaddons.operator.tekton.dev                2025-06-20T09:47:38Z
+  tektonchains.operator.tekton.dev                2025-06-20T09:47:38Z
+  tektonconfigs.operator.tekton.dev               2025-06-20T09:47:38Z
+  tektondashboards.operator.tekton.dev            2025-06-20T09:47:38Z
+  tektonhubs.operator.tekton.dev                  2025-06-20T09:47:38Z
+  tektoninstallersets.operator.tekton.dev         2025-06-20T09:47:38Z
+  tektonpipelines.operator.tekton.dev             2025-06-20T09:47:39Z
+  tektonresults.operator.tekton.dev               2025-06-20T09:47:39Z
+  tektontriggers.operator.tekton.dev              2025-06-20T09:47:39Z
+  manualapprovalgates.operator.tekton.dev         2025-06-20T09:47:38Z
+  openshiftpipelinesascodes.operator.tekton.dev   2025-06-20T09:47:38Z
   ```
 
 ### Install Tekton Components
@@ -82,7 +106,7 @@ After installing the Tekton components, you should verify that they are running
 1. Check the TektonConfig resource:
 
   ```bash
-  kubectl get tektonconfig config
+  $ kubectl get tektonconfig config
   ```
 
   The results should be similar to the following:
@@ -120,10 +144,10 @@ After installing the Tekton components, you should verify that they are running
 
 ### Expected Results
 
-After completing all steps, you should have:
+After completing all steps, the `TektonConfig` and `TektonInstallerSet` resources should be ready, you should have:
 
 - A running Tekton Operator in the `tekton-operator` namespace
-- One or more installed Tekton components (Pipeline, Triggers, Hub) in the `tekton-pipelines` namespace
+- One or more installed Tekton components (Pipeline, Triggers, Hub, Chains) in the `tekton-pipelines` namespace
 - Custom Resource Definitions (CRDs) for managing Tekton resources
 
 ## Next Steps