Uh oh!
There was an error while loading. Please reload this page.
docs: move user documentation into docs/ for website hosting - #145
Merged
Conversation
Split the README into a docs/ tree that the SkyWalking website can import, following the layout used by the Python and Go agents (docs/README.md as the overview page, docs/menu.yml as the sidebar, pages under docs/en/). - README.md becomes a short entry point: requirements, install, quick start, and links into docs/. - CONTRIBUTING.md points at the build, plugin development, and release guides. - docs/en/ adds setup (quick start, configuration, start and stop), features (tracing, runtime metrics), plugins (supported libraries, AWS SDK v2), advanced use (serverless, webpack, troubleshooting), and contribution (build and test, plugin development, release) pages. - docs/How-to-release.md stays as a stub, keeping the #vote-check anchor that earlier [VOTE] emails link to. - scripts/release.sh: the [VOTE] email now points at the in-tarball doc paths, since the moved guides ship inside the source package. Configuration values, meter names, plugin behavior, and the build and test commands were verified against src/ and .github/workflows/test.yaml. Two long-standing README errors are corrected: SW_AGENT_INSTANCE defaults to the host name (not a random value) and SW_AGENT_LOGGING_LEVEL defaults to error (not info). The website side needs a follow-up PR in apache/skywalking-website adding repoUrl and a Next entry for the Node.js Agent in data/docs.yml. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
kezhenxu94
approved these changes
Aug 15, 2026
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Aug 15, 2026
wu-sheng added a commit
to apache/skywalking-website
that referenced
this pull request
Aug 16, 2026
skywalking-nodejs moved its user documentation into docs/ with a menu.yml (apache/skywalking-nodejs#145), so the agent can render on the site like every other Hugo-hosted component instead of linking out to a GitHub tree. Adds repoUrl and the Next/Latest/v0.9.0 entries. Next tracks master (0.10.0-dev). Latest and v0.9.0 both pin bf5dc68 on the 0.9.0-docs branch, which is the v0.9.0 tag commit plus the docs move; a follow-up commit there removes what landed after the release, so the snapshot documents the agent users actually run. Sharing one commitId between Latest and v0.9.0 also lets seo/doc-canonical-map.html point the tagged tree at /latest/. The old GitHub-tree entry could not be kept alongside these: repoUrl is item-level, so docs.js runs every entry through doc.sh, and an external link has no docs/menu.yml to copy. The version switcher likewise builds its target by substituting the slug into /docs/<repo>/<version>/, so it cannot reach github.com. Nothing is lost — at v0.9.0 docs/ held only How-to-release.md, and the docs card already links to the repository. Verified with a full npm run docs && hugo: 5421 pages, all three trees rendered, runtime-metrics present only under next.
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
All Node.js Agent documentation lived in a single ~190-line
README.md, so it could not be imported by the SkyWalking website like the Python, Go, and Rust agent docs are. This splits it into adocs/tree the website can render.What changed
docs/README.md— overview page (/readmein the sidebar),docs/menu.yml— website sidebar.docs/en/— 14 pages: setup (quick start, configuration, start and stop), features (tracing, runtime metrics), plugins (supported libraries, AWS SDK v2), advanced use (serverless, webpack, troubleshooting), contribution (build and test, plugin development, release).README.md— now a short entry point: requirements, install, quick start, links intodocs/.CONTRIBUTING.md— points at the build, plugin development, and release guides.docs/How-to-release.md— kept as a stub with the#vote-checkheading, so the footnote in previously sent[VOTE]emails still lands somewhere useful.scripts/release.sh— the[VOTE]email now cites in-tarball doc paths (docs/ships inside the source package), replacing links to aCONTRIBUTING.mdanchor that this PR removes.Layout follows
apache/skywalking-pythonandapache/skywalking-go.Accuracy
Content was checked against the source rather than copied forward:
SW_*variable read anywhere insrc/is documented, and nothing is documented that the agent does not read.SW_AGENT_INSTANCEdefaults to the host name (not a random value,AgentConfig.ts), andSW_AGENT_LOGGING_LEVELdefaults toerror(notinfo,logging/index.ts).SW_AGENT_TRACE_TIMEOUTis documented as the gRPC deadline for trace reports, meter reports, and service management requests, which is where it is actually used.src/and.github/workflows/test.yaml.Follow-up
Rendering on the website needs a companion PR in
apache/skywalking-websiteaddingrepoUrland aNextentry for the Node.js Agent indata/docs.yml— withoutrepoUrlthe doc importer skips the repository.🤖 Generated with Claude Code