From fc70b83215cbe8b1df7ae764850ee863c068f705 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Wed, 17 Jun 2026 23:34:02 +0530 Subject: [PATCH 1/3] Replace liche with lychee for link checking Swap appscodelabs/liche (archived, last released 2018) for lycheeverse/lychee v0.24.2 for link checking in CI. Signed-off-by: Tamal Saha --- .github/workflows/ci.yml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f9aa00b..cf8e488 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,9 +22,11 @@ jobs: - name: Install link checker run: | - curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.1.0/liche-linux-amd64 - chmod +x liche - sudo mv liche /usr/local/bin/liche + curl -fsSL -o lychee.tar.gz https://github.com/lycheeverse/lychee/releases/download/lychee-v0.24.2/lychee-x86_64-unknown-linux-gnu.tar.gz + tar -xzf lychee.tar.gz --strip-components=1 + chmod +x lychee + sudo mv lychee /usr/local/bin/lychee + rm lychee.tar.gz - name: Install codespan schema checker run: | @@ -34,7 +36,7 @@ jobs: - name: Check links run: | - liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' + lychee --base $(pwd) --max-concurrency 10 --exclude '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' 'docs/**/*.md' - name: Create Kubernetes cluster id: kind From 55a1b15e749d8a43678c50f69974ad34f97ed999 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Wed, 17 Jun 2026 23:42:48 +0530 Subject: [PATCH 2/3] Fix lychee exclude regex and use --base-url Escape the curly braces in the Hugo-shortcode exclude pattern (the Rust regex engine reads {{ as a repetition quantifier) and switch the deprecated --base flag to --base-url. Signed-off-by: Tamal Saha --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cf8e488..11718e5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -36,7 +36,7 @@ jobs: - name: Check links run: | - lychee --base $(pwd) --max-concurrency 10 --exclude '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' 'docs/**/*.md' + lychee --base-url $(pwd) --max-concurrency 10 --exclude '^(.*/docs/\{\{<.*>\}\}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' 'docs/**/*.md' - name: Create Kubernetes cluster id: kind From 60072cc69b0f42954cc840da1c8be7d5e6b41c17 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Wed, 17 Jun 2026 23:49:42 +0530 Subject: [PATCH 3/3] Resolve relative links per-file and skip example URLs Use lychee --root-dir (the correct equivalent of liche -d) so relative image links resolve against each page, exclude loopback and kubedb.com example URLs, and drop two empty markdown links. Signed-off-by: Tamal Saha --- .github/workflows/ci.yml | 2 +- docs/concepts/crds/backupconfiguration/index.md | 2 +- docs/setup/upgrade/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 11718e5..2ed1a62 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -36,7 +36,7 @@ jobs: - name: Check links run: | - lychee --base-url $(pwd) --max-concurrency 10 --exclude '^(.*/docs/\{\{<.*>\}\}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*)$' 'docs/**/*.md' + lychee --root-dir $(pwd) --max-concurrency 10 --exclude '^(.*/docs/\{\{<.*>\}\}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*|.*helm.sh.*|.*aws.amazon.com.*|.*kind.sigs.k8s.io.*|.*git.k8s.io.*|.*localhost.*|.*kubedb.com.*)$' 'docs/**/*.md' - name: Create Kubernetes cluster id: kind diff --git a/docs/concepts/crds/backupconfiguration/index.md b/docs/concepts/crds/backupconfiguration/index.md index f41d5c3..7beac43 100644 --- a/docs/concepts/crds/backupconfiguration/index.md +++ b/docs/concepts/crds/backupconfiguration/index.md @@ -190,7 +190,7 @@ Scheduler Spec specifies the configuration for the backup triggering CronJob for | `completions` | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info [here](https://kubernetes.io/docs/concepts/workloads/controllers/job/#parallel-jobs) | | `activeDeadlineSeconds` | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. | | `backoffLimit` | Specifies the number of retries before marking this job failed. Defaults to 6. | - | `template` | Describes the pod that will be created when executing a job. To know more about the fields in `template`, see [PodTemplate Spec]() | + | `template` | Describes the pod that will be created when executing a job. To know more about the fields in `template`, see PodTemplate Spec | | `ttlSecondsAfterFinished` | `ttlSecondsAfterFinished` limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, `ttlSecondsAfterFinished` after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. | | `completionMode` | CompletionMode specifies how Pod completions are tracked. More Information can be found [here](https://kubernetes.io/docs/concepts/workloads/controllers/job/#completion-mode) | | `suspend` | Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false. | diff --git a/docs/setup/upgrade/index.md b/docs/setup/upgrade/index.md index e0fce43..5e561ca 100644 --- a/docs/setup/upgrade/index.md +++ b/docs/setup/upgrade/index.md @@ -31,7 +31,7 @@ $ kubectl apply -f https://github.com/kubestash/installer/raw/{{< param "info.ve #### 2. Upgrade Kubestash Operator -Now, upgrade the KubeStash helm chart using the following command. You can find the latest installation guide [here](). +Now, upgrade the KubeStash helm chart using the following command. You can find the latest installation guide here. ```bash helm upgrade kubestash oci://ghcr.io/appscode-charts/kubestash \