Skip to content

Commit 9be685c

Browse files
authored
docs: add troubleshooting guide to support (#6978)
1 parent 95a1721 commit 9be685c

1 file changed

Lines changed: 93 additions & 24 deletions

File tree

docs/docs/support/index.mdx

Lines changed: 93 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,101 @@ sidebar_position: 130
44
sidebar_label: Help and Support
55
---
66

7-
We are here to help! You can contact us for support through any of these channels:
7+
The more context you provide upfront, the faster we can help. This page will help you solve common issues yourself and,
8+
if you still need support, give us what we need to diagnose your problem quickly.
89

9-
* Authenticated users can access support at [app.flagsmith.com](https://app.flagsmith.com) using the chat widget.
10-
* Email via [support@flagsmith.com](mailto:support@flagsmith.com).
11-
* Discord via [this invite link](https://discord.gg/hFhxNtXzgm).
10+
## Before You Contact Us
1211

13-
## Enterprise support
12+
Flagsmith is fully open source. You can read the code, trace the logic, and find the answer yourself. AI coding
13+
assistants can help you navigate the codebase quickly - point them at the
14+
[Flagsmith repo](https://github.com/Flagsmith/flagsmith) or the relevant SDK repo and ask your question.
15+
16+
Beyond that, many issues have already been solved. A quick search can save you time:
17+
18+
- **[FAQ](/support/faq)** - Browse answers to common questions by category
19+
- **[GitHub Issues](https://github.com/Flagsmith/flagsmith/issues)** - Search open and closed issues for your problem
20+
- **[Release Notes](https://github.com/Flagsmith/flagsmith/releases)** - Check if your issue was fixed in a newer version
21+
- **SDK Repositories** - Check issues in your specific SDK repo:
22+
- [Python](https://github.com/Flagsmith/flagsmith-python-client)
23+
- [JavaScript/Node.js](https://github.com/Flagsmith/flagsmith-nodejs-client)
24+
- [React/Next.js](https://github.com/Flagsmith/flagsmith-js-client)
25+
- [Java](https://github.com/Flagsmith/flagsmith-java-client)
26+
- [.NET](https://github.com/Flagsmith/flagsmith-dotnet-client)
27+
- [Go](https://github.com/Flagsmith/flagsmith-go-client)
28+
- [Ruby](https://github.com/Flagsmith/flagsmith-ruby-client)
29+
- [iOS/Swift](https://github.com/Flagsmith/flagsmith-ios-client)
30+
- [Android/Kotlin](https://github.com/Flagsmith/flagsmith-kotlin-android-client)
31+
- [Flutter](https://github.com/Flagsmith/flagsmith-flutter-client)
32+
- [Rust](https://github.com/Flagsmith/flagsmith-rust-client)
33+
- [Elixir](https://github.com/Flagsmith/flagsmith-elixir-client)
34+
35+
## What We Need From You
36+
37+
When you do reach out, including the right information from the start makes a big difference. Here's what helps us
38+
depending on your issue type.
39+
40+
### SDK or API Issues
41+
42+
- Which SDK and exact version number
43+
- Are you using a server-side or client-side environment key?
44+
- Your initialisation code and flag evaluation code (sanitised)
45+
- What you expected to happen vs what actually happened
46+
- Exact error messages, stack traces, or console output
47+
48+
### Self-Hosted Infrastructure
49+
50+
- Flagsmith version (Docker image tag, e.g. `v2.221.1`)
51+
- Deployment method and version (Helm chart version, Docker Compose, etc.)
52+
- Relevant Helm values or Docker configuration (sanitised - remove secrets)
53+
- Database type and version (PostgreSQL version, managed vs self-hosted)
54+
- Container logs from the relevant service (API, task processor, SSE). For Docker: `docker logs <container_name>`. For
55+
Kubernetes: `kubectl logs <pod_name> -c <container_name>`. Include the full output, not just the error line - context
56+
around the error often matters.
57+
- For real-time/SSE issues: Redis configuration details
58+
- For upgrade issues: which version you upgraded from and to
59+
60+
### Dashboard or UI Issues
61+
62+
- Screenshot or short screen recording showing the problem
63+
- Steps to reproduce - what you clicked, in what order
64+
- Which project, environment, and flag name are affected
65+
- Browser and version
66+
- Any errors in the browser console (open with F12 -> Console tab)
67+
- For API/network issues: a
68+
[HAR file](https://support.zendesk.com/hc/en-us/articles/4408828867098-Workflow-Generating-a-HAR-file-for-troubleshooting)
69+
captures the exact request/response cycle and is extremely helpful. Note: HAR files can contain sensitive data like
70+
auth tokens - sanitise before sharing.
71+
72+
### SaaS Account or Billing Issues
73+
74+
- Your organisation name in Flagsmith
75+
- Which project and environment is affected
76+
- For billing issues: your subscription plan and the change you're requesting
77+
78+
## Getting in Touch
79+
80+
- **In-app chat** - Click the support widget in the Flagsmith dashboard
81+
- **Email** - [support@flagsmith.com](mailto:support@flagsmith.com)
82+
- **Community** - [Discord](https://discord.gg/hFhxNtXzgm)
83+
84+
### Enterprise Support
1485

1586
[Flagsmith Enterprise](https://www.flagsmith.com/pricing) customers can also use these support channels:
1687

17-
* Dedicated Customer Success manager for personalised assistance and training.
18-
* Shared Slack channel for real-time group support between your organisation and the Flagsmith team (available as an add-on).
19-
20-
## Bug reports and pull requests
21-
22-
Flagsmith is open source, and we encourage contributions from the community. If you want to submit a specific bug
23-
report or code change, you can open an issue or pull request directly in the relevant GitHub repository:
24-
25-
* [Flagsmith API, dashboard and documentation](https://github.com/Flagsmith/flagsmith)
26-
* Client-side SDKs:
27-
- [JavaScript, React](https://github.com/Flagsmith/flagsmith-js-client)
28-
- [iOS](https://github.com/Flagsmith/flagsmith-ios-client)
29-
- [Android](https://github.com/Flagsmith/flagsmith-kotlin-android-client)
30-
- [Flutter](https://github.com/flagsmith/flagsmith-flutter-client)
31-
* [Server-side SDKs](/integrating-with-flagsmith/sdks/server-side)
32-
* [Edge Proxy](https://github.com/Flagsmith/edge-proxy)
33-
* [Terraform provider](https://github.com/Flagsmith/terraform-provider-flagsmith)
34-
* [Flagsmith CLI](https://github.com/Flagsmith/flagsmith-cli)
35-
* [Kubernetes Helm charts](https://github.com/Flagsmith/flagsmith-charts)
88+
- Dedicated Customer Success manager for personalised assistance and training.
89+
- Shared Slack channel for real-time group support between your organisation and the Flagsmith team (available as an
90+
add-on).
91+
92+
## Bug Reports and Pull Requests
93+
94+
Flagsmith is open source, and we encourage contributions from the community. If you want to submit a specific bug report
95+
or code change, you can open an issue or pull request directly in the
96+
[main repository](https://github.com/Flagsmith/flagsmith) or the relevant
97+
[SDK repository listed above](#before-you-contact-us).
98+
99+
Other repositories:
100+
101+
- [Edge Proxy](https://github.com/Flagsmith/edge-proxy)
102+
- [Terraform provider](https://github.com/Flagsmith/terraform-provider-flagsmith)
103+
- [Flagsmith CLI](https://github.com/Flagsmith/flagsmith-cli)
104+
- [Kubernetes Helm charts](https://github.com/Flagsmith/flagsmith-charts)

0 commit comments

Comments
 (0)