QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-25 02:55:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix broken links, missing sidebar entries, and restore lost content

Browse Source 
- Replace all /developer_portal/ links with /developer-docs/ in index.md
- Fix non-existent extension-project-structure references
- Fix sidebar links using old /docs/ paths (/user-docs/ instead)
- Add missing extension-points/editors and pkg-resources-migration to sidebar
- Restore Kubernetes debugging section lost during howtos migration
- Restore pkg-resources-migration.md deleted during bifurcation
- Fix versioned docs quickstart.mdx missing version prefix
- Update stale developer_portal references in README, DOCS_CLAUDE, intro.md
- Fix broken creating-viz-plugins link in intro.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Evan Rusackas
2026-02-23 11:21:21 -08:00
parent 8c28c6b474
commit 8ddb06bb2f
13 changed files with 405 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/developer_docs/contributing/howtos.md
View File

@@ -256,6 +256,30 @@ For debugging the Flask backend:
2. Set breakpoints and press F5 to debug
### Debugging Server App in Kubernetes Environment
To debug Flask running in a POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the `SYS_PTRACE` capability. These settings should not be used in production environments.
```yaml
securityContext:
capabilities:
add: ["SYS_PTRACE"]
```
See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details.
Once the pod is running as root and has the `SYS_PTRACE` capability it will be able to debug the Flask app.
You can follow the same instructions as in `docker compose`. Enter the pod and install the required library and packages: gdb, netstat and debugpy.
Often in a Kubernetes environment nodes are not addressable from outside the cluster. VSCode will thus be unable to remotely connect to port 5678 on a Kubernetes node. In order to do this you need to create a tunnel that port forwards 5678 to your local machine.
```bash
kubectl port-forward pod/superset-<some random id> 5678:5678
```
You can now launch your VSCode debugger with the same config as above. VSCode will connect to 127.0.0.1:5678 which is forwarded by kubectl to your remote kubernetes POD.
### Storybook
See the dedicated [Storybook documentation](../testing/storybook) for information on running Storybook locally and adding new stories.