chore: Some minor typos in docs

zakisk · zakisk · commit 52d6a16919fc · 2025-07-17T18:04:59.000+05:30
Signed-off-by: Zaki Shaikh &lt;zashaikh@redhat.com&gt;
diff --git a/.vale.ini b/.vale.ini
@@ -32,6 +32,6 @@ RedHat.TermsErrors = NO
 # Styles to load, located in the `StylesPath` folder:
 BasedOnStyles = RedHat, PaaC
 
-# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs.
-TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (\[[^\n]+\])
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs, Hugo-style shortcode relref.
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), (\[[^\n]+\]), \(\{\{<\s*relref\s+\"[^\"]+\"\s*>}}\)
 
diff --git a/.vale/styles/PaaC/Paac.yml b/.vale/styles/PaaC/Paac.yml
@@ -1,11 +1,19 @@
 extends: substitution
 message: Use '%s' instead of '%s'
 level: error
-scope: text
+scope: summary
 nonword: false
 swap:
   "Pipeline as Code": Pipelines-as-Code
   "Pipelines as Code": Pipelines-as-Code
   "Pipeline-as-Code": Pipelines-as-Code
   "GitOPS": GitOps
   "globing": globbing
+  "pipeline run": PipelineRun
+  pipelinerun: PipelineRun
+  pipelineRun: PipelineRun
+  Pipelinerun: PipelineRun
+  "pipeline runs": PipelineRuns
+  pipelineruns: PipelineRuns
+  pipelineRuns: PipelineRuns
+  Pipelineruns: PipelineRuns
diff --git a/docs/content/docs/blog/release-osp-1.15.md b/docs/content/docs/blog/release-osp-1.15.md
@@ -9,16 +9,16 @@ OpenShift Pipelines 1.15 presents several new enhancements to Pipelines-as-Code.
 These commands allow you to make quick comments on a pull request to restart a
 PipelineRun through Pipelines-as-Code.
 
-Commonly used commands include `/test` pipelinerun to rerun a specific
-pipelinerun, or `/retest` to rerun all PipelineRuns.
+Commonly used commands include `/test pipelinerun` to rerun a specific
+PipelineRun, or `/retest` to rerun all PipelineRuns.
 
 ### Trigger PipelineRuns Irrespective of Annotations
 
 Previously, to re-trigger PipelineRuns, they had to match specific annotations
 such as `pipelinesascode.tekton.dev/on-event` set to pull_request. Now, this
 constraint is removed, allowing you to trigger any PipelineRuns with `/test`
 regardless of their annotation status. This is particularly useful if you need
-to run a pipelinerun selectively before merging a PR, without it automatically
+to run a PipelineRun selectively before merging a PR, without it automatically
 consuming resources with each update.
 
 ### Modify Parameters Dynamically via GitOps Commands
diff --git a/docs/content/docs/guide/cli.md b/docs/content/docs/guide/cli.md
@@ -11,11 +11,11 @@ Pipelines-as-Code provides a powerful CLI designed to work as a plug-in to the [
 * `bootstrap`: quickly bootstrap a Pipelines-as-Code installation.
 * `create`: create a new Pipelines-as-Code Repository definition.
 * `delete`: delete an existing Pipelines-as-Code Repository definition.
-* `generate`: generate a simple pipelinerun to get you started with Pipelines-as-Code.
+* `generate`: generate a simple PipelineRun to get you started with Pipelines-as-Code.
 * `list`: list Pipelines-as-Code Repositories.
 * `logs`: show the logs of a PipelineRun from a Repository CRD.
 * `describe`: describe a Pipelines-as-Code Repository and the runs associated with it.
-* `resolve`: Resolve a pipelinerun as if it were executed by pipelines as code on service.
+* `resolve`: Resolve a PipelineRun as if it were executed by pipelines as code on service.
 * `webhook`: Updates webhook secret.
 * `info`: Show information (currently only about your installation with `info install`).
 
@@ -150,7 +150,7 @@ GitHub application and the secret with all the information needed in the
 ### Repository Creation
 
 `tkn pac create repo` -- Creates a new Pipelines-as-Code `Repository` custom resource definition,
-With a Git repository to execute pipelineruns based on Git events. It
+With a Git repository to execute PipelineRuns based on Git events. It
 will also generate a sample file with a [PipelineRun](/docs/guide/authoringprs)
 in the `.tekton` directory called `pipelinerun.yaml` targeting the `main` branch
 and the `pull_request` and `push` events. You can customize this by editing the
@@ -192,7 +192,7 @@ On modern terminals (ie: OSX Terminal, [iTerm2](https://iterm2.com/), [Windows
 Terminal](https://github.com/microsoft/terminal), GNOME-terminal, kitty, and so
 on...) the links become clickable with control+click or ⌘+click (see the
 documentation of your terminal for more details) and will open the browser
-to the console/dashboard URL to see the details of the Pipelinerun associated
+to the console/dashboard URL to see the details of the PipelineRun associated
 with it.
 
 {{< /details >}}
@@ -218,7 +218,7 @@ On modern terminals (ie: OSX Terminal, [iTerm2](https://iterm2.com/), [Windows
 Terminal](https://github.com/microsoft/terminal), GNOME-terminal, kitty, and so
 on...) the links become clickable with control+click or ⌘+click (see the
 documentation of your terminal for more details) and will open the browser
-to the console/dashboard URL to see the details of the Pipelinerun associated
+to the console/dashboard URL to see the details of the PipelineRun associated
 with it.
 
 {{< /details >}}
@@ -245,24 +245,24 @@ the logs.
 
 ### Generate
 
-`tkn pac generate`: will generate a simple pipelinerun to get you started with
+`tkn pac generate`: will generate a simple PipelineRun to get you started with
 Pipelines-as-Code. It will try to be as smart as possible by detecting the
 current Git information if you run the command from your source code.
 
 It has some basic language detection and adds extra tasks depending on the
 language. For example, if it detects a file named `setup.py` at the repository
 root it will add the [pylint task](https://hub.tekton.dev/tekton/task/pylint) to
-the generated pipelinerun.
+the generated PipelineRun.
 {{< /details >}}
 
 {{< details "tkn pac resolve" >}}
 
 ### Resolve
 
-`tkn-pac resolve`: will run a pipelinerun as if it were executed by pipelines
+`tkn-pac resolve`: will run a PipelineRun as if it were executed by pipelines
 as code on service.
 
-For example, if you have a pipelinerun in the `.tekton/pull-request.yaml` file
+For example, if you have a PipelineRun in the `.tekton/pull-request.yaml` file
 you can run the command `tkn-pac resolve` to see it running:
 
 ```yaml
diff --git a/docs/content/docs/guide/gitops_commands.md b/docs/content/docs/guide/gitops_commands.md
@@ -41,12 +41,12 @@ Please be aware that GitOps commands such as `/test` and others will not functio
 
 If you want to trigger a GitOps command on a pushed commit, you can include the `GitOps` comments within your commit messages. These comments can be used to restart either all pipelines or specific ones. Here's how it works:
 
-For restarting all pipeline runs:
+For restarting all PipelineRuns:
 
 1. Use `/retest` or `/test` within your commit message.
 
-For restarting a specific pipeline run:
-2. Use `/retest <pipelinerun-name>` or `/test <pipelinerun-name>` within your commit message. Replace `<pipelinerun-name>` with the specific name of the pipeline run you want to restart.
+For restarting a specific PipelineRun:
+2. Use `/retest <pipelinerun-name>` or `/test <pipelinerun-name>` within your commit message. Replace `<pipelinerun-name>` with the specific name of the PipelineRun you want to restart.
 
 The GitOps command triggers a PipelineRun only on the latest commit (HEAD) of the branch and does not work on older commits.
 
diff --git a/docs/content/docs/guide/incoming_webhook.md b/docs/content/docs/guide/incoming_webhook.md
@@ -15,7 +15,7 @@ To use incoming webhooks in Pipelines-as-Code, you must configure the
 incoming field in your Repository CRD. This field references a `Secret`, which
 serves as the shared secret, as well as the branches targeted by the incoming
 webhook. Once configured, Pipelines-as-Code will match `PipelineRuns` located in
-your `.tekton` directory if the `on-event` annotation of the targeted pipelinerun is
+your `.tekton` directory if the `on-event` annotation of the targeted PipelineRun is
 targeting a push or incoming event.
 
 {{< hint info >}}
diff --git a/docs/content/docs/guide/matchingevents.md b/docs/content/docs/guide/matchingevents.md
@@ -283,7 +283,7 @@ If you need to do some advanced matching, `Pipelines-as-Code` supports CEL
 expressions to do advanced filtering on the specific event you need to be matched.
 
 {{< hint danger >}}
-If you use the `on-cel-expression` annotation in the same pipeline run as an `on-event`, `on-target-branch`, `on-label`, `on-path-change`, or `on-path-change-ignore`
+If you use the `on-cel-expression` annotation in the same PipelineRun as an `on-event`, `on-target-branch`, `on-label`, `on-path-change`, or `on-path-change-ignore`
 annotation, the `on-cel-expression` annotation takes priority and Pipelines-as-Code ignores the other annotations.
 {{< /hint >}}
 
diff --git a/docs/content/docs/guide/repositorycrd.md b/docs/content/docs/guide/repositorycrd.md
@@ -26,8 +26,8 @@ You can create the Repository CR using the [tkn pac]({{< relref
 "/docs/guide/cli.md" >}}) CLI and its `tkn pac create repository` command or by
 applying a YAML file with kubectl:
 
-```yaml
-cat <<EOF|kubectl create -n project-repository -f-
+```bash
+cat <<EOF | kubectl create -n project-repository -f-
 apiVersion: "pipelinesascode.tekton.dev/v1alpha1"
 kind: Repository
 metadata:
@@ -121,7 +121,7 @@ right to merge commits to the default branch can change the PipelineRun and have
 access to the infrastructure.
 {{< /hint >}}
 
-## Disabling all comments for Pipelineruns on GitLab MR
+## Disabling all comments for PipelineRuns on GitLab MR
 
 `comment_strategy` allows you to disable the comments on GitLab MR for a Repository
 
@@ -132,9 +132,9 @@ spec:
       comment_strategy: "disable_all"
 ```
 
-When you set the value of `comment_strategy` to `disable_all` it will not add any comment on the merge request for the start and the end of pipelinerun
+When you set the value of `comment_strategy` to `disable_all` it will not add any comment on the merge request for the start and the end of PipelineRun
 
-## Disabling all comments for Pipelineruns in GitHub Pull Requests on GitHub Webhook Setup
+## Disabling all comments for PipelineRuns in GitHub Pull Requests on GitHub Webhook Setup
 
 `comment_strategy` allows you to disable the comments on GitHub PR for a Repository
 
@@ -163,10 +163,10 @@ When multiple PipelineRuns match the event, they will be started in alphabetical
 
 Example:
 
-If you have three pipelineruns in a .tekton directory, and you create a pull
+If you have three PipelineRuns in a .tekton directory, and you create a pull
 request with a `concurrency_limit` of 1 in the repository configuration, then all
-of the pipelineruns will be executed in alphabetical order, one after the
-other. At any given time, only one pipeline run will be in the running state,
+of the PipelineRuns will be executed in alphabetical order, one after the
+other. At any given time, only one PipelineRun will be in the running state,
 while the rest will be queued.
 
 ### Kueue - Kubernetes-native Job Queueing
diff --git a/docs/content/docs/guide/resolver.md b/docs/content/docs/guide/resolver.md
@@ -43,7 +43,7 @@ The resolver will skip resolving if it sees these type of tasks:
 It just uses them "as is" and will not try to do anything with it.
 
 If Pipelines-as-Code cannot resolve the referenced tasks in the `Pipeline` or
-`PipelineSpec`, the run will fail before applying the pipelinerun onto the
+`PipelineSpec`, the run will fail before applying the PipelineRun onto the
 cluster.
 
 You should be able to see the issue on your Git provider platform interface and
diff --git a/docs/content/docs/guide/running.md b/docs/content/docs/guide/running.md
@@ -109,7 +109,7 @@ pac](../cli/#install) CLI :
 tkn pac logs -n my-pipeline-ci -L
 ```
 
-If you need to show another pipelinerun than the last one you can use the `tkn
+If you need to show another PipelineRun than the last one you can use the `tkn
 pac` logs command and it will ask you to select a PipelineRun attached to the
 repository :
 
diff --git a/docs/content/docs/guide/statuses.md b/docs/content/docs/guide/statuses.md
@@ -121,17 +121,17 @@ well as their metadata.
 
 Notifications are not managed by Pipelines-as-Code.
 
-To add notifications to your pipeline runs, you can use the [finally feature of
+To add notifications to your PipelineRuns, you can use the [finally feature of
 Tekton
 Pipelines](https://github.com/tektoncd/pipeline/blob/main/docs/pipelines.md#adding-finally-to-the-pipeline).
 This allows you to execute a set of tasks at the end of a
-pipeline run, regardless of whether it succeeds or fails.
+PipelineRun, regardless of whether it succeeds or fails.
 
 As an example, you can [refer](https://github.com/openshift-pipelines/pipelines-as-code/blob/16596b478f4bce202f9f69de9a4b5a7ca92962c1/.tekton/generate-coverage-release.yaml#L127) to the coverage generation PipelineRun in the
 `.tekton` directory of the Pipelines-as-Code repository, it uses the [finally
 task with the guard
 feature](https://tekton.dev/docs/pipelines/pipelines/#guard-finally-task-execution-using-when-expressions)
-to send a notification to Slack if there is any failure in the pipelinerun. See
+to send a notification to Slack if there is any failure in the PipelineRun. See
 it in action here:
 
 <https://github.com/openshift-pipelines/pipelines-as-code/blob/16596b478f4bce202f9f69de9a4b5a7ca92962c1/.tekton/generate-coverage-release.yaml#L126>
diff --git a/docs/content/docs/install/settings.md b/docs/content/docs/install/settings.md
@@ -11,7 +11,7 @@ There is a few things you can configure through the config map
 * `application-name`
 
   The name of the application for example when showing the results of the
-  pipelinerun. If you're using the GitHub App you will
+  PipelineRun. If you're using the GitHub App you will
   need to customize the label on the github app setting as well. .  Default to
   `Pipelines-as-Code CI`
 
@@ -60,7 +60,7 @@ There is a few things you can configure through the config map
 
 * `remote-tasks`
 
-  This allows fetching remote tasks on pipelinerun annotations. This feature is
+  This allows fetching remote tasks on PipelineRun annotations. This feature is
   enabled by default.
 
 * `bitbucket-cloud-check-source-ip`
@@ -85,14 +85,14 @@ There is a few things you can configure through the config map
 * `max-keep-run-upper-limit`
 
   This let the user define a max limit for the max-keep-run value. When the user
-  has defined a max-keep-run annotation on a pipelineRun then its value should
+  has defined a max-keep-run annotation on a PipelineRun then its value should
   be less than or equal to the upper limit, otherwise upper limit will be used
   for cleanup.
 
 * `default-max-keep-runs`
 
   This let the user define a default limit for the `max-keep-run` value.
-  When defined it will applied to all the pipelineRun without a `max-keep-runs`
+  When defined it will applied to all the PipelineRun without a `max-keep-runs`
   annotation.
 
 * `auto-configure-new-github-repo`
@@ -141,11 +141,11 @@ There is a few things you can configure through the config map
 
 * `skip-push-event-for-pr-commits`
 
-  When enabled, this option prevents duplicate pipeline runs when a commit appears in
+  When enabled, this option prevents duplicate PipelineRuns when a commit appears in
   both a push event and a pull request. If a push event comes from a commit that is
   part of an open pull request, the push event will be skipped as it would create
-  a duplicate pipeline run.
-
+  a duplicate PipelineRun.
+  
   This feature works by checking if a pushed commit SHA exists in any open pull request,
   and if so, skipping the push event processing.
 
@@ -225,7 +225,7 @@ A few settings are available to configure this feature:
   Enable or disable the feature to show a log snippet of the failed task when
   there is an error in a PipelineRun.
 
-  Due of the constraint of the different GIT provider API, It will show the last
+  Due to the constraints of the different GIT provider APIs, it will show the last
   3 lines of the first container from the first task that has exited with an
   error in the PipelineRun.
 
@@ -300,25 +300,25 @@ A few settings are available to configure this feature:
 
   Set this to the URL where to view the details of the `Namespace`.
 
-  The URL supports all the standard variables as exposed on the Pipelinerun (refer to
+  The URL supports all the standard variables as exposed on the PipelineRun (refer to
   the documentation on [Authoring PipelineRuns](../authoringprs)) with the added
   variable:
 
-  * `{{ namespace }}`: The target namespace where the pipelinerun is executed
+  * `{{ namespace }}`: The target namespace where the PipelineRun is executed
 
   example: `https://mycorp.com/ns/{{ namespace }}`
 
 * `custom-console-url-pr-details`
 
   Set this to the URL where to view the details of the `PipelineRun`. This is
   shown when the PipelineRun is started so the user can follow execution on your
-  console or when to see more details about the pipelinerun on result.
+  console or when to see more details about the PipelineRun on result.
 
-  The URL supports all the standard variables as exposed on the Pipelinerun (refer to
+  The URL supports all the standard variables as exposed on the PipelineRun (refer to
   the documentation on [Authoring PipelineRuns](../authoringprs)) with the added
   variable:
 
-  * `{{ namespace }}`: The target namespace where the pipelinerun is executed
+  * `{{ namespace }}`: The target namespace where the PipelineRun is executed
   * `{{ pr }}`: The PipelineRun name.
 
   example: `https://mycorp.com/ns/{{ namespace }}/pipelinerun/{{ pr }}`
@@ -340,7 +340,7 @@ A few settings are available to configure this feature:
 
   the `{{ custom }}` tag in the URL is expanded as `value`.
 
-  This let operator to add specific information like a `UUID` about a user as
+  This lets operators add specific information such as a `UUID` about a user as
   parameter in their repo CR and let it link to the console.
 
 * `custom-console-url-pr-tasklog`
@@ -352,7 +352,7 @@ A few settings are available to configure this feature:
   described in the `custom-console-url-pr-details` setting and as well those added
   values:
 
-  * `{{ namespace }}`: The target namespace where the pipelinerun is executed
+  * `{{ namespace }}`: The target namespace where the PipelineRun is executed
   * `{{ pr }}`: The PipelineRun name.
   * `{{ task }}`: The Task name in the PR
   * `{{ pod }}`: The Pod name of the TaskRun
