You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2025/07/23 07:49:43 UTC
(skywalking-website) branch revert-727-revert-667-kapa-ai-widget-integration created (now c0dc094be6b)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a change to branch revert-727-revert-667-kapa-ai-widget-integration
in repository https://gitbox.apache.org/repos/asf/skywalking-website.git
at c0dc094be6b Revert "Revert "Add Kapa.ai to SkyWalking Website" (#727)"
This branch includes the following new commits:
new c0dc094be6b Revert "Revert "Add Kapa.ai to SkyWalking Website" (#727)"
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(skywalking-website) 01/01: Revert "Revert "Add Kapa.ai to SkyWalking Website" (#727)"
Posted by ke...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch revert-727-revert-667-kapa-ai-widget-integration
in repository https://gitbox.apache.org/repos/asf/skywalking-website.git
commit c0dc094be6b5bb4ed16935947e7c2eaf086292d0
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Wed Jul 23 15:49:35 2025 +0800
Revert "Revert "Add Kapa.ai to SkyWalking Website" (#727)"
This reverts commit f19ddfc5819af7e4ee9cab222215d9de323d181a.
---
README.md | 11 +++++++++--
themes/docsy/layouts/partials/scripts.html | 17 +++++++++++++++++
2 files changed, 26 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 75e5b04311e..ff5b3bfb71c 100755
--- a/README.md
+++ b/README.md
@@ -21,10 +21,17 @@ This site uses [Hugo](https://gohugo.io) to organize and manage content with the
Located at `content/_index.html`。
-### Projects and Document
+### Projects and Documentation
-The data of documentation link is located in `data/docs.yml` and formatted as `YAML`.
+The data of documentation link is located in `data/docs.yml` and formated as `YAML`.
+#### Search Engine
+Update the [config file](https://github.com/algolia/docsearch-configs/blob/master/configs/skywalking.json) everytime, so that a new documentation version will be available searched by [algolia](https://www.algolia.com/).
+
+#### AI Docs Q&A
+Release managers of SkyWalking projects should use the Kapa.ai [dashboard](https://app.kapa.ai/) to sync and ingest new documentation/blogs/FAQs if needed, or set up automatic refresh (crawling) of the Q&A sources.
+
+If you need access to the dashboard, contact @superskyyy for an invitation.
### Event
diff --git a/themes/docsy/layouts/partials/scripts.html b/themes/docsy/layouts/partials/scripts.html
index e74c8885b45..7464cec921a 100644
--- a/themes/docsy/layouts/partials/scripts.html
+++ b/themes/docsy/layouts/partials/scripts.html
@@ -37,4 +37,21 @@
});
</script>
+<!--Note the 200px position-botton is to leave room for website event popups -->
+<script defer
+src="https://widget.kapa.ai/kapa-widget.bundle.js"
+data-website-id="8a08392b-9c4d-4816-8bc4-f93e0ecdd2a7"
+data-project-name="SkyWalking"
+data-project-color="#2B74B8"
+data-button-text="Ask AI"
+data-search-mode-enabled="true"
+data-modal-open-on-command-k="true"
+data-modal-disclaimer="The AI supports multiple languages, but it may not be accessible in China, a proxy is required."
+data-project-logo="https://miro.medium.com/v2/resize:fit:2400/0*kmS-5BQ8ShAhZ_F4.jpg"
+data-modal-example-questions="What is Apache SkyWalking?,How to deploy SkyWalking?,How to inject agents non-intrusively?,How to setup trace sampling?"
+data-button-position-top=""
+data-button-position-right="20px"
+data-button-position-bottom="200px"
+data-button-position-left=""
+></script>
{{ partial "hooks/body-end.html" . }}