Skip to content

Add kapa.ai Search Assistant#871

Merged
gardener-prow[bot] merged 4 commits intogardener:masterfrom
n-boshnakov:add-kapa.ai-search
Mar 4, 2026
Merged

Add kapa.ai Search Assistant#871
gardener-prow[bot] merged 4 commits intogardener:masterfrom
n-boshnakov:add-kapa.ai-search

Conversation

@n-boshnakov
Copy link
Contributor

@n-boshnakov n-boshnakov commented Feb 26, 2026

How to categorize this PR?

/kind enhancement

What this PR does / why we need it:
This PR implements a search assistant in the public website powered by kapa.ai.

Currently integrated content:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

How the icon appears:
Screenshot 2026-02-26 141915

Consent form:
Screenshot 2026-02-26 141830

Example search:
image

Summary by CodeRabbit

  • New Features
    • Added an external site widget that can be enabled to provide project-specific branding (name, color, logo), identify the website, display configurable user consent text, and show example questions to guide users.

@n-boshnakov n-boshnakov self-assigned this Feb 26, 2026
@n-boshnakov n-boshnakov requested a review from a team as a code owner February 26, 2026 15:36
@gardener-prow gardener-prow bot added kind/enhancement Enhancement, improvement, extension size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 26, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 52788f09-4bed-4b0e-a888-4d11722e0ff2

📥 Commits

Reviewing files that changed from the base of the PR and between e15750f and 5577398.

📒 Files selected for processing (1)
  • .vitepress/config.mts
🚧 Files skipped from review as they are similar to previous changes (1)
  • .vitepress/config.mts

📝 Walkthrough

Walkthrough

Added an external Kapa.ai widget script tag to the VitePress head configuration (.vitepress/config.mts) with data attributes for website-id, project (name/color/logo), consent texts, and example questions.

Changes

Cohort / File(s) Summary
Kapa.ai Widget Integration
.vitepress/config.mts
Inserted external widget script tag (https://widget.kapa.ai/kapa-widget.bundle.js) into the VitePress head config with data attributes for website-id, project (name/color/logo), consent UI texts, and example questions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A tiny script hopped into head so bright,
It brought a name, a color, and a light,
Consent and questions tucked in the seam,
I nudged the config — a playful dream,
Hooray! The widget woke up in the site. 🥕✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a kapa.ai search assistant widget to the website.
Description check ✅ Passed The description follows the template with categorization (/kind enhancement), clear explanation of what the PR does, integrated content details, and helpful visual context through screenshots.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@federated-github-access federated-github-access bot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Feb 26, 2026
@github-actions github-actions bot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. and removed ok-to-test Indicates a non-member PR verified by an org member that is safe to test. labels Feb 26, 2026
@gardener-prow gardener-prow bot added the cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. label Feb 26, 2026
@federated-github-access federated-github-access bot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Feb 26, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2026

🚀 Preview Deployed

Your preview is being built and will be available at:
https://documentation-demo.gardener.cloud/pr-preview/pr-871/

Note: The preview will only be available after the GitHub Pages deployment completes in the demo repository.

To view the deployment status, visit: https://github.com/gardener/documentation-demo/actions

@github-actions github-actions bot removed the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Feb 26, 2026
Copy link

@Antonkapa Antonkapa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Could consider adding data-modal-example-questions but really up to preference

@gardener-prow
Copy link

gardener-prow bot commented Feb 26, 2026

@Antonkapa: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@n-boshnakov
Copy link
Contributor Author

Looks good! Could consider adding data-modal-example-questions but really up to preference

Thank you for the suggestion. I have added the following sample questions:
image

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for soon-to-be-gardenercloud ready!

Name Link
🔨 Latest commit 5577398
🔍 Latest deploy log https://app.netlify.com/projects/soon-to-be-gardenercloud/deploys/69a7d3312073e40008010227
😎 Deploy Preview https://deploy-preview-871--soon-to-be-gardenercloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 62 (🔴 down 30 from production)
Accessibility: 97 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 90 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 27, 2026

Comment has been resolved by Niklas Klocke

Niklas Klocke left a comment:

screenshot
This is an amazing screenshot 🚀

Browser metadata
Path:      /
Browser:   Chrome 145.0.0.0 on Mac OS 10.15.7
Viewport:  1720 x 993 @2x
Language:  en
Cookies:   Enabled

Open in BrowserStack

Open Deploy Preview · Mark as Unresolved

@marc1404
Copy link
Member

marc1404 commented Mar 2, 2026

/assign

Copy link
Member

@marc1404 marc1404 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for implementing the Kapa.ai widget! ✨
Two suggestions below 👇

Thank you for the suggestions, Marc! I really like the ideas, as well as the new look!

Co-authored-by: Marc Vornetran <marc1404@users.noreply.github.com>
Copy link
Member

@klocke-io klocke-io left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@gardener-prow gardener-prow bot added the lgtm Indicates that a PR is ready to be merged. label Mar 4, 2026
@gardener-prow
Copy link

gardener-prow bot commented Mar 4, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Antonkapa, klocke-io

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gardener-prow
Copy link

gardener-prow bot commented Mar 4, 2026

LGTM label has been added.

DetailsGit tree hash: 51e3511ab0dac7038947d3903e552fd6797e1c4d

@gardener-prow gardener-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2026
@gardener-prow gardener-prow bot merged commit 485f280 into gardener:master Mar 4, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. kind/enhancement Enhancement, improvement, extension lgtm Indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants