Skip to content

Introduce GREP template and a refactored TAS GREP#362

Merged
unmarshall merged 10 commits into
ai-dynamo:mainfrom
unmarshall:grep
Jan 24, 2026
Merged

Introduce GREP template and a refactored TAS GREP#362
unmarshall merged 10 commits into
ai-dynamo:mainfrom
unmarshall:grep

Conversation

@unmarshall

@unmarshall unmarshall commented Jan 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

What type of PR is this?

/kind documentation

What this PR does / why we need it:

  1. Introduces a new GREP template which will be used by all GREPs going forward.
  2. Refactored and updated the the now stale TAS design document to follow the GREP template.
  3. Adds support to generate TOC for GREPs.
  4. Adds support to verify if TOCs are up-to-date.

Which issue(s) this PR fixes:

Fixes #309
Fixes #321
Fixes #366

Special notes for your reviewer:

Does this PR introduce a API change?

Additional documentation e.g., enhancement proposals, usage docs, etc.:

Introduces a new GREP template.
Aligns and updates TAS GREP based on GREP template.

@unmarshall unmarshall marked this pull request as draft January 22, 2026 04:43
@unmarshall unmarshall force-pushed the grep branch 2 times, most recently from 589b588 to 4ea52b6 Compare January 22, 2026 17:49
sanjaychatterjee
sanjaychatterjee reviewed Jan 23, 2026
View reviewed changes
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
Comment thread docs/proposals/01-topology-aware-scheduling/README.md Outdated
@unmarshall unmarshall marked this pull request as ready for review January 23, 2026 12:42
@unmarshall

unmarshall commented Jan 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

@sanjaychatterjee, et. al
KEPs numbers reflect the issue number (See https://github.com/kubernetes/enhancements/blob/master/keps/README.md#what-is-the-number-at-the-beginning-of-the-kep-name)
I have instead just used an incremental number for the GREPs. The reason for choosing incremental number was to not have arbitrary large numbers given to GREPs. The only use case to use Issue numbers is to link a GREP with an issue.
The only possible benefit is that we can navigate from the Issue to its corresponding PR and look at all the discussions to get historical context on why took certain decisions.

However this could be easily done by specifying the Issue/PR link inside the GREP as well. KEPs take one route and we need to decide which direction we need to go in.

@sanjaychatterjee

sanjaychatterjee commented Jan 23, 2026

Copy link
Copy Markdown
Collaborator

@sanjaychatterjee, et. al KEPs numbers reflect the issue number (See https://github.com/kubernetes/enhancements/blob/master/keps/README.md#what-is-the-number-at-the-beginning-of-the-kep-name) I have instead just used an incremental number for the GREPs. The reason for choosing incremental number was to not have arbitrary large numbers given to GREPs. The only use case to use Issue numbers is to link a GREP with an issue. The only possible benefit is that we can navigate from the Issue to its corresponding PR and look at all the discussions to get historical context on why took certain decisions.

However this could be easily done by specifying the Issue/PR link inside the GREP as well. KEPs take one route and we need to decide which direction we need to go in.

Sounds good to me. Let's use issue numbers. That also ensure the process that GREPs follow from issues.

unmarshall and others added 10 commits January 23, 2026 23:49
@unmarshall
* Introduced GREP template.
c848d0e 
* WIP Topology aware scheduling GREP

Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
added sections on monitoring and PodGang API
0c9f7bb 
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
* Added support for generating table of contents for GREPs
ceeaf5e 
* Added support to verify if the table of contents are up to date.

Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
added license headers to update-toc and verify-toc scripts
c97377f 
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall @sanjaychatterjee
Update docs/proposals/01-topology-aware-scheduling/README.md
c74983a 
Co-authored-by: Sanjay Chatterjee <sanjay.chatterjee@gmail.com>
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall @sanjaychatterjee
Apply suggestions from code review
7188ee7 
Co-authored-by: Sanjay Chatterjee <sanjay.chatterjee@gmail.com>
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
addressed review comment and added mitigation for operational complexity
ed91d88 
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
* Added verify-toc to check make target
560558d 
* Added Alternatives section to TAS GREP
* Changed update-toc to be a bit more informational

Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
removed designs/topology.md
73d6663 
Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
@unmarshall
Since we are now using issue tracking number as GREP number:
ed9b9ea 
* Renamed NNN to NNNN
* Renamed 01-topology-aware-scheduling to 244-topology-aware-scheduling

Signed-off-by: Madhav Bhargava <madhav.bhargava@sap.com>
sanjaychatterjee
sanjaychatterjee reviewed Jan 23, 2026
View reviewed changes
Comment thread docs/proposals/NNNN-template/README.md
@sanjaychatterjee sanjaychatterjee mentioned this pull request Jan 23, 2026
Closed
@athreesh

athreesh commented Jan 24, 2026

Copy link
Copy Markdown

This GREP template LGTM. Modeling too much like KEP might be overkill rn / doesn't seem most ideal for dev velocity tho

@unmarshall unmarshall merged commit ac9b711 into ai-dynamo:main Jan 24, 2026
6 of 7 checks passed
@itayvallach itayvallach mentioned this pull request Jan 27, 2026
Closed
@athreesh athreesh mentioned this pull request Jan 28, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sanjaychatterjee sanjaychatterjee sanjaychatterjee approved these changes

@athreesh athreesh athreesh approved these changes

@gflarity gflarity Awaiting requested review from gflarity gflarity is a code owner

@shayasoolin shayasoolin Awaiting requested review from shayasoolin shayasoolin is a code owner

@Ronkahn21 Ronkahn21 Awaiting requested review from Ronkahn21 Ronkahn21 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Auto generate TOC for GREPs Refactor TAS design using GREP template. Introduce GREP template

3 participants

@unmarshall @sanjaychatterjee @athreesh