Skip to content

Updateworkloadrule docs#43

Merged
Rupam-It merged 6 commits into
mainfrom
updateworkloadruleDocs
May 19, 2026
Merged

Updateworkloadrule docs#43
Rupam-It merged 6 commits into
mainfrom
updateworkloadruleDocs

Conversation

@Rupam-It
Copy link
Copy Markdown
Collaborator

@Rupam-It Rupam-It commented May 19, 2026

update the docs for worklaod rule sync with the marketing docs !


Summary by Gitar

  • Workload rule documentation:
    • Documented namespacePattern for targeting namespaces by name pattern.
    • Updated HPARuleConfigArgs fields and HPAMetricTriggerArgs usage guidance.
    • Simplified EmergencyResponseConfig by removing oomMaxReactions and oomCooldownSeconds.
    • Added comprehensive code comments to WorkloadRule examples for Go, Node.js, and Python.
    • Clarified targetValue units for network throughput metrics in HPAMetricTriggerArgs documentation and examples.

This will update automatically on new commits.

Comment thread README.md Outdated
@gitar-bot
Copy link
Copy Markdown

gitar-bot Bot commented May 19, 2026

Code Review ✅ Approved 1 resolved / 1 findings

Updates workload rule documentation to match marketing standards and includes revised HPA configuration guidance. The misleading network throughput unit comment has been corrected.

✅ 1 resolved
Quality: Misleading comment: targetValue "50000000" described as "50 req/s"

📄 README.md:1189 📄 README.md:1244 📄 README.md:1287 📄 sdk/go/devzero/README.md:1189 📄 sdk/go/devzero/README.md:1244 📄 sdk/go/devzero/README.md:1287
In the HPA metric trigger examples, targetValue is set to "50000000" but the inline comment says // absolute target value (e.g. 50 req/s). The value 50,000,000 does not equal 50 req/s — this will confuse users trying to understand the example. Either fix the comment to reflect what the value actually represents (e.g. 50M milli-units, or whatever the correct interpretation is) or change the value to match the comment.

Was this helpful? React with 👍 / 👎 | Gitar

@Rupam-It Rupam-It merged commit e3d523c into main May 19, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant