villebro opened a new pull request, #98: URL: https://github.com/apache/superset-kubernetes-operator/pull/98
## Summary The README had grown into both a landing page and a contributor manual — it duplicated the full `make`-commands reference verbatim and led with implementation links that competed with the documentation. This PR refocuses it as a welcoming landing page: a clear value proposition, a curated highlights teaser, and an "Under the hood" section for developers who want the plumbing, with the command reference now living solely in the contributing guide. It also softens the stability banners to reflect the project's actual `v1alpha1` / pre-0.1.0 status instead of warning people off the project, and folds in two small consistency/correctness fixes found along the way. ## Details **README** - Added a value-prop tagline and a curated **Highlights** section that teases capabilities and links to the full feature overview in the docs, rather than duplicating it. - Added an **Under the hood** section for the plumbing-curious — stack and supply-chain facts with links to `go.mod` and the architecture/security docs. Deliberately version-free so there's nothing to drift. - Moved the generated `make`-commands table out of the README; the `render-make-commands.sh` generator now targets only the contributing guide (which already carried an identical copy), and the Makefile target description was updated to match. - Dropped the Operator SDK link from the hero so the documentation link is the clear primary call-to-action, and aligned the quick-start example to the structured `metastore` form the rest of the docs lead with. **Stability banners (README + `docs/index.md`)** - Replaced "under active development… do not use in production" with a single, honest note that the `v1alpha1` API may still change between releases — a heads-up that matches the alpha status without warning users off the project. **Small fixes** - `AGENTS.md` H1 changed from `# CLAUDE.md` (which contradicted the canonical filename — `CLAUDE.md` is a symlink) to `# LLM Context Guide for Apache Superset Kubernetes Operator`. - Capped lifecycle task failure messages at the documented 256-character bound. `truncateFailureMessage` previously returned up to 259 chars (`msg[:256] + "..."`); it now truncates to `256 - len(marker)` via a documented `truncationMarker` const so the stored string never exceeds the budget. Tests updated accordingly. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
