cockroachdb / cockroachdb/cockroach

Allow for expansion/collapsing of grammar elements based on grammar file

Open
#110,992 0 comments 0 reactions 0 assignees View on GitHub
C-enhancement
Dominant language
Go
Stars
32.5k
Forks
4.1k
PR merge metrics
PR metrics pending

Description

There’s a need to distinguish between exposing SQL statements in the main SQL Grammar documentation page and the specific SQL statement pages within our documentation page. Some grammar elements have the `/* SKIP DOC */` flag, which skips the statement entirely from both the individual statements and the main grammar file. Having the ability to display one and not the other will grant greater flexibility to writers and engineers.

Kathryn is doing some work to try to expose some cluster virtualization commands, but the general consensus is those commands should not be made available in the main SQL Grammar docs page.

Jira issue: CRDB-31704

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.