docs: post-v0.7.7 clarity review#188
Merged
Merged
Conversation
The concept was already named housekeeper (pkg/webhook/housekeeper.go,
WireWebhookHousekeeperInfra, all prose) but the Go API surface and docs
still used WebhookController. This finishes the rename everywhere:
Code:
- IsWebhookControllerEnabled() → IsHousekeeperEnabled()
- WebhookControllerSyncInterval() → HousekeeperSyncInterval()
- WebhookControllerStats() → HousekeeperStats() (method + type)
- konfig: Webhooks.Controller → Webhooks.Housekeeper
- env vars: ENABLE_WEBHOOK_CONTROLLER → ENABLE_HOUSEKEEPER
WEBHOOK_CONTROLLER_SYNC_INTERVAL → HOUSEKEEPER_SYNC_INTERVAL
- JSON health fields: webhookController/webhookControllerStats → housekeeper/housekeeperStats
Docs: all remaining "webhook controller" prose → "housekeeper"
Spinner had its own package but only used utils.SuccessMark/FailureMark — moving it into utils removes the dependency, collapses the package, and eliminates the cmd/cli re-export indirection. - pkg/utils/spinner.go: spinner code lives here now (StartSpinner, Spinner type) - pkg/spinner/: deleted - cmd/cli/spinner.go: updated to return *utils.Spinner - pkg/e2e/runner.go, pkg/ork/deps.go, helper.go, kind.go: import updated domain/README.md: package-level docs — what each file defines, why the package exists as a separate import, and how the hook type system (ReconcileHooks[T] → ObjectHooks) is structured.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarity pass following the v0.7.7 release — naming consistency, documentation cleanup, and package consolidation.
webhookController→housekeeperthroughout — Go API (IsHousekeeperEnabled,HousekeeperStats,HousekeeperSyncInterval), config struct (Webhooks.Housekeeper), env vars (ENABLE_HOUSEKEEPER,HOUSEKEEPER_SYNC_INTERVAL), JSON health fields, and all docs. The file was alreadyhousekeeper.go; now the API surface matches.pkg/spinnerdissolved intopkg/utils— removes the one-way dependency on utils for two symbols (SuccessMark,FailureMark) and eliminates thecmd/clire-export wrapper.StartSpinnerandSpinnernow live inpkg/utils.domain/README.mdadded — coversObject,Komponent,Health, and theReconcileHooks[T]→ObjectHookshook type system.