feat: add prek as precommit#92
Merged
Merged
Conversation
✅ Deploy Preview for docs-projectcapsule ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces prek-based local hooks to mirror parts of CI behavior (link checking and API reference freshness checks), and updates documentation content to satisfy new linting/formatting constraints.
Changes:
- Add
prek.tomlwith commit-stage content linting plus pre-push hooks forlycheeand API docs freshness. - Add helper scripts for
lycheesetup/cleanup and API docs regeneration + diff checking. - Normalize whitespace/formatting across many Markdown docs and add missing Hugo
_index.mdfront-matter for docs sections.
Reviewed changes
Copilot reviewed 18 out of 44 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/lychee.sh | Pre-push wrapper to mirror CI image handling before running lychee. |
| scripts/apidocs-check.sh | Pre-push script to regenerate API docs and fail when reference.md files differ. |
| prek.toml | Adds prek hook configuration (content linting on commit; lychee + apidocs check on push). |
| DEVELOPMENT.md | Documents installing/using prek hooks locally. |
| content/en/project/governance.md | Whitespace cleanup. |
| content/en/project/contributions/adoption.md | Whitespace cleanup. |
| content/en/project/contributions/addons.md | Whitespace cleanup. |
| content/en/project/commitment.md | Whitespace cleanup. |
| content/en/project/branding.md | Whitespace cleanup. |
| content/en/ecosystem/integrations/velero.md | Front-matter delimiter formatting cleanup. |
| content/en/ecosystem/integrations/rancher.md | Front-matter delimiter formatting cleanup. |
| content/en/ecosystem/integrations/openshift.md | Front-matter delimiter formatting cleanup. |
| content/en/ecosystem/integrations/opencost.md | Code block fence alignment cleanup. |
| content/en/ecosystem/integrations/eso.md | Removes trailing blank lines. |
| content/en/ecosystem/integrations/envoy-gateway.md | Removes trailing blank line. |
| content/en/ecosystem/integrations/dashboard.md | Removes trailing blank line. |
| content/en/ecosystem/integrations/argocd.md | Whitespace cleanup in embedded Lua/YAML snippet. |
| content/en/ecosystem/_index.md | Shortcode indentation/whitespace cleanup. |
| content/en/docs/whats-new.md | Updates Flux CD link target and whitespace normalization. |
| content/en/docs/tenants/rules.md | Whitespace cleanup in YAML examples. |
| content/en/docs/tenants/quickstart.md | Whitespace cleanup in examples. |
| content/en/docs/tenants/metadata.md | Whitespace cleanup in YAML example. |
| content/en/docs/tenants/enforcement.md | Whitespace cleanup in YAML example. |
| content/en/docs/tenants/_index.md | Whitespace cleanup. |
| content/en/docs/resource-management/customquotas/_index.md | Whitespace cleanup and code block fence alignment. |
| content/en/docs/resource-management/_index.md | Adds Hugo section front-matter for “Resource Management”. |
| content/en/docs/replications/tenant.md | Removes trailing blank lines. |
| content/en/docs/proxy/setup/installation.md | Removes trailing blank lines. |
| content/en/docs/proxy/gangplank.md | Code block fence alignment. |
| content/en/docs/overview/_index.md | Updates links to new Resource Management paths. |
| content/en/docs/operating/troubleshoting.md | Whitespace cleanup. |
| content/en/docs/operating/setup/rancher.md | Removes trailing blank line. |
| content/en/docs/operating/setup/_index.md | Front-matter delimiter formatting cleanup. |
| content/en/docs/operating/best-practices/networking.md | Whitespace cleanup in YAML example and trailing blank lines. |
| content/en/docs/operating/best-practices/images.md | Whitespace/indentation cleanup. |
| content/en/docs/operating/best-practices/_index.md | Removes trailing blank line. |
| content/en/docs/operating/architecture.md | Updates ResourcePools link to new Resource Management paths. |
| content/en/docs/operating/admission-policies.md | Removes trailing blank lines. |
| content/en/docs/operating/_index.md | Front-matter delimiter formatting cleanup. |
| content/en/docs/guides/namespace-migration-across-tenants.md | Removes trailing blank line. |
| content/en/docs/guides/_index.md | Whitespace cleanup. |
| content/en/docs/_index.md | Adds Hugo section front-matter for “Documentation”. |
| content/en/adopters/_index.md | Shortcode indentation/whitespace cleanup. |
| content/dictionary.txt | Whitespace cleanup. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: sandert-k8s <sandert98@gmail.com>
Signed-off-by: sandert-k8s <sandert98@gmail.com>
Signed-off-by: sandert-k8s <sandert98@gmail.com>
oliverbaehler
approved these changes
Jun 4, 2026
oliverbaehler
pushed a commit
to oliverbaehler/website
that referenced
this pull request
Jun 10, 2026
* feat: add prek as pre-commit Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix broken links Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix linting with prek Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net>
oliverbaehler
added a commit
that referenced
this pull request
Jun 10, 2026
* feat: add migration clarification (#88) * feat: add release additions Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: update api references Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: update openshfit install docs (#87) * feat: update openshfit install docs Signed-off-by: sandert-k8s <sandert98@gmail.com> * fix: add red hat exclude in lychee Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add migration clarification Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: broken links Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: broken links Signed-off-by: Oliver Baehler <oliver@sudo-i.net> --------- Signed-off-by: Oliver Baehler <oliver@sudo-i.net> Signed-off-by: sandert-k8s <sandert98@gmail.com> Co-authored-by: Sander Tervoert <32864332+sandert-k8s@users.noreply.github.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add proxy args Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: clarify matching strategies Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * chore: housekeeping (#91) * chore: add status objects in apireference Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: typo proxysetting Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix spelling Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add prek as precommit (#92) * feat: add prek as pre-commit Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix broken links Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix linting with prek Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: improve rules api Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * chore: fixes in quota docs (#93) * fix: apiVersion in docs Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix lb path Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: improve rules api Signed-off-by: Oliver Baehler <oliver@sudo-i.net> --------- Signed-off-by: Oliver Baehler <oliver@sudo-i.net> Signed-off-by: sandert-k8s <sandert98@gmail.com> Co-authored-by: Sander Tervoert <32864332+sandert-k8s@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
oliverbaehler
added a commit
that referenced
this pull request
Jun 24, 2026
* feat: add migration clarification (#88) * feat: add release additions Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: update api references Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: update openshfit install docs (#87) * feat: update openshfit install docs Signed-off-by: sandert-k8s <sandert98@gmail.com> * fix: add red hat exclude in lychee Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add migration clarification Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: broken links Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: broken links Signed-off-by: Oliver Baehler <oliver@sudo-i.net> --------- Signed-off-by: Oliver Baehler <oliver@sudo-i.net> Signed-off-by: sandert-k8s <sandert98@gmail.com> Co-authored-by: Sander Tervoert <32864332+sandert-k8s@users.noreply.github.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add proxy args Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: clarify matching strategies Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * chore: housekeeping (#91) * chore: add status objects in apireference Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: typo proxysetting Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix spelling Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: add prek as precommit (#92) * feat: add prek as pre-commit Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix broken links Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix linting with prek Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: improve rules api Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * chore: fixes in quota docs (#93) * fix: apiVersion in docs Signed-off-by: sandert-k8s <sandert98@gmail.com> * chore: fix lb path Signed-off-by: sandert-k8s <sandert98@gmail.com> --------- Signed-off-by: sandert-k8s <sandert98@gmail.com> Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * fix: improve rules api Signed-off-by: Oliver Baehler <oliver@sudo-i.net> * feat: restructure rules documentation * feat: add rule enforcements --------- Signed-off-by: Oliver Baehler <oliver@sudo-i.net> Signed-off-by: sandert-k8s <sandert98@gmail.com> Co-authored-by: Sander Tervoert <32864332+sandert-k8s@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add prek as precommit.
When pushing, it also checks: