docs: Complete removal of deprecated Allocation API references#557
Closed
github-actions[bot] wants to merge 1 commit intomainfrom
Closed
Conversation
- Update VariantAutoscalingStatus godoc comment to remove mention of 'current allocation' - Add clarifying notes to HPA and KEDA integration docs about log format changes - Mark debug log examples as illustrative from older model-based scaling version Follow-up to PR #554 which removed Allocation types from CRD reference docs.
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
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
This PR completes the documentation cleanup following PR #554, which removed the deprecated
AllocationAPI types from the CRD reference documentation. This PR addresses remaining references found in the Go code and integration documentation.Changes Made
API Type Documentation (
api/v1alpha1/variantautoscaling_types.go)VariantAutoscalingStatusgodoc comment to remove mention of "current allocation"Integration Documentation
docs/integrations/hpa-integration.md): Added clarifying note about debug log examplesdocs/integrations/keda-integration.md): Added clarifying note about debug log examplesThe debug log examples in both integration guides show internal optimizer data structures (like
currentAllocanddesiredAlloc) from an older version that used model-based scaling. These are internal implementation details, not the public API types that were removed in PR #554. Added notes to clarify that current versions use saturation-based scaling with different internal representations.Related Issues
Testing
Documentation Quality
This PR follows the documentation standards outlined in the Update Docs workflow:
Note: This is an automated documentation update created by the Update Docs workflow.