Skip to content

[draft/test]: docs: restructure topology-aware documentation.#628

Draft
klihub wants to merge 13 commits intocontainers:mainfrom
klihub:docs/topology-aware/restructure
Draft

[draft/test]: docs: restructure topology-aware documentation.#628
klihub wants to merge 13 commits intocontainers:mainfrom
klihub:docs/topology-aware/restructure

Conversation

@klihub
Copy link
Collaborator

@klihub klihub commented Feb 6, 2026

This PR is an attempt to restructure the topology-aware documentation. I threw copilot at it asking to reorganize the content taking the ToC from the corresponding balloons PR#627.

askervin and others added 10 commits January 30, 2026 15:20
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Signed-off-by: Antti Kervinen <antti.kervinen@intel.com>
Add support for declaring known scheduling classes for the topology-
aware policy. A scheduling class is a combination of Linux schduler
policy and I/O priority parameters. It is represented using the same
policy-agnostic data structure as used by the balloons policy.

Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
Implement support for annotated assignment of containers to scheduling
classes.

Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
@klihub klihub requested a review from askervin February 6, 2026 07:57
@klihub klihub force-pushed the docs/topology-aware/restructure branch from 10d450e to 8ab9c38 Compare February 6, 2026 07:58
Reorganize topology-aware.md to follow the same structure as balloons.md:
- Section 1: Overview with problem statement and key features
- Section 2: Installation and Configuration
- Section 3: Configuration Options (8 subsections)
- Section 4: Cookbook with practical examples
- Section 5: Troubleshooting

Co-authored-by: GitHub Copilot <noreply@github.com>
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
@klihub klihub force-pushed the docs/topology-aware/restructure branch from 8ab9c38 to 2bfee80 Compare February 6, 2026 08:03
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
@klihub klihub force-pushed the docs/topology-aware/restructure branch from 7c46892 to 47e5721 Compare February 6, 2026 08:39
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.

2 participants