Skip to content

[good first issue] docs: Help us build the troubleshooting guide #241

@caoqianyun

Description

@caoqianyun

What this issue is about

Cube Sandbox doesn't have a Troubleshooting page yet. We'd love your help building one — share the issues you've run into so the next person doesn't have to learn the hard way.

What you can contribute

Any real problem you hit while deploying, configuring, or running Cube — along with how you solved it.

Each entry just needs to cover three things:

  • What went wrong (paste the error or describe the symptom)
  • Why it happened (root cause, in one sentence)
  • How you fixed it (the commands or steps that worked)

Where to submit a PR

Create a new standalone markdown file — one file per topic. The site will automatically render it as a sub-page.

  • Chinese: docs/zh/troubleshooting/<your-topic>.md
  • English: docs/guide/troubleshooting/<your-topic>.md

⚠️ Both Chinese and English versions are required in the same PR — a CI check enforces this and PRs missing either language cannot be merged.
If you're more comfortable writing in just one language, feel free to post a draft in this issue and we'll help with the translation.

Suggested PR title prefix: docs(troubleshooting):

Need help?

Drop a comment on this issue, or reach out to us:

  • 🇨🇳 In China: add Cube Girl on WeChat (ID: CubeSandbox)
  • 🌍 Outside China: join our X

🎁 Merged contributions are eligible for: an official Cube Sandbox Contributor Certificate, a permanent spot on our Wall of Contributors, and early access to upcoming product releases.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions