Skip to content

Improve discoverability of issue reproduction/reporting workflow docs #976

@kwannoel

Description

@kwannoel

Context

A Slack thread indicates team members are coordinating support/reproduction flow via channel topic updates: https://slack.com/archives/C0AE8A81LE6/p1770829417634169

Problem

The thread shows operational coordination, but there is no obvious, easy-to-find documentation entry point for how users/contributors should report reproducible issues and where to find the expected workflow. Even if related guidance exists, it is not discoverable enough from top-level docs/navigation, which can lead to ad hoc Slack-only handling.

Suggested Fix

  • Add a clearly titled docs page (or README section) for issue reporting and reproduction workflow (for example: "Report and Reproduce Issues").
  • Add navigation and cross-links from high-traffic entry points (such as README.md, troubleshooting pages, and relevant Cloud FAQ sections).
  • Include search-friendly keywords in headings/content: "reproduce", "bug report", "issue triage", "support workflow", "Slack escalation".
  • Add a short "Where to start" checklist with expected inputs (environment, SQL, connector config, logs, error text) to reduce back-and-forth.
  • Ensure the page is linked from at least one troubleshooting document so users can find it while debugging.
Existing Documentation

Related docs PRs:

Codebase References

Related PRs in risingwave:

Source files:

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions