Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sections on using @cost and @listSize to demand control docs #5839

Merged
merged 6 commits into from
Aug 21, 2024

Conversation

tninesling
Copy link
Contributor

Updates the demand control documentation to include details on @cost and @listSize for more accurate cost estimation.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@tninesling tninesling requested a review from a team as a code owner August 16, 2024 19:54

This comment has been minimized.

Copy link
Contributor

@shorgi shorgi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@chandrikas chandrikas assigned chandrikas and unassigned chandrikas Aug 19, 2024
@chandrikas chandrikas self-requested a review August 19, 2024 16:20
@chandrikas
Copy link
Contributor

We need to remove/change all references to this feature being in preview (The blurb at the top of the demand control page, the config parameter etc)

@chandrikas
Copy link
Contributor

chandrikas commented Aug 21, 2024

While reading these docs again in their entirety, I find them really long and hard to navigate. Can we turn these sections into links that the reader can directly navigate to?

Follow this workflow to configure and tune demand control for your router:

Measure the cost of your existing operations.
Improve the cost estimation model.
Adjust your preview_demand_control configuration and enforce cost limits.

I appreciate that I can navigate from the sidebar but links in this menu would be nice too.

@tninesling
Copy link
Contributor Author

We need to remove/change all references to this feature being in preview (The blurb at the top of the demand control page, the config parameter etc)

Agree! I'll do that in a separate PR

@tninesling tninesling merged commit 092170a into dev Aug 21, 2024
13 checks passed
@tninesling tninesling deleted the tninesling/cost-docs-update branch August 21, 2024 14:29
@abernix abernix mentioned this pull request Aug 28, 2024
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.

5 participants