Skip to content

Controller matching wizard - #4584

Merged
k8s-ci-robot merged 42 commits into
kubernetes-sigs:mainfrom
bexxmodd:site/wizard
Mar 5, 2026
Merged

Controller matching wizard#4584
k8s-ci-robot merged 42 commits into
kubernetes-sigs:mainfrom
bexxmodd:site/wizard

Conversation

@bexxmodd

@bexxmodd bexxmodd commented Feb 23, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?
/kind documentation

What this PR does / why we need it:
It's a controller matching wizard for the providers that submitted conformance reports. This should simplify operator/controller selection compared to peeking at the table's features.

You can run this by and test it locally at (http://localhost:8080/index.html):

make serve

Probably many things will require adjustment before this can be hosted, but it's good enough to try it locally for the initial feedback.

Which issue(s) this PR fixes:
Fixes #

Does this PR introduce a user-facing change?:

The new wizard should be available at https://gateway-api.sigs.k8s.io/wizard

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. labels Feb 23, 2026
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 23, 2026
@xtineskim

xtineskim commented Feb 25, 2026

Copy link
Copy Markdown
Contributor

🔥 🌟
this is great! I'm glad that the data from the table is being put to good use :)
I think the wording of Good to Have and Want to have could be a bit confusing, maybe something firmer, like Must have and Preferred?

nits/nice to have (non blocker)

  • a way to select the version
  • gateway api logo on the page somewhere? (lol) or a way to show the main menu? I know this may be tricky the way that this page is spun up/use of wasm 🤔

# Feature definitions for the wizard: id and label match v1.4 conformance table columns
# https://gateway-api.sigs.k8s.io/implementations/v1.4/
FEATURE_DEFINITIONS = {
"httpGateway": [

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

more of a todo: will be worth getting the ids and labels generated rather than hard coded

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Idk exactly how to do it. Feature names are not as descriptive in reports, so hard coded for later parsing.

Feel free to propose something

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

might be able to just get the label from the id, adding a space between the words. But this is not a blocker, so can be done in a later pr 👍

Comment thread hack/mkdocs-generate-controller-wizard-data.py

@robscott robscott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @bexxmodd!

Comment thread site-src/wizard/controller-wizard.html
Comment thread site-src/wizard/controller-wizard.html Outdated
@bexxmodd

Copy link
Copy Markdown
Contributor Author

🔥 🌟 this is great! I'm glad that the data from the table is being put to good use :) I think the wording of Good to Have and Want to have could be a bit confusing, maybe something firmer, like Must have and Preferred?

nits/nice to have (non blocker)

  • a way to select the version
  • gateway api logo on the page somewhere? (lol) or a way to show the main menu? I know this may be tricky the way that this page is spun up/use of wasm 🤔
  • At the top wizard should have a drop-down menu for the latest three versions.
  • made it part of the docs, so it reuses the header and table list of the general page.

Comment thread wasm/main.go Outdated
Comment thread wasm/main.go

@robscott robscott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @bexxmodd, deploy preview looks great! Will defer to someone else for final LGTM.

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bexxmodd, robscott

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2026
@bexxmodd
bexxmodd requested a review from xtineskim March 4, 2026 19:55
@youngnick

Copy link
Copy Markdown
Contributor

Yeah, I think this looks great.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 5, 2026
@k8s-ci-robot
k8s-ci-robot merged commit f2ac7de into kubernetes-sigs:main Mar 5, 2026
20 checks passed
@bexxmodd
bexxmodd deleted the site/wizard branch March 5, 2026 21:38
danehans pushed a commit to danehans/gateway-api that referenced this pull request Mar 10, 2026
* Add script to verify release artifacts.

* Add \n

* Add data extraction script and html for wizard.

* Remove extra file.

* Added wizard content.

* Added hook to wizard data generation.

* Removed redundant data json.

* Convert wizard into an wasm app.

* Remove data json file.

* Exclude wasm from linter.

* Limit versions to the latest three and rename Want to have -> Must have

* Update site-src/wizard/controller-wizard.html

Co-authored-by: Rob Scott <rob.scott87@gmail.com>

* host wizard on k8s page.

* Changed header and wording and update linter run to exclude wasm folder.

* css adjustments to fit mkdocs.

* typo for border.

* Trying to pass golinter.

* removed misplaced build directive.

* Add boilerplate to go files.

* Make adjustments to the wizard: added descriptions, subheadings, renamed recommend to match.

* Go lint update.

* Improve embedding of wizard into mkdocs.

* css adjustments.

* move feature groups around.

* reset grpcecho.pd.go

* space

* Another space

* Added random tiebreaker.

* Replace math/rand with math/rand/v2

* Updated UI to improve UX.

* changed wording of intro paragraph.

* Prevent nested scroll bar from appearing.

* Nest backendTLS in HTTPRoute.

* update to ui. extended features only appear of the resource is selected.

* updated wording.

* fixed go linter errors.

* replace specific version selection with minimum version selection.

* remove note section.

* extra white line between intro paragraph and selection.

---------

Co-authored-by: Rob Scott <rob.scott87@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants