You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "villebro (via GitHub)" <gi...@apache.org> on 2026/05/09 17:31:41 UTC
[PR] docs: restructure documentation by audience [superset-kubernetes-operator]
villebro opened a new pull request, #37:
URL: https://github.com/apache/superset-kubernetes-operator/pull/37
## Summary
Reorganizes the documentation from a flat list of 9 files into a structured hierarchy with clear navigation paths for each persona (end-user, new contributor, experienced maintainer). The docs had grown to a point where user-facing content was mixed with developer workflows, the developer guide was a monolithic 782-line file, and the lifecycle feature was fragmented across three documents.
### Key changes
- New `getting-started.md` — focused quickstart for users deploying from Helm, no dev tooling clutter
- Lifecycle consolidated into a single canonical page (`user-guide/lifecycle.md`) combining config reference, design context, and runtime behavior that was previously scattered across `user-guide.md`, `architecture.md`, and `internals.md`
- Developer guide split into 3 progressive stages — setup, guidelines, and releasing
- Audience-first nav sections — User Guide, Architecture, Reference, Contributing
### Content deduplication
- Lifecycle task strategies, flow diagram, pod state machine — now only in user-guide/lifecycle.md
- Networking/monitoring config + internals — merged into user-guide/networking-and-monitoring.md
- "Install from source" — moved from installation to contributing/development-setup.md
Verified: `mkdocs build --strict` passes with no broken links or warnings.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] docs: restructure documentation by audience [superset-kubernetes-operator]
Posted by "villebro (via GitHub)" <gi...@apache.org>.
villebro merged PR #37:
URL: https://github.com/apache/superset-kubernetes-operator/pull/37
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org