Add OOM canary settings page to the sidebar#6390
Open
fastio wants to merge 1 commit into
Open
Conversation
|
@fastio is attempting to deploy a commit to the ClickHouse Team on Vercel. A member of the Team first needs to authorize it. |
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.
The new OOM canary documentation page is added to ClickHouse/ClickHouse in
ClickHouse/ClickHouse#107465. This adds the matching
sidebar entry so the page is not flagged as a "floating" page by the docs build.
Merge order: the docs build copies the English docs from ClickHouse/ClickHouse
master, whereoom-canary.mddoes not exist yet, so CI here will fail with adangling sidebar reference until that PR is merged into master. Please merge this
after ClickHouse/ClickHouse#107465.
Related: ClickHouse/ClickHouse#107465
Note
Low Risk
Single sidebar entry with no runtime or application logic; CI may fail temporarily until the synced doc file exists upstream.
Overview
Adds
operations/settings/oom-canaryto the Settings section of theserverAdminsidebar insidebars.js, placed after memory overcommit so the new OOM canary doc is linked in navigation instead of being treated as a floating page.This is a navigation-only change; the markdown page is introduced in ClickHouse/ClickHouse and is expected to land via the docs sync. Until that upstream doc exists on
master, the docs build may fail on a dangling sidebar reference—merge after the companion ClickHouse PR.Reviewed by Cursor Bugbot for commit e8d584f. Bugbot is set up for automated code reviews on this repo. Configure here.