Skip to content

Docs: add AI Sessionizer, and fold Grafana Plugins into SkyWalking Servers - #915

Merged
wu-sheng merged 1 commit into
masterfrom
docs/ai-sessionizer-and-grafana-merge
Sep 3, 2026
Merged

Docs: add AI Sessionizer, and fold Grafana Plugins into SkyWalking Servers#915
wu-sheng merged 1 commit into
masterfrom
docs/ai-sessionizer-and-grafana-merge

Conversation

@wu-sheng

@wu-sheng wu-sheng commented Sep 3, 2026

Copy link
Copy Markdown
Member

AI Sessionizer

apache/skywalking-ai-sessionizer already carries docs/ with a menu.yml, so its documentation is hosted on the site rather than linked out to GitHub. Seven pages render: Welcome, four under Concepts and Designs, two under Adapters.

A Next entry only — no Latest, no version. The repo has no tags and no releases, and pinning a versioned entry to a main commit would publish docs for a version that does not exist. Nothing was added to releases.yml; there is nothing to download yet.

This is the site's first Next-only component, so the card's primary-link path ("the Latest entry if present, else the first one") was verified rather than assumed: Read docs resolves to /docs/skywalking-ai-sessionizer/next/readme/, and no versions dropdown renders.

Grafana Plugins folded in

Grafana Plugins is no longer a top-level section — the page goes from 11 sections to 10. Its single project moves into SkyWalking Servers, beside the sessionizer:

SkyWalking → (Experimental) GraalVM Distro → Horizon UI → Grafana Plugin for Service Topology → AI Sessionizer

Two consequences of dropping the section header, both worth a look:

  • The card is renamed Plugin for Service TopologyGrafana Plugin for Service Topology. Without the header, the old name no longer said what it plugs into. This changes its anchor from #PluginforServiceTopology to #GrafanaPluginforServiceTopology, so any existing deep link to it breaks.
  • The section's standalone note card is folded into the entry. The old section led with a text-only tile — "Metrics visualization on Grafana is supported through PromQL…". With no section left to preface it would have rendered as a stray tile among project cards, so its substance moved into that entry's own description, trimmed to fit the card's three-line clamp (the untrimmed version truncated mid-sentence). The note cards on Archived / Ecosystem / Ecosystem Retired are untouched.

The merged section now mixes a GitHub-linked entry with website-hosted ones. That is safe and already precedented in five other sections — docs.js guards on repoUrl per item (line 153), not per section.

Verification

npm run docs — the same generation CI runs, clones and all — then a full hugo build:

  • Generation exit 0, no errors; sessionizer sidebar generated.
  • All seven sessionizer pages build; its doc page renders with sidebar and a next-only version switcher.
  • Grafana card keeps its GitHub Read-docs link and its v0.1.0 dropdown.
  • Ten sections on the landing page, Grafana Plugins gone, three note cards remaining (the correct ones).
  • Generated artifacts excluded — layouts/projectdoc/baseof.html and static/images/*.png reverted after the local build, since build-with-docs regenerates them.

🤖 Generated with Claude Code

…rvers

apache/skywalking-ai-sessionizer already carries docs/ with a menu.yml, so
its documentation is hosted on the site rather than linked out to GitHub.
A Next entry only: the repo has no tags and no releases, and pinning a
versioned entry to a main commit would publish docs for a version that
does not exist.

Grafana Plugins is no longer a top-level section. Its one project moves
into SkyWalking Servers, next to the sessionizer. Two consequences of
dropping the section header:

  - The card is renamed "Plugin for Service Topology" -> "Grafana Plugin
    for Service Topology", since without the header the old name no longer
    said what it plugs into. This changes its anchor from
    #PluginforServiceTopology to #GrafanaPluginforServiceTopology.
  - The section's standalone note card ("Metrics visualization on Grafana
    is supported through PromQL...") had no section left to preface and
    would have rendered as a stray text tile among project cards, so its
    substance moves into the entry's own description, trimmed to fit the
    card's three-line clamp.

The merged section mixes a GitHub-linked entry with website-hosted ones.
That is safe and already precedented in five other sections: docs.js
guards on repoUrl per item, not per section.

Verified with npm run docs — the generation CI runs — plus a full hugo
build. All seven sessionizer pages render, its card resolves Read docs to
the hosted page with no versions dropdown, the Grafana card keeps its
GitHub links and v0.1.0 dropdown, and the page is down to ten sections
with no orphan note card.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

Deploy Preview for skywalking-website-preview failed.

Name Link
🔨 Latest commit 22aae72
🔍 Latest deploy log https://app.netlify.com/projects/skywalking-website-preview/deploys/6a990da15395a00008ccbf42

@wu-sheng
wu-sheng merged commit dfaa693 into master Sep 3, 2026
1 of 5 checks passed
@wu-sheng
wu-sheng deleted the docs/ai-sessionizer-and-grafana-merge branch September 3, 2026 06:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant