-
Notifications
You must be signed in to change notification settings - Fork 15
Closed
Labels
bugSomething isn't workingSomething isn't workingdocs-agentdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Context
Slack request (2026-02-18):
[2026-02-18T16:59:12.539Z] <@U0AG7B6P9AL>: <@U0AF0DZ7C9Y> /docs Please create a documentation issue for missing CREATE SECRET docs examples. Include marker docs-eval-1771433952182.
Related context search was run via docs pipeline MCP (search_docs_context) against risingwave and risingwave-docs.
Marker: docs-eval-1771433952182
Problem
The SQL docs do not provide sufficient, easy-to-find examples for CREATE SECRET. Users report the examples are missing, which makes it harder to understand expected syntax and real-world usage.
Suggested Fix
- Add a dedicated examples subsection for CREATE SECRET in the SQL reference page where this statement is documented.
- Include at least 2-3 runnable examples that cover common usage patterns (for example: creating a secret value and referencing it in downstream object definitions).
- Add short notes for quoting/escaping and basic validation guidance so users can troubleshoot syntax issues quickly.
- Ensure this page is discoverable from related SQL/object creation docs and navigation links.
- Acceptance criteria: docs build passes; examples are copy-paste-ready and reviewed for syntax correctness against current behavior.
Reactions are currently unavailable
Metadata
Metadata
Labels
bugSomething isn't workingSomething isn't workingdocs-agentdocumentationImprovements or additions to documentationImprovements or additions to documentation