Display for conformance profiles results

[xtineskim]

As discussed in the Gateway API meeting, post Kubecon NA 2023, there will be an implementations reorganization by profiles. Since it seems open ended, wanted to open an issue to see what folks would like to be captured. Data displayed will be pulled from the conformance reports, how to display it meaningfully for an end-user trying to decide on which implementation suits their requirements

Some things that come to mind:

• Table that can be filtered by certain features (for ex version 0.8.0, HTTPRouteMethodMatching), category of implementations (L7, L4, Mesh), maybe stats of passing/failings/skipped tests?
• Page headers based on use cases that a user can jump to to see implementations (use cases as in the supported features)
• All implementations listed out, and having filters for selecting use case scenarios (similar to online shopping haha)

Some questions:

• what else from the conformance reports should be pulled and displayed?
• there seemed to be some small discussions on other displays besides badges for implementation projects?

This is open for suggestions, please leave any thoughts/questions/feedback

Related issues: https://github.com/kubernetes-sigs/gateway-api/issues/1709

Related discussion: https://github.com/kubernetes-sigs/gateway-api/discussions/2577

[xtineskim]

seeing as there are no strong opinions from the meetings/on this issue, will work on a poc and present to the group 👍

[shaneutt]

Thank you for taking this one on! Let us know if you run into any trouble, or need any help! :vulcan_salute:

[xtineskim]

thanks @shaneutt! currently been exploring the use of rmarkdown. Not sure if other k8s sites use it, but the ability to plot make more "dynamic" code would be great - do you know if maintainers would be opposed to using a flavour of markdown?( ideally I don't want to overly complicate the build for the site)

[shaneutt]

I for one am not opposed, my co-maintainers @youngnick and @robscott can chime in if they have thoughts :thought_balloon:

[robscott]

Hey @xtineskim, I've never seen k8s use it, but that looks promising to me, worth a shot.

[mikemorris]

currently been exploring the use of rmarkdown

Would this necessitate switching to a different static site generator, or would it be possible to integrate with the existing MkDocs configuration somehow?

MkDocs appears to use the Python Markdown library with some support for extensions that might be helpful (I'm not sure if we may face any restrictions on allowed third party extensions similar to the GitHub Pages Jekyll static site generator) but from a cursory glance I haven't noticed a way to integrate alternative Markdown processing libraries...

[xtineskim]

@mikemorris ah good point, thanks for linking the resource 👍 i'll tal into that :)

[shaneutt]

@xtineskim how are things going with this?

[xtineskim]

@shaneutt been experimenting with different plugins - none have really satisfied the needs of having a requirements. But i'll have a PR open soon (hopefully this week, sorry, been busy!) to have a basic md table (sortable by columns), and we can iterate from there!

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[shaneutt]

I think given #2874 we can consider this one resolved. We can always open new issues for new UI improvements as well.